REST Resource: registrations

संसाधन: रजिस्ट्रेशन

Classroom को दिया गया निर्देश, ताकि वह feed से सूचनाएं भेज सके.

JSON के काेड में दिखाना
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
फ़ील्ड
registrationId

string

इस Registration के लिए, सर्वर से जनरेट किया गया यूनीक आइडेंटिफ़ायर.

सिर्फ़ पढ़ने के लिए.

feed

object (Feed)

Classroom को डेस्टिनेशन पर किस तरह की सूचनाएं भेजनी चाहिए, इसकी जानकारी.

expiryTime

string (Timestamp format)

वह समय जब तक Registration लागू रहेगा.

यह फ़ील्ड, सर्वर असाइन करता है. इसमें मौजूद डेटा को सिर्फ़ पढ़ा जा सकता है.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

सूचनाएं कहां भेजी जानी चाहिए. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
cloudPubsubTopic

object (CloudPubsubTopic)

Cloud Pub/Sub का वह विषय जिस पर सूचनाएं भेजी जानी हैं.

एक-दूसरे से अलग फ़ील्ड का अंत.

फ़ीड

सूचनाओं की एक कैटगरी, जिसे पाने के लिए कोई ऐप्लिकेशन रजिस्टर कर सकता है. उदाहरण के लिए: "किसी डोमेन के लिए, रोस्टर में किए गए सभी बदलाव".

JSON के काेड में दिखाना
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
फ़ील्ड
feedType

enum (FeedType)

फ़ीड का टाइप.

फ़ीड के बारे में अतिरिक्त पैरामीटर. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Feed के बारे में जानकारी, जिसमें feedType की वैल्यू COURSE_ROSTER_CHANGES है. अगर feedType की वैल्यू COURSE_ROSTER_CHANGES है, तो इस फ़ील्ड की वैल्यू सबमिट करना ज़रूरी है.

courseWorkChangesInfo

object (CourseWorkChangesInfo)

Feed के बारे में जानकारी, जिसमें feedType की वैल्यू COURSE_WORK_CHANGES है. अगर feedType की वैल्यू COURSE_WORK_CHANGES है, तो इस फ़ील्ड की वैल्यू सबमिट करना ज़रूरी है.

एक-दूसरे से अलग फ़ील्ड का अंत.

FeedType

एक तरह का फ़ीड, जिसके लिए कोई ऐप्लिकेशन सूचनाएं पाने के लिए रजिस्टर कर सकता है.

Enums
FEED_TYPE_UNSPECIFIED इसे कभी भी वापस नहीं किया जाना चाहिए या उपलब्ध नहीं कराया जाना चाहिए.
DOMAIN_ROSTER_CHANGES

किसी डोमेन के लिए, छात्र-छात्राओं की सूची में किए गए सभी बदलाव.

जब भी कोई उपयोगकर्ता किसी कोर्स में शामिल होगा या उसे छोड़ेगा, तब सूचनाएं जनरेट होंगी.

न्योता बनाने या मिटाने पर कोई सूचना जनरेट नहीं होगी. हालांकि, जब कोई उपयोगकर्ता न्योता स्वीकार करके किसी कोर्स में शामिल होगा, तब सूचनाएं जनरेट होंगी.

COURSE_ROSTER_CHANGES

किसी कोर्स के लिए, छात्र-छात्राओं की सूची में किए गए सभी बदलाव.

जब भी कोई उपयोगकर्ता किसी कोर्स में शामिल होगा या उसे छोड़ेगा, तब सूचनाएं जनरेट होंगी.

न्योता बनाने या मिटाने पर कोई सूचना जनरेट नहीं होगी. हालांकि, जब कोई उपयोगकर्ता न्योता स्वीकार करके किसी कोर्स में शामिल होगा, तब सूचनाएं जनरेट होंगी.

COURSE_WORK_CHANGES

किसी कोर्स के लिए, क्लासवर्क से जुड़ी सभी गतिविधियां.

जब कोई CourseWork या StudentSubmission ऑब्जेक्ट बनाया जाएगा या उसमें बदलाव किया जाएगा, तब सूचनाएं जनरेट होंगी. अगर किसी CourseWork ऑब्जेक्ट को बनाने या उसमें बदलाव करने के दौरान, उससे जुड़ा StudentSubmission ऑब्जेक्ट बनाया जाता है, तो कोई सूचना जनरेट नहीं होगी. हालांकि, उस CourseWork ऑब्जेक्ट को बनाने या उसमें बदलाव करने के लिए सूचना जनरेट होगी.

CourseRosterChangesInfo

Feed के बारे में जानकारी, जिसमें feedType की वैल्यू COURSE_ROSTER_CHANGES है.

JSON के काेड में दिखाना
{
  "courseId": string
}
फ़ील्ड
courseId

string

उस कोर्स का courseId जिसके लिए, छात्र-छात्राओं की सूची में होने वाले बदलावों की सूचनाएं पाने की सुविधा चालू करनी है.

CourseWorkChangesInfo

Feed के बारे में जानकारी, जिसमें feedType की वैल्यू COURSE_WORK_CHANGES है.

JSON के काेड में दिखाना
{
  "courseId": string
}
फ़ील्ड
courseId

string

उस कोर्स का courseId जिसके काम में होने वाले बदलावों की सूचनाएं पाने के लिए सदस्यता लेनी है.

CloudPubsubTopic

Cloud Pub/Sub के किसी विषय का रेफ़रंस.

सूचनाएं पाने के लिए रजिस्टर करने के लिए, विषय के मालिक को classroom-notifications@system.gserviceaccount.com को projects.topics.publish की अनुमति देनी होगी.

JSON के काेड में दिखाना
{
  "topicName": string
}
फ़ील्ड
topicName

string

Cloud Pub/Sub विषय का name फ़ील्ड.

तरीके

create

इससे एक Registration बनता है. इसकी वजह से, Classroom दिए गए feed से cloudPubSubTopic में दिए गए डेस्टिनेशन पर सूचनाएं भेजना शुरू कर देता है.

delete

किसी Registration को मिटाता है, जिससे Classroom उस Registration के लिए सूचनाएं भेजना बंद कर देता है.