Los métodos de API en los programas de versión preliminar privados o de acceso anticipado son privados, lo que significa que no están expuestas en las bibliotecas cliente estándar y pueden accesibles de forma predeterminada a través de HTTP. En esta página, se describe cómo acceder a estos Preview.
En este documento, se analizan cuatro opciones para consumir la API de Preview:
- Bibliotecas cliente estáticas proporcionadas por Google.
- Bibliotecas cliente generadas de forma dinámica.
- Solicitudes HTTP directas
- Tu propia biblioteca cliente personalizada.
Usar bibliotecas estáticas o generadas de forma dinámica que proporciona Google y se recomienda usar la API.
Bibliotecas estáticas
Se deben compilar las bibliotecas cliente en lenguajes como Java, Node.js, PHP y C# fuente. Estas bibliotecas se proporcionan en las descargas de bibliotecas cliente. y ya tenemos los métodos de vista previa.
Es posible que debas modificar tu configuración de dependencias típica para usar estas las bibliotecas locales en lugar de importar las bibliotecas cliente estándar, que no los métodos de vista previa.
Por ejemplo, si usas Node.js y npm, agrega la biblioteca cliente de Node.js
descargar (googleapis-classroom-1.0.4.tgz) como una dependencia local en
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"
}
}
Luego, en tu aplicación, solicita el módulo classroom-with-addons además
a dependencias regulares y crear una instancia del servicio classroom a partir de ellas
módulo:
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,
});
...
Bibliotecas dinámicas
Las bibliotecas en lenguajes como Python generan la biblioteca cliente en el entorno de ejecución con un Documento de descubrimiento del servicio de descubrimiento.
Un Documento de descubrimiento es una especificación procesable para describir y las APIs de REST que consumen. se usa para compilar bibliotecas cliente, complementos IDE y y otras herramientas que interactúan con las APIs de Google. Un servicio puede proporcionar varias de descubrimiento.
Descubrimiento de documentos para el servicio de la API de Classroom
(classroom.googleapis.com) se pueden encontrar en el siguiente extremo:
- https://classroom.googleapis.com/$discovery/rest?labels=<PREVIEW_LABEL>&version=v1&key=<PREVIEW_LABEL>
Para generar la biblioteca de Python y crear una instancia del servicio Classroom con o complementos, puedes especificar la URL de descubrimiento con el servicio adecuado, credenciales y etiqueta:
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")
Consulta la documentación de la biblioteca cliente de la API de Google individual para obtener detalles sobre cada una.
idioma. La distinción importante a la hora de trabajar con APIs de versión preliminar es especificar
el label adecuado. En esta vista previa, la etiqueta es ADD_ONS_ALPHA.
Solicitudes HTTP
Si realizas solicitudes HTTP sin una biblioteca cliente, asegúrate de incluir la etiqueta.
(ADD_ONS_ALPHA) como un encabezado X-Goog-Visibilities.
Por ejemplo, para ver todos los archivos adjuntos que creó un complemento en una publicación, usa el menú siguiente solicitud curl:
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
La API para cada solicitud HTTP se describe en la documentación de REST.
Bibliotecas cliente personalizadas
Consulta Cómo compilar bibliotecas cliente si necesitas compilar tu propia biblioteca. Creando tu propia biblioteca está fuera del alcance de esta guía, pero debes revisar el sección de bibliotecas dinámicas para obtener información sobre las etiquetas de vista previa y su función en Descubrimiento.