REST Resource: registrations

Zasób: Rejestracja

instrukcja wysyłania powiadomień z feed do podanego miejsca docelowego.

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 Registration.

Tylko do odczytu.
feed

object (Feed)

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

string (Timestamp format)

Czas, do którego obowiązuje Registration.

To pole jest tylko do odczytu i jest przypisywane przez serwer.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
Pole unii destination. Gdzie mają być wysyłane powiadomienia. destination może być tylko jednym z tych elementów:
cloudPubsubTopic

object (CloudPubsubTopic)

Temat Cloud Pub/Sub, do którego mają być wysyłane powiadomienia.

Kanał

Klasa powiadomień, które aplikacja może zarejestrować do odbioru. Na przykład: „wszystkie zmiany w harmonogramie 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 unii info. dodatkowe parametry pliku danych; info może być tylko jednym z tych elementów:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informacje o Feed z feedType COURSE_ROSTER_CHANGES. To pole musi być określone, jeśli feedType ma wartość COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informacje o Feed z feedType COURSE_WORK_CHANGES. To pole musi być określone, jeśli feedType ma wartość COURSE_WORK_CHANGES.

FeedType

Typ pliku danych, który aplikacja może zarejestrować w celu otrzymywania powiadomień.

Wartości w polu enum
FEED_TYPE_UNSPECIFIED Nigdy nie powinien być zwracany ani udostępniany.
DOMAIN_ROSTER_CHANGES

Wszystkie zmiany w składzie w konkretnej domenie.

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

Nie będą generowane powiadomienia o utworzeniu lub usunięciu zaproszenia, ale będą generowane po dołączeniu użytkownika do kursu po zaakceptowaniu zaproszenia.
COURSE_ROSTER_CHANGES

Wszystkie zmiany w składzie danego kursu.

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

Nie będą generowane powiadomienia o utworzeniu lub usunięciu zaproszenia, ale będą generowane po dołączeniu użytkownika do kursu po zaakceptowaniu zaproszenia.
COURSE_WORK_CHANGES

Wszystkie działania związane z pracą na szkoleniu.

Powiadomienia będą generowane podczas tworzenia lub modyfikowania obiektu CourseWork lub StudentSubmission. Nie zostanie wygenerowane żadne powiadomienie, gdy obiekt StudentSubmission zostanie utworzony w związku z utworzeniem lub modyfikacją obiektu nadrzędnego CourseWork (ale powiadomienie zostanie wygenerowane w przypadku utworzenia lub modyfikacji obiektu CourseWork).

CourseRosterChangesInfo

Informacje o Feed z feedType COURSE_ROSTER_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

courseId kursu, którego zmiany w składzie chcesz subskrybować.

CourseWorkChangesInfo

Informacje o Feed z feedType COURSE_WORK_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

courseId kursu, na który chcesz się zasubskrybować, aby otrzymywać powiadomienia o zmianach dotyczących pracy.

CloudPubsubTopic

Odwołuje się do tematu Cloud Pub/Sub.

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

Zapis JSON 
{
  "topicName": string
}
Pola
topicName

string

Pole name w temacie Cloud Pub/Sub.

Metody

create

 Tworzy Registration, co powoduje, że Classroom zacznie wysyłać powiadomienia z podanego feed do miejsca docelowego podanego w cloudPubSubTopic.

delete

 usuwa Registration, co powoduje, że Classroom przestaje wysyłać powiadomienia dotyczące tego Registration.