Descripción general del uso de la API de Notebooks

En esta guía, se proporciona una descripción general del uso de la API de Notebooks y su documentación de referencia.

REST, gRPC y bibliotecas cliente

Puedes acceder a la API a través de REST, gRPC o una de las bibliotecas cliente proporcionadas (compiladas en gRPC).

Bibliotecas cliente

Google proporciona bibliotecas cliente para muchos lenguajes populares que permiten acceder a esta API. Si las bibliotecas cliente admiten el lenguaje de programación que quieres usar, debes usar esta opción.

Ventajas Desventajas
Google se encarga de su mantenimiento.
Autenticación integrada.
Reintentos integrados.
Ser idiomático para cada idioma
Búfer de protocolo eficiente del cuerpo de la solicitud HTTP. 		No está disponible para todos los lenguajes de programación.

REST

Esta API admite REST. Consulta la referencia de REST para esta API. Consulta también Cómo llamar a las APIs de Google: edición de REST.

Ventajas Desventajas
Interfaz JSON simple.
Es compatible con muchas herramientas y bibliotecas de Google y de terceros. 		Debes compilar tu propio cliente.
Debes implementar la autenticación.
Debes implementar reintentos.
Cuerpo de solicitud HTTP JSON menos eficiente.
Esta API no admite la transmisión de REST.

gRPC

Esta API admite gRPC. Consulta la referencia de RPC para esta API, que proporciona una descripción genérica de los tipos, los métodos y los campos generados para una biblioteca de gRPC. Consulta también Cómo llamar a las APIs de Google: edición de RPC.

Ventajas Desventajas
Es compatible con muchos lenguajes de programación.
Búfer de protocolo eficiente del cuerpo de la solicitud HTTP. 		Debes generar tu propio cliente a partir de los búferes de protocolo proporcionados por Google.
Debes implementar la autenticación.
Debes implementar reintentos.

Tipo, método y nombres de campo

Según si usas bibliotecas cliente, REST o gRPC, el tipo, los métodos y los nombres de campo para la API varían de alguna manera:

  • REST se organiza por jerarquías de recursos y sus métodos.
  • Las bibliotecas cliente y gRPC se organizan por servicios y sus métodos.
  • Los nombres de campos REST usan mayúsculas y minúsculas, aunque el servicio de API aceptará un camel case o snake case.
  • Los nombres de campo de gRPC usan snake case.
  • Los nombres de campos de la biblioteca cliente usan camel case o snake case, según el nombre idiomático para el idioma.

búferes de protocolo

Ya sea que uses bibliotecas cliente, REST o gRPC, el servicio subyacente se define con búferes de protocolo. En particular, el servicio usa proto3.

Cuando se llama a la API, algunos campos de solicitud o respuesta pueden requerir una comprensión básica de los tipos conocidos de búfer de protocolo.

Además, cuando se llama a la API de REST, el comportamiento del valor predeterminado de los búferes de protocolo puede generar campos faltantes en una respuesta JSON. Estos campos simplemente se establecen en el valor predeterminado, por lo que no se incluyen en la respuesta.

Versiones de API

Las siguientes versiones de la API están disponibles: