REST Resource: registrations

Zasób: rejestracja

Instrukcja dla Classroom, aby wysyłać powiadomienia z feed do podanego miejsca docelowego.

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

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
Pola
registrationId

string

Wygenerowany przez serwer unikalny identyfikator tego zasobu 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 zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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".
Miejsce, do którego mają być wysyłane powiadomienia. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
cloudPubsubTopic

object (CloudPubsubTopic)

Temat Cloud Pub/Sub, do którego mają być wysyłane powiadomienia.
Koniec pól wykluczających się wzajemnie.

Karty

Klasa powiadomień, które aplikacja może otrzymywać po zarejestrowaniu. na przykład „wszystkie zmiany listy uczniów w domenie”.

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

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
Pola
feedType

enum (FeedType)

Typ pliku danych.
Dodatkowe parametry dotyczące pliku danych. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
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 o wartości COURSE_WORK_CHANGES. To pole musi być określone, jeśli feedType ma wartość COURSE_WORK_CHANGES.
Koniec pól wykluczających się wzajemnie.

FeedType

Typ kanału, w którym aplikacja może zarejestrować się, aby otrzymywać powiadomienia.

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

wszystkie zmiany w listach uczniów w danej domenie;

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

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

Wszystkie zmiany na liście uczniów w konkretnych zajęciach.

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

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

Wszystkie działania związane z zadaniami na konkretnych zajęciach.

Powiadomienia będą generowane po utworzeniu lub zmodyfikowaniu obiektu CourseWork lub StudentSubmission. Powiadomienie nie zostanie wygenerowane, gdy obiekt StudentSubmission zostanie utworzony w związku z utworzeniem lub modyfikacją nadrzędnego obiektu CourseWork (ale powiadomienie zostanie wygenerowane w przypadku utworzenia lub modyfikacji tego obiektu CourseWork).

CourseRosterChangesInfo

Informacje o Feed z feedType COURSE_ROSTER_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

courseId zajęć, dla których chcesz subskrybować zmiany na liście uczniów.

CourseWorkChangesInfo

Informacje o Feed z feedType COURSE_WORK_CHANGES.

Zapis JSON 
{
  "courseId": string
}
Pola
courseId

string

courseId zajęć, dla których 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ć uprawnienie projects.topics.publish użytkownikowi classroom-notifications@system.gserviceaccount.com.

Zapis JSON 
{
  "topicName": string
}
Pola
topicName

string

Pole name tematu Cloud Pub/Sub.

Metody

create

 Tworzy Registration, co powoduje, że Classroom zaczyna 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.