Method: registrations.create

יוצרת Registration, וכתוצאה מכך מערכת Classroom מתחילה לשלוח התראות מה-feed שצוין ליעד שצוין ב-cloudPubSubTopic.

הפונקציה מחזירה את ה-Registration שנוצר. בשלב זה, הערך הזה יהיה זהה לארגומנט, אבל עם שדות שהוקצו על ידי השרת, כמו expiryTime ו-id, שמולאו.

הערה: המערכת תתעלם מכל ערך שצוין בשדות expiryTime או id.

מערכת Classroom עשויה לאמת את cloudPubSubTopic ולהחזיר שגיאות על בסיס 'לפי יכולתה', אבל באחריות מבצע הקריאה לוודא שהיא קיימת ושמערכת Classroom מורשית לפרסם בה.

שיטת ה-method הזו עשויה להחזיר את קודי השגיאה הבאים:

  • PERMISSION_DENIED אם:
    • למשתמש המאומת אין הרשאה לקבל התראות מהשדה המבוקש.
    • המשתמש הנוכחי לא העניק גישה לפרויקט הנוכחי ב-Cloud עם ההיקף המתאים לפיד המבוקש. לתשומת ליבכם: בשלב הזה אין תמיכה בהענקת גישה ברמת הדומיין למטרה הזו. אם הבקשה כוללת את ההיקף המתאים אבל אין הרשאה, תוחזר [שגיאת בקשה][שגיאה @MissingGrant].
    • נתקלתם בשגיאת גישה אחרת.
  • INVALID_ARGUMENT אם:
    • לא צוין cloudPubsubTopic או שהערך של cloudPubsubTopic שצוין לא חוקי.
    • לא צוין feed או שה-feed שצוין לא חוקי.
  • NOT_FOUND אם:
    • לא ניתן לאתר את feed שצוין, או שלמשתמש המבקש אין הרשאה לקבוע אם הוא קיים או לא.
    • לא ניתן לאתר את cloudPubsubTopic שצוין, או שלא הוקצה ל-Classroom הרשאה לפרסם בו.

בקשת HTTP

POST https://classroom.googleapis.com/v1/registrations

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

גוף הבקשה

גוף הבקשה מכיל מופע של Registration.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Registration.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/classroom.push-notifications

מידע נוסף זמין במדריך ההרשאות.