REST Resource: registrations

Zasób: rejestracja

Instrukcja wysyłania do Classroom powiadomień z urządzenia feed do wskazanego 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 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 zasada Registration.

To pole jest tylko do odczytu przypisane przez serwer.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy 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 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 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: 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

Rodzaj kanału, z którego aplikacja może zarejestrować powiadomienia.

Wartości w polu enum
FEED_TYPE_UNSPECIFIED Nigdy nie należy go zwracać ani podawać.
DOMAIN_ROSTER_CHANGES

Wszystkie zmiany listy uczniów w danej domenie.

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

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

COURSE_ROSTER_CHANGES

Wszystkie zmiany w liście uczniów dotyczące konkretnych zajęć.

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

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

COURSE_WORK_CHANGES

Wszystkie zadania związane z konkretnym kursem.

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

CourseRosterChangesInfo

Informacje o: Feed z feedType o wartości COURSE_ROSTER_CHANGES.

Zapis JSON
{
  "courseId": string
}
Pola
courseId

string

courseId zajęć, w których można zapisać zmiany w liście uczniów.

CourseWorkChangesInfo

Informacje o: Feed z feedType o wartości COURSE_WORK_CHANGES.

Zapis JSON
{
  "courseId": string
}
Pola
courseId

string

courseId kursu, z którego możesz zasubskrybować zadania, zmienia się.

CloudPubsubTopic

Odwołanie do tematu Cloud Pub/Sub.

Aby można było zarejestrować się w celu 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 Registration, przez co Classroom zaczyna wysyłać powiadomienia z podanego feed do miejsca docelowego w cloudPubSubTopic.

delete

Usuwa Registration, przez co Classroom przestanie wysyłać powiadomienia dotyczące tego urządzenia (Registration).