Create

Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`

10 variables
10 variables

Creates a Registration, causing Classroom to start sending notifications from the provided feed to the destination provided in cloudPubSubTopic.

Returns the created Registration. Currently, this will be the same as the argument, but with server-assigned fields such as expiry_time and id filled in.

Note that any value specified for the expiry_time or id fields will be ignored.

While Classroom may validate the cloudPubSubTopic and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it.

This method may return the following error codes:

  • PERMISSION_DENIED if:
    • the authenticated user does not have permission to receive notifications from the requested field; or
    • the credential provided does not include the appropriate scope for the requested feed.
    • another access error is encountered.
  • INVALID_ARGUMENT if:
    • no cloudPubsubTopic is specified, or the specified cloudPubsubTopic is not valid; or
    • no feed is specified, or the specified feed is not valid.
  • NOT_FOUND if:
    • the specified feed cannot be located, or the requesting user does not have permission to determine whether or not it exists; or
    • the specified cloudPubsubTopic cannot be located, or Classroom has not been granted permission to publish to it

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Receive notifications about your Google Classroom data

Input

This building block consumes 10 input parameters

  = Parameter name
  = Format

registrationId STRING

A server-generated unique identifier for this Registration.

Read-only

cloudPubsubTopic OBJECT

A reference to a Cloud Pub/Sub topic.

To register for notifications, the owner of the topic must grant [email protected] the projects.topics.publish permission

cloudPubsubTopic.topicName STRING

The name field of a Cloud Pub/Sub Topic

expiryTime ANY

The time until which the Registration is effective.

This is a read-only field assigned by the server

feed OBJECT

A class of notifications that an application can register to receive. For example: "all roster changes for a domain"

feed.courseRosterChangesInfo OBJECT

Information about a Feed with a feed_type of COURSE_ROSTER_CHANGES

feed.courseRosterChangesInfo.courseId STRING

The course_id of the course to subscribe to roster changes for

feed.courseWorkChangesInfo OBJECT

Information about a Feed with a feed_type of COURSE_WORK_CHANGES

feed.courseWorkChangesInfo.courseId STRING

The course_id of the course to subscribe to work changes for

feed.feedType ENUMERATION

The type of feed

Output

This building block provides 10 output parameters

  = Parameter name
  = Format

registrationId STRING

A server-generated unique identifier for this Registration.

Read-only

cloudPubsubTopic OBJECT

A reference to a Cloud Pub/Sub topic.

To register for notifications, the owner of the topic must grant [email protected] the projects.topics.publish permission

cloudPubsubTopic.topicName STRING

The name field of a Cloud Pub/Sub Topic

expiryTime ANY

The time until which the Registration is effective.

This is a read-only field assigned by the server

feed OBJECT

A class of notifications that an application can register to receive. For example: "all roster changes for a domain"

feed.courseRosterChangesInfo OBJECT

Information about a Feed with a feed_type of COURSE_ROSTER_CHANGES

feed.courseRosterChangesInfo.courseId STRING

The course_id of the course to subscribe to roster changes for

feed.courseWorkChangesInfo OBJECT

Information about a Feed with a feed_type of COURSE_WORK_CHANGES

feed.courseWorkChangesInfo.courseId STRING

The course_id of the course to subscribe to work changes for

feed.feedType ENUMERATION

The type of feed