Returns an ordered page of the message's attached block trees. Follow nextCursor to continue.
blocks Array
id String
descriptionSpaceId String
homeSpaceId String
attachedToMessageId String
parentBlockId String
type String ENUM
richContent String
icon String
createdBy String
updatedBy String
vOrder Number
hOrder Number
vOrderV2 String
hOrderV2 String
hideAfter String
unhideAfter String
startAt String
endAt String
isLocked Boolean
allowResponsesStart String
allowResponsesEnd String
responsesAreEditable Boolean
anonymousResponses Boolean
url String
defaultLayout String ENUM
templateType String ENUM
mediaThumbnailTime Number
programmingLanguage String
overrideDisplayNumber Boolean
publicAllowDuplicateAsTemplate Boolean
publicLinkExpiresAt String
publicSharingLevel String ENUM
organizationSharingLevel String ENUM
spaceMemberSharingLevel String ENUM
updatedAt String
createdAt String
deletedAt String
deletedBy String
jwtToken String
pilotToken String
correspondingRoomId String
userIsComplete Boolean Block user data
lastUserViewId String
lastSeenInfo Array
userId String
lastSeenAt String
content String
ancestors Array
type String ENUM
id String
attachments Array
id String
fileId String
fileUrl String
displayName String
createdAt String
videoThumbnailUrl String
videoCaptionsUrl String
videoStoryboardUrl String
videoDuration String
assets Array
id String
referencePrefix String
referenceId String
type String ENUM
transcript Object
text String (max depth)
completedAt String (max depth)
duration Number (max depth)
confidence Number (max depth)
sentences Array (max depth)
chapters Array (max depth)
speakers Array (max depth)
chapterList Object
chapters Array (max depth)
summary Object
shortSummary String (max depth)
longSummary String (max depth)
captions Object
sourceFileId String (max depth)
transcriptAssetId String (max depth)
language String (max depth)
format String (max depth)
webvtt String (max depth)
playlistUrl String (max depth)
createdAt String
playbackFailed Boolean A terminal playback workflow failure; an absent URL alone can still be pending.
playbackPending Boolean
blockData Array
id String
blockId String
type String ENUM
plainTextContent String
propertyValueDetail Object Kept as property_value_detail for wire-compatibility.
eventAttendanceDetail Object
goalCycleDefinitionDetail Object
createdAt String
updatedAt String
deletedAt String
relatedViewId String
parentBlockDataId String
createdById String
updatedById String
vOrder Number
vOrderV2 String Fractional-index ordering key (base-62) for position_in_view rows.
quizQuestion Object
prompt String
responseType String ENUM
options Array
name String (max depth)
isCorrect Boolean (max depth)
numericalAnswer Number Numerical questions only.
numericalMargin Number
correctBoolean Boolean True/false questions only.
answersIncluded Boolean Set by the server on reads, so a stripped question is not mistaken for one with no correct answer set. Ignored on writes.
quizSubmission Object
answers Array
blockDataId String (max depth)
selectedOptions Array (max depth)
textAnswer String (max depth)
numericalAnswer Number (max depth)
booleanAnswer Boolean (max depth)
correct Boolean (max depth)
answered Boolean (max depth)
score Integer Output only: the number of correct answers.
maxScore Integer Output only: the number of questions. A quiz has no per-question weighting, so the score is out of the question count.
gradeAssignment Object
subjectUserId String The learner the grade is about, not the grader who recorded it. They must be able to view the assignment when their first grade is created.
score Number Absent for pending and excused rows, which is why this is not a bare double: a missing score must not read as a zero.
maxValue Number The assignment's maximum, copied onto the row at grading time on purpose: raising an assignment's maximum later must not silently rescale grades already awarded. Supplied by the grader. When unset on create the row uses the max_grade of the assignment's grade_settings row, or 100 when it has none.
status String ENUM
graderId String Output only: who recorded the grade. Taken from the caller on create.
gradedAt String Output only: set when status is graded.
isDefault Boolean Set by a bulk default-grade apply rather than an individual grading action.
skipIfPresent Boolean Write only: when true, an existing grade on this (block, learner) is left untouched and the create fails with AlreadyExists instead. The bulk default-grade apply sets this so it cannot overwrite real marks. Never set on reads.
gradeSettings Object
maxGrade Number The maximum a score is read against. Absent means never configured, which grades treat as 100.
defaultGrade Number The score a default-grade apply hands out. Never above the maximum (or 100 when there is none). Absent means there is no default to apply.
overwriteExistingGrades Boolean The settings dialog's remembered checkbox: whether a default-grade apply should replace existing marks as well as fill blanks. It never acts on its own; each apply states its own overwrite_existing_grades.
defaultGradeApply Object
overwriteExistingGrades Boolean Also replace grades already awarded, not only fill blanks.
overwrittenBlockDataIds Array of String
defaultGrade Number The grade settings the apply is for. Output of a preview; on the confirmed create default_grade is required and both must match the assignment's grade_settings row, an absent max_grade matching none.
maxGrade Number
eligibleCount Integer Output only: learners the apply considers (every learner who is not excused).
filledCount Integer Output only: learners with no grade, or a pending one, who receive the default.
overwrittenCount Integer Output only: awarded marks replaced. Zero unless overwrite_existing_grades.
views Array
id String
blockId String
order Number
type String ENUM
name String
filterBy Object
groupBy Object
sortBy Object
properties Object
access String ENUM
createdAt String
updatedAt String
createdById String
updatedById String
hideEmptyGroups Boolean
deletedAt String
currentUserAccessLevel String ENUM
richTextCrdtVersion Integer
nextCursor String
code Integer The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
message String A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details Array
@type String The type of the serialized message.
Was this guide helpful?