Inizia

Questo documento fornisce tutte le informazioni di base necessarie per iniziare a utilizzare la libreria. Tratta i concetti delle librerie, mostra esempi per vari casi d'uso, e fornisce link a ulteriori informazioni.

Configurazione

Per poter utilizzare questa libreria, devi completare alcuni passaggi di configurazione:

  1. Se non hai ancora un Account Google, registrati.
  2. Se non hai mai creato un progetto nella console API di Google, leggi le Pagina Gestione dei progetti e creiamo un progetto Console API di Google.
  3. Installa il pacchetto NuGet con cui vuoi lavorare.

Autenticazione e autorizzazione

È importante comprendere le nozioni di base della gestione dell'autenticazione e dell'autorizzazione delle API. Tutte le chiamate API devono utilizzare l'accesso semplice o l'accesso autorizzato (definito di seguito). Molti metodi dell'API richiedono l'accesso autorizzato, ma alcuni possono utilizzare entrambi. Alcuni metodi dell'API possono utilizzare un comportamento diverso, a seconda che utilizzi l'accesso semplice o autorizzato. Consulta la documentazione sul metodo dell'API per determinare il tipo di accesso appropriato.

1. Accesso semplice all'API (chiavi API)

Queste chiamate API non accedono ai dati privati dell'utente. L'applicazione deve autenticarsi come applicazione appartenente al tuo progetto della console API di Google. È necessario per misurare l'utilizzo del progetto a fini contabili.

Chiave API: Per autenticare la tua applicazione, utilizza un Chiave API per il progetto della console API. Ogni semplice chiamata di accesso effettuata dalla tua applicazione deve includere questa chiave.

2. Accesso API autorizzato (OAuth 2.0)

Queste chiamate API accedono a dati utente privati. Prima di chiamarli, l'utente che ha accesso ai dati privati deve concedere l'accesso alla tua applicazione. Pertanto, la tua applicazione deve essere autenticata, l'utente deve concedere l'accesso per la tua applicazione, e l'utente deve essere autenticato per concederlo. Tutto questo si può fare OAuth 2.0 e le librerie scritte a riguardo.

Ambito: Ogni API definisce uno o più ambiti che dichiarano un insieme di operazioni consentite. Ad esempio, un'API potrebbe avere ambiti di sola lettura e di lettura/scrittura. Quando la tua applicazione richiede l'accesso ai dati utente, la richiesta deve includere uno o più ambiti. L'utente deve approvare l'ambito di accesso richiesto dalla tua applicazione.

Token di aggiornamento e accesso: Quando un utente concede l'accesso alla tua applicazione, il server di autorizzazione OAuth 2.0 fornisce alla tua applicazione token di aggiornamento e accesso. Questi token sono validi solo per l'ambito richiesto. L'applicazione utilizza i token di accesso per autorizzare le chiamate API. I token di accesso scadono, al contrario dei token di aggiornamento. L'applicazione può utilizzare un token di aggiornamento per acquisire un nuovo token di accesso.

ID client e client secret: Queste stringhe identificano in modo univoco la tua applicazione e vengono utilizzate per acquisire token. Vengono creati per il tuo progetto nella console API. Esistono tre tipi di ID cliente: quindi assicurati di scegliere il tipo corretto per la tua applicazione:

di Gemini Advanced.

Esempi

In questa sezione sono riportati esempi di semplice utilizzo dell'API senza autorizzazione. Per ulteriori informazioni sulle chiamate di autorizzazione, consulta Pagina OAuth 2.0 per .NET.

Esempio di API semplice

Questo esempio utilizza un semplice accesso API per un'applicazione a riga di comando. Viene chiamato API Google Discovery per visualizzare un elenco di tutte le API di Google.

Configurazione, ad esempio

Procurati la tua chiave API semplice. Per trovare la chiave API dell'applicazione, procedi nel seguente modo:

  1. Apri la pagina Credenziali nella console API.
  2. Questa API supporta due tipi di credenziali. Crea le credenziali appropriate per il tuo progetto:

    • OAuth 2.0:ogni volta che la tua applicazione richiede un utente privato. dati, deve inviare un token OAuth 2.0 insieme alla richiesta. Il tuo invia innanzitutto un ID client ed eventualmente un client secret ottenere un token. Puoi generare credenziali OAuth 2.0 per il web applicazioni, account di servizio o applicazioni installate.

      Per ulteriori informazioni, consulta la documentazione relativa a OAuth 2.0.

    • Chiavi API: Una richiesta che non fornisce un token OAuth 2.0 deve inviare un'API chiave. La chiave identifica il progetto e fornisce accesso API, quota e report.

      L'API supporta diversi tipi di limitazioni sulle chiavi API. Se la chiave API non esiste già, crea una chiave API nella console facendo clic su Crea credenziali  > chiave API. Puoi limitare la chiave prima di utilizzarla in produzione facendo clic su Limita chiave e selezionando una delle Limitazioni.

Per proteggere le tue chiavi API, segui le best practice per in modo sicuro usando chiavi API.

Codice, ad esempio

using System;
using System.Threading.Tasks;

using Google.Apis.Discovery.v1;
using Google.Apis.Discovery.v1.Data;
using Google.Apis.Services;

namespace Discovery.ListAPIs
{
    /// <summary>
    /// This example uses the discovery API to list all APIs in the discovery repository.
    /// https://developers.google.com/discovery/v1/using.
    /// <summary>
    class Program
    {
        [STAThread]
        static void Main(string[] args)
        {
            Console.WriteLine("Discovery API Sample");
            Console.WriteLine("====================");
            try
            {
                new Program().Run().Wait();
            }
            catch (AggregateException ex)
            {
                foreach (var e in ex.InnerExceptions)
                {
                    Console.WriteLine("ERROR: " + e.Message);
                }
            }
            Console.WriteLine("Press any key to continue...");
            Console.ReadKey();
        }

        private async Task Run()
        {
            // Create the service.
            var service = new DiscoveryService(new BaseClientService.Initializer
                {
                    ApplicationName = "Discovery Sample",
                    ApiKey="[YOUR_API_KEY_HERE]",
                });

            // Run the request.
            Console.WriteLine("Executing a list request...");
            var result = await service.Apis.List().ExecuteAsync();

            // Display the results.
            if (result.Items != null)
            {
                foreach (DirectoryList.ItemsData api in result.Items)
                {
                    Console.WriteLine(api.Id + " - " + api.Title);
                }
            }
        }
    }
}

Suggerimenti per l'utilizzo delle chiavi API:

  • Per utilizzare un servizio specifico, devi aggiungere un riferimento. Ad esempio, se vuoi utilizzare API Tasks, dovresti installare il relativo pacchetto NuGet Google.Apis.Tasks.v1.
  • Per creare un'istanza di un servizio, è sufficiente chiamare il suo costruttore. Ad esempio: new TasksService(new BaseClientService.Initializer {...});".
  • Tutti i metodi di un servizio si trovano su singole risorse nell'oggetto di servizio stesso. Il servizio di rilevamento ha una risorsa Apis, che contiene un metodo List. Quando chiami service.Apis.List(..), viene restituito un oggetto della richiesta che ha come target questo metodo.
    Per eseguire una richiesta, chiama il metodo Execute() o ExecuteAsyc() su una richiesta.
  • Imposta la chiave API utilizzando la proprietà ApiKey sull'istanza BaseClientService.Initializer.

Trovare informazioni sulle API

La API supportate che elenca tutte le API a cui è possibile accedere utilizzando questa libreria, oltre ai link alla documentazione.

Puoi utilizzare anche Explorer API per sfogliare le API, elencare i metodi disponibili e persino provare le chiamate API dal tuo browser.