הפונקציה יוצרת Registration וגורמת ל-Classroom להתחיל לשלוח התראות מה-feed שסופק אל היעד שצוין ב-cloudPubSubTopic.
מחזירה את הערך שנוצר באמצעות Registration. נכון לעכשיו, הערך הזה יהיה זהה לארגומנט, אך לאחר מילוי שדות שהוקצו על ידי השרת, כמו expiryTime ו-id.
חשוב לשים לב שהמערכת תתעלם מערכים שצוינו בשדות expiryTime או id.
מערכת Classroom עשויה לאמת את cloudPubSubTopic ולהחזיר שגיאות על בסיס כל סוג של מאמץ, אבל באחריות המתקשר לוודא שהיא קיימת ושל-Classroom יש הרשאה לפרסם בה.
השיטה הזו עשויה להחזיר את קודי השגיאה הבאים:
PERMISSION_DENIEDאם:- למשתמש המאומת אין הרשאה לקבל התראות מהשדה המבוקש, או
- המשתמש הנוכחי לא העניק גישה לפרויקט הנוכחי ב-Cloud עם ההיקף המתאים של הפיד המבוקש. הערה: בשלב זה אין תמיכה בהאצלת סמכויות ברמת הדומיין למטרה הזו. אם לבקשה יש את ההיקף המתאים, אבל לא קיים אישור, מוחזרת [שגיאה [
@MissingGrant] של הבקשה. - נתגלה שגיאת גישה אחרת.
INVALID_ARGUMENTאם:- לא צוין
cloudPubsubTopic, או שה-cloudPubsubTopicשצוין אינו חוקי; או - לא צוין
feed, או שה-feedשצוין אינו חוקי.
- לא צוין
NOT_FOUNDאם:- לא ניתן לאתר את
feedשצוין, או שלמשתמש המבקש אין הרשאה לקבוע אם הוא קיים או לא; או - לא ניתן לאתר את
cloudPubsubTopicשצוין, או ש-Classroom לא קיבל הרשאה לפרסם בו.
- לא ניתן לאתר את
בקשת HTTP
POST https://classroom.googleapis.com/v1/registrations
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
גוף הבקשה
גוף הבקשה מכיל מופע של Registration.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע חדש של Registration שנוצר.
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/classroom.push-notifications
למידע נוסף, ניתן לעיין במדריך ההרשאות.