Visão geral do uso da API Notebooks

Este guia oferece uma visão geral de como usar a API Notebooks e a documentação de referência dela.

REST, gRPC e bibliotecas de cliente

Acesse a API via REST, gRPC ou uma das bibliotecas de cliente fornecidas (criadas no gRPC).

Bibliotecas de cliente

O Google fornece bibliotecas de cliente para que muitas linguagens conhecidas acessem essa API. Se a linguagem de programação desejada for compatível com as bibliotecas de cliente, use essa opção.

Prós Contras
Mantidos pelo Google.
Autenticação integrada.
Novas tentativas integradas.
Idiomática para cada idioma.
Corpo da solicitação HTTP de buffer de protocolo eficiente. 		Não disponível para todas as linguagens de programação.

REST

Essa API é compatível com REST. Consulte a referência REST para essa API. Consulte também Como chamar as APIs do Google: edição REST.

Prós Contras
Interface JSON simples.
É compatível com muitas ferramentas e bibliotecas do Google e de terceiros. 		Você precisa criar seu próprio cliente.
Você precisa implementar a autenticação.
Você precisa implementar novas tentativas.
Corpo da solicitação HTTP JSON menos eficiente.
O streaming REST não é compatível com esta API.

gRPC

Essa API é compatível com gRPC. Consulte a referência de RPC para essa API, que fornece uma descrição genérica dos tipos, métodos, e campos gerados para uma biblioteca gRPC. Consulte também Como chamar as APIs do Google: edição RPC.

Prós Contras
Compatível com muitas linguagens de programação.
Corpo da solicitação HTTP de buffer de protocolo eficiente. 		Você precisa gerar o próprio cliente com buffers de protocolo fornecidos pelo Google.
Você precisa implementar a autenticação.
Você precisa implementar novas tentativas.

Tipo, método e nomes de campos

Dependendo de você usar bibliotecas de cliente, REST ou gRPC, o tipo, o método e os nomes dos campos da API variam um pouco:

  • REST é organizado por hierarquia de recursos e seus métodos.
  • As bibliotecas de cliente e o gRPC são organizadas por serviços e por seus métodos.
  • Os nomes dos campos REST usam letras concatenadas, mas o serviço da API aceita maiúsculas e minúsculas.
  • Os nomes dos campos do gRPC usam maiúsculas e minúsculas.
  • Os nomes dos campos das bibliotecas de cliente usam maiúsculas ou minúsculas e a concatenação de texto, dependendo do nome idiomático da linguagem.

buffers de protocolo

Se você estiver usando bibliotecas de cliente, REST ou gRPC, o serviço subjacente será definido usando buffers de protocolo. Em particular, o serviço usa proto3.

Ao chamar a API, alguns campos de solicitação ou resposta podem exigir um conhecimento básico de tipos conhecidos de buffers de protocolo.

Além disso, ao chamar a API REST, o comportamento de valor padrão para buffers de protocolo pode resultar em campos ausentes em uma resposta JSON. Esses campos são definidos como o valor padrão, e, portanto, não são incluídos na resposta.

Versões da API

As seguintes versões de API estão disponíveis: