Cette page a été traduite par l'API Cloud Translation.

Commencer

Ce document fournit toutes les informations de base dont vous avez besoin pour commencer à utiliser la bibliothèque. Il aborde les concepts de la bibliothèque, présente des exemples pour différents cas d'utilisation, et fournit des liens vers plus d'informations.

Configuration

Vous devez suivre quelques étapes de configuration avant de pouvoir utiliser cette bibliothèque:

Si vous n'avez pas encore de compte Google, inscrivez-vous.
Si vous n'avez jamais créé de projet dans la console Google APIs, consultez le Page "Gérer les projets" et créer un projet dans le Console Google APIs :
Installez le package NuGet avec lequel vous souhaitez travailler.

Authentification et autorisation

Il est important de comprendre les principes de base de la gestion de l'authentification et de l'autorisation des API. Tous les appels d'API doivent utiliser un accès simple ou un accès autorisé (défini ci-dessous). De nombreuses méthodes d'API nécessitent un accès autorisé, mais certaines peuvent utiliser l'une ou l'autre. Certaines méthodes d'API qui peuvent utiliser l'une ou l'autre se comportent différemment, selon que vous utilisez un accès simple ou un accès autorisé. Pour déterminer le type d'accès approprié, consultez la documentation sur les méthodes de l'API.

1. Accès simple à l'API (clés API)

Ces appels d'API n'accèdent à aucune donnée utilisateur privée. Votre application doit s'authentifier en tant qu'application appartenant à votre projet dans la console Google APIs. Cela est nécessaire pour mesurer l'utilisation du projet à des fins comptables.

Clé API: Pour authentifier votre application, utilisez un Clé API pour votre projet de console APIs. Chaque appel d'accès simple effectué par votre application doit inclure cette clé.

2. Accès aux API autorisés (OAuth 2.0)

Ces appels d'API accèdent à des données utilisateur privées. Avant de pouvoir l'appeler, l'utilisateur ayant accès aux données privées doit accorder l'accès à votre application. Votre application doit donc être authentifiée l'utilisateur doit accorder l'accès à votre application, et l'utilisateur doit être authentifié pour accorder cet accès. Tout cela est accompli avec OAuth 2.0 et les bibliothèques correspondantes.

Portée: Chaque API définit un ou plusieurs champs d'application qui déclarent un ensemble d'opérations autorisées. Par exemple, une API peut avoir des champs d'application en lecture seule et en lecture-écriture. Lorsque votre application demande à accéder à des données utilisateur, la requête doit inclure un ou plusieurs champs d'application. L'utilisateur doit approuver le niveau d'accès demandé par votre application.

Jetons d'actualisation et d'accès: Lorsqu'un utilisateur accorde l'accès à votre application, le serveur d'autorisation OAuth 2.0 fournit à votre application des jetons d'actualisation et d'accès. Ces jetons ne sont valides que pour la portée demandée. Votre application utilise des jetons d'accès pour autoriser les appels d'API. Les jetons d'accès expirent, mais pas les jetons d'actualisation. Votre application peut utiliser un jeton d'actualisation pour acquérir un nouveau jeton d'accès.

ID client et code secret du client: Ces chaînes identifient de manière unique votre application et permettent d'obtenir des jetons. Ils sont créés pour votre projet dans la console API. Il existe trois types d'identifiants client, Veillez donc à obtenir le type approprié pour votre application:

ID client d'application Web
ID client des applications installées
ID client de compte de service

Exemples

Cette section présente des exemples d'utilisation simple d'API sans autorisation. Pour en savoir plus sur les appels d'autorisation, consultez les Page OAuth 2.0 pour .NET

Exemple d'API simple

Cet exemple utilise un accès simple aux API pour une application de ligne de commande. Elle appelle la méthode API Google Discovery pour répertorier toutes les API Google.

Exemple de configuration

Obtenez votre clé API Simple. Pour trouver la clé API de votre application, procédez comme suit:

Ouvrez la page Identifiants dans la console API.
Deux types d'identifiants sont disponibles pour cette API. Créez les identifiants appropriés pour votre projet: <ph type="x-smartling-placeholder">
- OAuth 2.0 : chaque fois que votre application demande des données utilisateur privées, elle doit envoyer un jeton OAuth 2.0 en même temps que la requête. Votre application envoie d'abord un identifiant client, puis éventuellement un code secret du client pour obtenir un jeton. Vous pouvez générer des identifiants OAuth 2.0 pour des applications Web, des comptes de service ou des applications installées.
  
  Pour en savoir plus, consultez la documentation OAuth 2.0.
- Clés API : une demande qui ne fournit pas de jeton OAuth 2.0 doit envoyer une clé API. Cette clé identifie votre projet et vous donne accès à l'API, aux quotas et aux rapports.
  
  L'API propose plusieurs types de restrictions applicables aux clés API. Si la clé API que vous n'existe pas, créez une clé API dans la console cliquez sur Créer des identifiants > clé API. Vous pouvez restreindre la clé avant de l'utiliser en production. Pour ce faire, cliquez sur Restreindre la clé, puis sélectionnez Restrictions :

Pour sécuriser vos clés API, suivez les Bonnes pratiques pour utiliser des clés API en toute sécurité.

Exemple de code

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);
                }
            }
        }
    }
}

Conseils d'utilisation des clés API:

Pour utiliser un service spécifique, vous devez lui ajouter une référence. Par exemple, si vous souhaitez utiliser API Tasks installez son package NuGet, Google.Apis.Tasks.v1.
Pour créer une instance d'un service, il vous suffit d'appeler son constructeur. Exemple : new TasksService(new BaseClientService.Initializer {...});".
Toutes les méthodes d'un service se trouvent sur des ressources individuelles de l'objet de service lui-même. Le service de découverte dispose d'une ressource Apis, qui contient une méthode List. Lorsque vous appelez service.Apis.List(..), un objet de requête ciblant cette méthode est renvoyé.
Pour exécuter une requête, appelez la méthode Execute() ou ExecuteAsyc() dans une requête.
Définissez la clé API à l'aide de la propriété ApiKey sur l'instance BaseClientService.Initializer.

Trouver des informations sur les API

La API compatibles répertorie toutes les API accessibles à l'aide de cette bibliothèque, ainsi que des liens vers la documentation.

Vous pouvez également utiliser APIs Explorer pour parcourir les API, lister les méthodes disponibles et même essayer des appels d'API depuis votre navigateur.