REST Resource: registrations

Zasób: Registration

instrukcję dla Classroom, aby wysyłać powiadomienia 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 dostarczać 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.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i używają 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
Pole unii destination. Miejsce, do którego 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 mają być wysyłane powiadomienia.

Kanał

Klasa powiadomień, które aplikacja może zarejestrować, aby je otrzymywać. Na przykład: „wszystkie zmiany na liście użytkownikó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 unii info. Dodatkowe parametry dotyczące pliku danych. info może mieć tylko jedną z tych wartości:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informacje o Feed z feedType o wartości 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 o wartości COURSE_WORK_CHANGES. To pole musi być określone, jeśli feedType ma wartość COURSE_WORK_CHANGES.

FeedType

Typ pliku danych, w którym aplikacja może zarejestrować powiadomienia.

Wartości w polu enum
FEED_TYPE_UNSPECIFIED Nigdy nie powinny być zwracane ani udostępniane.
DOMAIN_ROSTER_CHANGES

Wszystkie zmiany na liście w danej domenie.

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

Gdy zaproszenie zostanie utworzone lub usunięte, nie będą generowane żadne powiadomienia, ale powiadomienia będą generowane, gdy użytkownik dołączy do kursu, akceptując zaproszenie.
COURSE_ROSTER_CHANGES

Wszystkie zmiany na liście uczestników danego kursu.

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

Gdy zaproszenie zostanie utworzone lub usunięte, nie będą generowane żadne powiadomienia, ale powiadomienia będą generowane, gdy użytkownik dołączy do kursu, akceptując zaproszenie.
COURSE_WORK_CHANGES

wszystkie działania związane z pracą na zajęciach w ramach konkretnego kursu;

Powiadomienia będą generowane, gdy obiekt CourseWork lub StudentSubmission zostanie utworzony lub zmodyfikowany. Gdy obiekt StudentSubmission jest tworzony w związku z utworzeniem lub zmodyfikowaniem jego nadrzędnego obiektu CourseWork, nie jest generowane powiadomienie (ale powiadomienie jest generowane w przypadku utworzenia lub zmodyfikowania obiektu CourseWork).

CourseRosterChangesInfo

Informacje o Feed z feedType o wartości COURSE_ROSTER_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

courseId kursu, w przypadku którego chcesz subskrybować zmiany na liście.

CourseWorkChangesInfo

Informacje o Feed z feedType o wartości COURSE_WORK_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

courseId kursu, w przypadku którego chcesz subskrybować zmiany w zadaniach.

CloudPubsubTopic

Odwołanie do tematu Cloud Pub/Sub.

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

Zapis JSON 
{
  "topicName": string
}
Pola
topicName

string

Pole name tematu Cloud Pub/Sub Topic.

Metody

create

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

delete

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