Method: registrations.create

Crée un Registration. Permet à Classroom d'envoyer des notifications depuis le feed fourni à la destination indiquée dans cloudPubSubTopic.

Renvoie l'élément Registration créé. Actuellement, ce sera le même que l'argument, mais les champs attribués par le serveur, tels que expiryTime et id, sont renseignés.

Notez que toute valeur spécifiée dans les champs expiryTime ou id est ignorée.

Bien que Classroom puisse valider l'élément cloudPubSubTopic et renvoyer des erreurs au mieux, il appartient à l'appelant de s'assurer qu'il existe et que Classroom est autorisé à y publier des messages.

Cette méthode peut renvoyer les codes d'erreur suivants:

  • PERMISSION_DENIED si :
    • l'utilisateur authentifié n'est pas autorisé à recevoir les notifications du champ demandé ; ou
    • l'utilisateur actuel n'a pas accordé l'accès au projet Cloud actuel avec le champ d'application approprié pour le flux demandé. Notez que la délégation d'autorité au niveau du domaine n'est actuellement pas disponible à cette fin. Si la requête dispose du champ d'application approprié, mais qu'aucune autorisation n'est disponible, une erreur [Request Errors][@MissingGrant error] est renvoyée.
    • Une autre erreur d'accès se produit.
  • INVALID_ARGUMENT si :
    • Aucun cloudPubsubTopic n'est spécifié, ou le cloudPubsubTopic spécifié n'est pas valide ; ou
    • Aucun feed n'est spécifié, ou le feed spécifié n'est pas valide.
  • NOT_FOUND si :
    • le feed spécifié est introuvable, ou l'utilisateur à l'origine de la demande n'est pas autorisé à déterminer si tel est le cas ; ou
    • le cloudPubsubTopic spécifié est introuvable, ou Classroom n'a pas été autorisé à y publier des contenus.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient une instance Registration.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Registration.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez le guide relatif aux autorisations.