Méthodes de prévisualisation dans les modules complémentaires en accès anticipé

Les méthodes API des programmes en accès anticipé ou en preview privés sont privées, ce qui signifie qu'elles ne sont pas exposées dans les bibliothèques clientes standards accessibles par défaut via HTTP. Cette page explique comment accéder à ces d'aperçu.

Ce document décrit quatre options d'utilisation de l'API d'aperçu:

  1. Bibliothèques clientes statiques fournies par Google.
  2. Bibliothèques clientes générées dynamiquement
  3. Requêtes HTTP directes
  4. votre propre bibliothèque cliente personnalisée ;

L'utilisation de bibliothèques statiques ou générées dynamiquement par Google la méthode recommandée pour utiliser l'API.

Bibliothèques statiques

Dans des langages tels que Java, Node.js, PHP et C#, les bibliothèques clientes doivent être créées à partir de source. Ces bibliothèques sont disponibles dans les téléchargements de bibliothèques clientes. et disposent déjà des méthodes d'aperçu.

Vous devrez peut-être modifier la configuration type de vos dépendances bibliothèques locales plutôt que d'importer les bibliothèques clientes standards, qui ne les méthodes d'aperçu.

Par exemple, si vous utilisez Node.js et npm, ajoutez la bibliothèque cliente Node.js télécharger (googleapis-classroom-1.0.4.tgz) en tant que dépendance locale dans package.json:

{
  "name": "nodejs-classroom-example",
  "version": "1.0.0",
  ...
  "dependencies": {
    "@google-cloud/local-auth": "^2.1.0",
    "googleapis": "^95.0.0",
    "classroom-with-addons": "file:./googleapis-classroom-1.0.4.tgz"
  }
}

Ensuite, dans votre application, exigez le module classroom-with-addons en plus aux dépendances standards, et instanciez le service classroom à partir de ce module:

const {authenticate} = require('@google-cloud/local-auth');
const {google} = require('googleapis');
const classroomWithAddons = require('classroom-with-addons');

...

const classroom = classroomWithAddons.classroom({
  version: 'v1',
  auth: auth,
});

...

Bibliothèques dynamiques

Dans des langages tels que Python, les bibliothèques génèrent la bibliothèque cliente au moment de l'exécution en utilisant un document de découverte issu du service de découverte ;

Un document de découverte est une spécification lisible par un ordinateur pour décrire et à l'aide d'API REST. Il permet de créer des bibliothèques clientes, des plug-ins IDE et et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs des documents de découverte.

Documents de découverte pour le service de l'API Classroom (classroom.googleapis.com) se trouve au point de terminaison suivant:

  • https://classroom.googleapis.com/$discovery/rest?labels=<PREVIEW_LABEL>&version=v1&key=<PREVIEW_LABEL>

Pour générer la bibliothèque Python et instancier le service Classroom avec vous pouvez spécifier l'URL de découverte avec le service approprié, les identifiants et l'étiquette:

classroom_service_with_rubrics = googleapiclient.discovery.build(
  serviceName="classroom",
  version="v1",
  credentials=credentials,
  static_discovery=False,
  discoveryServiceUrl=f"https://classroom.googleapis.com/$discovery/rest?labels=ADD_ONS_ALPHA&key=ABCXYZ")

Consultez la documentation de la bibliothèque cliente des API Google pour en savoir plus sur chaque langue. Lors de l'utilisation des API de prévisualisation, il est important de spécifier le label approprié. Dans cet aperçu, ce libellé est ADD_ONS_ALPHA.

Requêtes HTTP

Si vous effectuez des requêtes HTTP sans bibliothèque cliente, veillez à inclure l'étiquette (ADD_ONS_ALPHA) comme en-tête X-Goog-Visibilities.

Par exemple, pour afficher toutes les pièces jointes créées par un module complémentaire sous un post, utilisez la requête curl suivante:

curl \
  'https://classroom.googleapis.com/v1/courses/[courseId]/courseWork/[itemId]/addOnAttachments?key=[YOUR_API_KEY]' \
  --header 'X-Goog-Visibilities: ADD_ONS_ALPHA' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --compressed

L'API utilisée pour chaque requête HTTP est décrite dans la documentation REST.

Bibliothèques clientes personnalisées

Consultez la section Créer des bibliothèques clientes si vous devez créer votre propre bibliothèque. Création... votre propre bibliothèque n'entre pas dans le cadre de ce guide, mais nous vous recommandons de consulter Bibliothèques dynamiques pour en savoir plus sur les étiquettes d'aperçu et leur rôle dans Découverte.