Panoramica sull'utilizzo dell'API Notebooks

Questa guida fornisce una panoramica dell'utilizzo dell'API Notebooks e della relativa documentazione di riferimento.

REST, gRPC e librerie client

Puoi accedere all'API tramite REST, gRPC o una delle librerie client fornite (basate su gRPC).

Librerie client

Google fornisce librerie client per molti linguaggi comuni per accedere a questa API. Se il linguaggio di programmazione che preferisci è supportato dalle librerie client, devi utilizzare questa opzione.

Vantaggi Svantaggi
Gestito da Google.
Autenticazione integrata.
Ritentativi integrati.
Idiomatico per ogni lingua.
Efficient protocol buffer HTTP request body. 		Non disponibile per tutti i linguaggi di programmazione.

REST

Questa API supporta REST. Consulta il riferimento REST per questa API. Consulta anche Come chiamare le API di Google: edizione REST.

Vantaggi Svantaggi
Interfaccia JSON semplice.
Ben supportato da molti strumenti e librerie Google e di terze parti. 		Devi creare il tuo client.
Devi implementare l'autenticazione.
Devi implementare i tentativi.
Corpo della richiesta HTTP JSON meno efficiente.
Lo streaming REST non è supportato da questa API.

gRPC

Questa API supporta gRPC. Consulta il riferimento RPC per questa API, che fornisce una descrizione generica dei tipi, dei metodi e dei campi generati per una libreria gRPC. Vedi anche Come chiamare le API di Google: edizione RPC.

Vantaggi Svantaggi
Supporta molti linguaggi di programmazione.
Efficient protocol buffer HTTP request body. 		Devi generare il tuo client dai buffer di protocollo forniti da Google.
Devi implementare l'autenticazione.
Devi implementare i tentativi.

Tipo, metodo e nomi dei campi

A seconda che tu utilizzi librerie client, REST o gRPC, il tipo, il metodo e i nomi dei campi per l'API variano leggermente:

  • REST è organizzato in base alle gerarchie delle risorse e ai relativi metodi.
  • Le librerie client e gRPC sono organizzate in base ai servizi e ai relativi metodi.
  • I nomi dei campi REST utilizzano la notazione camel case, anche se il servizio API accetta sia la notazione camel case che snake case.
  • I nomi dei campi gRPC utilizzano la notazione snake case.
  • I nomi dei campi della libreria client utilizzano la maiuscola iniziale, il camel case o lo snake case, a seconda del nome idiomatico per la lingua.

Buffer di protocollo

Che tu utilizzi librerie client, REST o gRPC, il servizio sottostante è definito utilizzando buffer di protocollo. In particolare, il servizio utilizza proto3.

Quando chiami l'API, alcuni campi di richiesta o risposta possono richiedere una conoscenza di base dei tipi noti di buffer di protocollo.

Inoltre, quando chiami l'API REST, il valore predefinito per i buffer di protocollo potrebbe comportare la mancanza di campi in una risposta JSON. Questi campi sono semplicemente impostati sul valore predefinito, quindi non sono inclusi nella risposta.

Versioni API

Sono disponibili le seguenti versioni dell'API: