Google Classroom API . courses . announcements

close()

Close httplib2 connections.

create(courseId, body=None, x__xgafv=None)

Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body.
    The object takes the form of:

{ # Announcement created by a teacher for students of the course
  "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
  "courseId": "A String", # Identifier of the course. Read-only.
  "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
  "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
  "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
  "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
    "studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
      "A String",
    ],
  },
  "materials": [ # Additional materials. Announcements must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
      "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
        "driveFile": { # Representation of a Google Drive file. # Drive file details.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "shareMode": "A String", # Mechanism by which students access the Drive item.
      },
      "form": { # Google Forms item. # Google Forms material.
        "formUrl": "A String", # URL of the form.
        "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
        "title": "A String", # Title of the Form. Read-only.
      },
      "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
        "title": "A String", # Title of the target of the URL. Read-only.
        "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      "youtubeVideo": { # YouTube video item. # YouTube video material.
        "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
        "id": "A String", # YouTube API resource ID.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
        "title": "A String", # Title of the YouTube video. Read-only.
      },
    },
  ],
  "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
  "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
  "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Announcement created by a teacher for students of the course
  "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
  "courseId": "A String", # Identifier of the course. Read-only.
  "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
  "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
  "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
  "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
    "studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
      "A String",
    ],
  },
  "materials": [ # Additional materials. Announcements must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
      "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
        "driveFile": { # Representation of a Google Drive file. # Drive file details.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "shareMode": "A String", # Mechanism by which students access the Drive item.
      },
      "form": { # Google Forms item. # Google Forms material.
        "formUrl": "A String", # URL of the form.
        "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
        "title": "A String", # Title of the Form. Read-only.
      },
      "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
        "title": "A String", # Title of the target of the URL. Read-only.
        "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      "youtubeVideo": { # YouTube video item. # YouTube video material.
        "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
        "id": "A String", # YouTube API resource ID.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
        "title": "A String", # Title of the YouTube video. Read-only.
      },
    },
  ],
  "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
  "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
  "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}

delete(courseId, id, x__xgafv=None)

Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(courseId, id, x__xgafv=None)

Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the announcement. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Announcement created by a teacher for students of the course
  "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
  "courseId": "A String", # Identifier of the course. Read-only.
  "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
  "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
  "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
  "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
    "studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
      "A String",
    ],
  },
  "materials": [ # Additional materials. Announcements must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
      "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
        "driveFile": { # Representation of a Google Drive file. # Drive file details.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "shareMode": "A String", # Mechanism by which students access the Drive item.
      },
      "form": { # Google Forms item. # Google Forms material.
        "formUrl": "A String", # URL of the form.
        "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
        "title": "A String", # Title of the Form. Read-only.
      },
      "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
        "title": "A String", # Title of the target of the URL. Read-only.
        "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      "youtubeVideo": { # YouTube video item. # YouTube video material.
        "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
        "id": "A String", # YouTube API resource ID.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
        "title": "A String", # Title of the YouTube video. Read-only.
      },
    },
  ],
  "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
  "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
  "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}

getAddOnContext(courseId, itemId, addOnToken=None, attachmentId=None, postId=None, x__xgafv=None)

Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.

Args:
  courseId: string, Required. Identifier of the course. (required)
  itemId: string, Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required)
  addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.
  attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).
  postId: string, Optional. Deprecated, use `item_id` instead.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Attachment-relevant metadata for Classroom add-ons in the context of a specific post.
  "courseId": "A String", # Immutable. Identifier of the course.
  "itemId": "A String", # Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.
  "postId": "A String", # Immutable. Deprecated, use `item_id` instead.
  "studentContext": { # Role-specific context if the requesting user is a student. # Add-on context corresponding to the requesting user's role as a student. Its presence implies that the requesting user is a student in the course.
    "submissionId": "A String", # Requesting user's submission id to be used for grade passback and to identify the student when showing student work to the teacher. This is set exactly when `supportsStudentWork` is `true`.
  },
  "supportsStudentWork": True or False, # Optional. Whether the post allows the teacher to see student work and passback grades.
  "teacherContext": { # Role-specific context if the requesting user is a teacher. # Add-on context corresponding to the requesting user's role as a teacher. Its presence implies that the requesting user is a teacher in the course.
  },
}

list(courseId, announcementStates=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  announcementStates: string, Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. (repeated)
    Allowed values
      ANNOUNCEMENT_STATE_UNSPECIFIED - No state specified. This is never returned.
      PUBLISHED - Status for announcement that has been published. This is the default state.
      DRAFT - Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.
      DELETED - Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time.
  orderBy: string, Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response when listing course work.
  "announcements": [ # Announcement items that match the request.
    { # Announcement created by a teacher for students of the course
      "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
      "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
      "courseId": "A String", # Identifier of the course. Read-only.
      "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
      "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
      "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
      "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
        "studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
          "A String",
        ],
      },
      "materials": [ # Additional materials. Announcements must have no more than 20 material items.
        { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
          "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
            "driveFile": { # Representation of a Google Drive file. # Drive file details.
              "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
              "id": "A String", # Drive API resource ID.
              "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
              "title": "A String", # Title of the Drive item. Read-only.
            },
            "shareMode": "A String", # Mechanism by which students access the Drive item.
          },
          "form": { # Google Forms item. # Google Forms material.
            "formUrl": "A String", # URL of the form.
            "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
            "title": "A String", # Title of the Form. Read-only.
          },
          "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
            "title": "A String", # Title of the target of the URL. Read-only.
            "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
          },
          "youtubeVideo": { # YouTube video item. # YouTube video material.
            "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
            "id": "A String", # YouTube API resource ID.
            "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
            "title": "A String", # Title of the YouTube video. Read-only.
          },
        },
      ],
      "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
      "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
      "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
      "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
    },
  ],
  "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

modifyAssignees(courseId, id, body=None, x__xgafv=None)

Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the announcement. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request to modify assignee mode and options of an announcement.
  "assigneeMode": "A String", # Mode of the announcement describing whether it is accessible by all students or specified individual students.
  "modifyIndividualStudentsOptions": { # Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. # Set which students can view or cannot view the announcement. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.
    "addStudentIds": [ # IDs of students to be added as having access to this coursework/announcement.
      "A String",
    ],
    "removeStudentIds": [ # IDs of students to be removed from having access to this coursework/announcement.
      "A String",
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Announcement created by a teacher for students of the course
  "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
  "courseId": "A String", # Identifier of the course. Read-only.
  "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
  "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
  "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
  "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
    "studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
      "A String",
    ],
  },
  "materials": [ # Additional materials. Announcements must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
      "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
        "driveFile": { # Representation of a Google Drive file. # Drive file details.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "shareMode": "A String", # Mechanism by which students access the Drive item.
      },
      "form": { # Google Forms item. # Google Forms material.
        "formUrl": "A String", # URL of the form.
        "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
        "title": "A String", # Title of the Form. Read-only.
      },
      "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
        "title": "A String", # Title of the target of the URL. Read-only.
        "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      "youtubeVideo": { # YouTube video item. # YouTube video material.
        "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
        "id": "A String", # YouTube API resource ID.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
        "title": "A String", # Title of the YouTube video. Read-only.
      },
    },
  ],
  "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
  "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
  "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}

patch(courseId, id, body=None, updateMask=None, x__xgafv=None)

Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the announcement. (required)
  body: object, The request body.
    The object takes the form of:

{ # Announcement created by a teacher for students of the course
  "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
  "courseId": "A String", # Identifier of the course. Read-only.
  "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
  "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
  "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
  "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
    "studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
      "A String",
    ],
  },
  "materials": [ # Additional materials. Announcements must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
      "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
        "driveFile": { # Representation of a Google Drive file. # Drive file details.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "shareMode": "A String", # Mechanism by which students access the Drive item.
      },
      "form": { # Google Forms item. # Google Forms material.
        "formUrl": "A String", # URL of the form.
        "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
        "title": "A String", # Title of the Form. Read-only.
      },
      "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
        "title": "A String", # Title of the target of the URL. Read-only.
        "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      "youtubeVideo": { # YouTube video item. # YouTube video material.
        "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
        "id": "A String", # YouTube API resource ID.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
        "title": "A String", # Title of the YouTube video. Read-only.
      },
    },
  ],
  "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
  "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
  "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}

  updateMask: string, Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Announcement created by a teacher for students of the course
  "alternateLink": "A String", # Absolute link to this announcement in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  "assigneeMode": "A String", # Assignee mode of the announcement. If unspecified, the default value is `ALL_STUDENTS`.
  "courseId": "A String", # Identifier of the course. Read-only.
  "creationTime": "A String", # Timestamp when this announcement was created. Read-only.
  "creatorUserId": "A String", # Identifier for the user that created the announcement. Read-only.
  "id": "A String", # Classroom-assigned identifier of this announcement, unique per course. Read-only.
  "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement.
    "studentIds": [ # Identifiers for the students that have access to the coursework/announcement.
      "A String",
    ],
  },
  "materials": [ # Additional materials. Announcements must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
      "driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
        "driveFile": { # Representation of a Google Drive file. # Drive file details.
          "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
          "id": "A String", # Drive API resource ID.
          "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
          "title": "A String", # Title of the Drive item. Read-only.
        },
        "shareMode": "A String", # Mechanism by which students access the Drive item.
      },
      "form": { # Google Forms item. # Google Forms material.
        "formUrl": "A String", # URL of the form.
        "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
        "title": "A String", # Title of the Form. Read-only.
      },
      "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
        "title": "A String", # Title of the target of the URL. Read-only.
        "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      "youtubeVideo": { # YouTube video item. # YouTube video material.
        "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
        "id": "A String", # YouTube API resource ID.
        "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
        "title": "A String", # Title of the YouTube video. Read-only.
      },
    },
  ],
  "scheduledTime": "A String", # Optional timestamp when this announcement is scheduled to be published.
  "state": "A String", # Status of this announcement. If unspecified, the default state is `DRAFT`.
  "text": "A String", # Description of this announcement. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  "updateTime": "A String", # Timestamp of the most recent change to this announcement. Read-only.
}