REST Resource: registrations

Zasób: Registration

Instrukcja do Classroom wysyłania powiadomień z feed na podane miejsce docelowe.

Zapis JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  // Union field destination can be only one of the following:
  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field destination.
}
Pola
registrationId

string

Wygenerowany przez serwer unikalny identyfikator tego elementu (Registration).

Tylko do odczytu.
feed

object (Feed)

Specyfikacja klasy powiadomień, które Classroom ma dostarczać do miejsca docelowego.
expiryTime

string (Timestamp format)

Czas, do którego obowiązuje Registration.

To jest pole tylko do odczytu przypisane przez serwer.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
Pole sumy destination. Dokąd mają być wysyłane powiadomienia. destination może mieć tylko jedną z tych wartości:
cloudPubsubTopic

object (CloudPubsubTopic)

Temat Cloud Pub/Sub, do którego będą wysyłane powiadomienia.

Kanał

Klasa powiadomień, które aplikacja może zarejestrować, aby otrzymywać. Na przykład: „wszystkie zmiany listy uczniów w domenie”.

Zapis JSON 
{
  "feedType": enum (FeedType),

  // Union field info can be only one of the following:
  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
  // End of list of possible types for union field info.
}
Pola
feedType

enum (FeedType)

Typ pliku danych.
Pole sumy info. Dodatkowe parametry pliku danych. info może mieć tylko jedną z tych wartości:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informacje o obiekcie Feed z wartością feedType o wartości COURSE_ROSTER_CHANGES. To pole należy określić, jeśli feedType ma wartość COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informacje o obiekcie Feed z wartością feedType o wartości COURSE_WORK_CHANGES. To pole należy określić, jeśli feedType ma wartość COURSE_WORK_CHANGES.

FeedType

Typ kanału, z którego aplikacja może rejestrować powiadomienia.

Wartości w polu enum
FEED_TYPE_UNSPECIFIED Nie należy ich zwracać ani przekazywać.
DOMAIN_ROSTER_CHANGES

Wszystkie zmiany listy uczniów z danej domeny.

Powiadomienia będą generowane za każdym razem, gdy użytkownik dołączy do zajęć lub je opuści.

Powiadomienia nie będą generowane po utworzeniu lub usunięciu zaproszenia, ale będą generowane, gdy użytkownik dołączy do zajęć przez zaakceptowanie zaproszenia.
COURSE_ROSTER_CHANGES

Wszystkie zmiany listy uczniów na konkretnych zajęciach.

Powiadomienia będą generowane za każdym razem, gdy użytkownik dołączy do zajęć lub je opuści.

Powiadomienia nie będą generowane po utworzeniu lub usunięciu zaproszenia, ale będą generowane, gdy użytkownik dołączy do zajęć przez zaakceptowanie zaproszenia.
COURSE_WORK_CHANGES

Cała aktywność związana z danymi zajęciami.

Powiadomienia będą generowane po utworzeniu lub zmodyfikowaniu obiektu CourseWork lub StudentSubmission. Nie zostanie wygenerowane żadne powiadomienie, gdy obiekt StudentSubmission zostanie utworzony w związku z utworzeniem lub modyfikacją nadrzędnego obiektu CourseWork (ale zostanie wygenerowane powiadomienie o utworzeniu lub modyfikacji obiektu CourseWork).

CourseRosterChangesInfo

Informacje o obiekcie Feed z wartością feedType o wartości COURSE_ROSTER_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

courseId zajęć, dla których chcesz subskrybować zmiany listy uczniów.

CourseWorkChangesInfo

Informacje o obiekcie Feed z wartością feedType o wartości COURSE_WORK_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

Zmiany w kursie courseId, którego dotyczy subskrybowanie zadań.

CloudPubsubTopic

Odwołanie do tematu Cloud Pub/Sub.

Aby zarejestrować się do otrzymywania powiadomień, właściciel tematu musi przyznać użytkownikowi classroom-notifications@system.gserviceaccount.com uprawnienie projects.topics.publish.

Zapis JSON 
{
  "topicName": string
}
Pola
topicName

string

Pole name tematu Cloud Pub/Sub.

Metody

create

 Tworzy element Registration, przez co Classroom zaczyna wysyłać powiadomienia z podanego feed do miejsca docelowego podanego w cloudPubSubTopic.

delete

 Usuwa element Registration, przez co Classroom przestanie wysyłać związane z nim powiadomienia. Registration.