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

Exécuter des exemples de code

Google APIs Explorer génère dynamiquement des exemples de code. Ces exemples de code sont conçus pour être copiés et exécutés localement. Pour afficher les exemples, cliquez sur Plein écran dans le panneau latéral de l'explorateur d'API. La figure ci-dessous présente l'explorateur d'API plein écran développé:

**Figure 2**: Panneau plein écran d'APIs Explorer pour l'API Google Livres

Par défaut, APIs Explorer vous montre comment utiliser cURL pour exécuter votre requête. Certaines API peuvent également afficher des exemples pour d'autres langages, tels que JavaScript, Java et Python.

Exécuter des exemples de code localement

Les onglets suivants expliquent les conditions préalables et les étapes à suivre pour exécuter des exemples de code. Pour exécuter les exemples de code, vous devez générer et utiliser vos propres identifiants d'autorisation. Pour savoir comment créer un projet et générer des identifiants, consultez la documentation de votre API Google.

Les identifiants sont l'un des suivants, selon le type de données (publiques ou privées) auquel la méthode accède:

Pour les données publiques, les identifiants sont des clés API.
Pour les données privées, les identifiants sont soit un fichier client_secret.json contenant votre ID client OAuth 2.0 et son code secret, soit un jeton d'accès OAuth 2.0.

cURL

Configurer

Suivez les instructions de la documentation de l'API pour créer ou sélectionner un projet pour votre application et activer l'API.
Dans Cloud Console, créez une clé API.
Dans Cloud Console, créez des identifiants d'ID client OAuth pour une application Web et utilisez https://developers.google.com/oauthplayground comme URI de redirection.
Dans OAuth 2.0 Playground, cliquez sur OAuth 2.0 Configuration .
Cochez la case Use your own credentials (Utiliser vos propres identifiants).
Saisissez l'ID client et le code secret du client générés à l'étape 3.
Dans le champ "Champs d'application", saisissez le champ d'application à utiliser avec votre méthode et cliquez sur Authorize APIs (Autoriser les API).
(Facultatif) Si un écran de connexion s'affiche, sélectionnez le compte à utiliser.
(Facultatif) Si un écran d'autorisation s'affiche, cliquez sur Accepter.
Cliquez sur Échanger des codes d'autorisation contre des jetons. Un jeton est renvoyé.
Dans l'exemple de code cURL, remplacez [YOUR_API_KEY] par la clé API générée à l'étape 2 : 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
Dans l'exemple de code cURL, remplacez [YOUR_ACCESS_TOKEN] par le jeton d'accès généré à l'étape 10 : --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \.

Exécuter l'exemple de code

Depuis la ligne de commande, exécutez la commande cURL. La commande doit être semblable à celle-ci:

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

Configurer

Suivez les instructions de la documentation de l'API pour créer ou sélectionner un projet pour votre application et activer l'API.
Dans Cloud Console, créez une clé API.
Dans la console Cloud, créez un identifiant client OAuth pour une &application Web et définissez les origines JavaScript autorisées pour identifier l'URL à partir de laquelle vous allez envoyer des requêtes, par exemple http://localhost.
Copiez l'exemple de code complet dans un fichier local accessible à votre serveur Web, tel que /var/www/html/example.html.
Dans l'exemple de code, recherchez la ligne qui définit la clé API ou l'ID client, et remplacez la valeur par les valeurs générées aux étapes 2 et 3:
- Clé API : gapi.client.setApiKey(YOUR_API_KEY);
- ID client OAuth 2.0 : gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

Exécuter l'exemple de code

Ouvrez le fichier dans votre navigateur, par exemple http://localhost/example.html. Nous vous recommandons d'utiliser un navigateur doté d'une console de débogage, tel que Google Chrome.
(Facultatif) Si un écran de connexion s'affiche, sélectionnez le compte à utiliser.
(Facultatif) Si un écran d'autorisation s'affiche, cliquez sur Accepter. La console de débogage doit afficher la réponse de la méthode sous la forme d'un objet JSON.

Java

Prérequis

Java 1.7 ou version ultérieure
Gradle 7 ou version ultérieure.

Configurer

Suivez les instructions de la documentation de l'API pour créer ou sélectionner un projet pour votre application et activer l'API.
Selon le type de données auquel la méthode accède, créez une clé API (données publiques) ou un ID client OAuth 2.0 (données privées).
Définissez le type d'application sur Application de bureau.
Si vous avez créé un ID client OAuth 2.0, téléchargez le fichier JSON contenant vos identifiants OAuth 2.0. Ce fichier porte un nom semblable à client_secret_CLIENTID.json, où CLIENTID correspond à l'ID client de votre projet.
Dans votre répertoire de travail, exécutez les commandes suivantes pour créer une structure de projet:
```
$ gradle init --type basic
$ mkdir -p src/main/java src/main/resources
```
Si vous avez créé un ID client OAuth 2.0 à l'étape 2, renommez le fichier JSON que vous avez téléchargé en client_secret.json.
Enregistrez le fichier renommé dans le répertoire src/main/resources que vous avez créé à l'étape 5.

Dans votre répertoire de travail, ouvrez le fichier build.gradle et remplacez son contenu par le code suivant:

apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    API_SPECIFIC_DEPENDENCY
}

Dans le fichier build.gradle, remplacez la ligne API_SPECIFIC_DEPENDENCY par une instruction pour compiler le code de l'API que vous appelez. Voici un exemple pour l'API YouTube Analytics:
```
compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'
```
L'instruction suit ce modèle:
```
compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'
```

Où :

API_NAME est le nom de l'API répertorié sur GitHub. Pour trouver le nom, cliquez sur le lien de la version situé à côté de votre API sur la page API Google compatibles. Le lien de la version permet d'accéder à GitHub. Le nom de l'API se trouve en haut et au milieu de la page. Il est précédé de googleapis/google-apis-services-. Par exemple, pour la version 3 de l'API Drive, API_NAME est drive.
API_VERSION est la version de l'API répertoriée sous le nom de l'API sur la page des API Google compatibles.
REVISION est le numéro de révision indiqué dans la documentation de référence JavaDoc pour l'API. La référence JavaDoc est disponible sur https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
CL_VERSION est la version de la bibliothèque cliente. Cette valeur apparaît également dans la documentation de référence JavaDoc.
Depuis votre répertoire de travail, copiez l'exemple de code depuis APIs Explorer vers src/main/java/ApiExample.java. (Le nom de classe de chaque exemple est ApiExample. Vous n'avez donc pas besoin de modifier le fichier build.gradle pour exécuter différents exemples.

Exécuter l'exemple de code

Utilisez la commande suivante pour exécuter l'exemple:

  gradle -q run

L'exemple doit exécuter votre requête API et imprimer la réponse dans STDOUT. Vous pouvez également vérifier le service que vous appelez pour voir les effets des requêtes qui écrivent des données.

Node.js

Prérequis

Node.js
Bibliothèque cliente des API Google pour Node.js:
- Si vous n'avez pas encore installé la bibliothèque cliente, exécutez la commande suivante:
```
npm install googleapis --save
```
- Si vous avez déjà installé la bibliothèque cliente, nous vous recommandons de la mettre à jour pour vous assurer que vous disposez des classes les plus récentes pour la bibliothèque que vous testez. Pour mettre à jour la bibliothèque cliente, exécutez la commande suivante:
```
npm update googleapis --save
```

Configurer

Suivez les instructions de la documentation de l'API pour créer ou sélectionner un projet pour votre application et activer l'API.
Selon le type de données auquel la méthode accède, créez une clé API (données publiques) ou un ID client OAuth 2.0 (données privées).
Définissez le type d'application sur Application de bureau.
Si vous avez créé un ID client OAuth 2.0, téléchargez le fichier JSON contenant vos identifiants OAuth 2.0. Ce fichier porte un nom semblable à client_secret_CLIENTID.json, où CLIENTID correspond à l'ID client de votre projet.
Copiez l'exemple de code dans un fichier local et modifiez-le pour identifier correctement la clé API ou le fichier de secrets du client. Dans l'exemple, la valeur de clé API est YOUR_API_KEY et l'emplacement du fichier de secrets client est YOUR_CLIENT_SECRET_FILE.json.

Exécuter l'exemple de code

Utilisez la commande suivante pour exécuter l'exemple:

  node sample.js

La plupart des exemples impriment une réponse d'API (ou autre) à STDOUT.

PHP

Prérequis

PHP 5.4 ou version ultérieure avec l'interface de ligne de commande (CLI) et l'extension JSON
L'outil de gestion des dépendances Composer installé à l'échelle mondiale
La bibliothèque cliente des API Google pour PHP:
- Si vous n'avez pas encore installé la bibliothèque cliente, exécutez la commande suivante:
```
composer require google/apiclient:^2.0
```
- Si vous avez déjà installé la bibliothèque cliente, nous vous recommandons de la mettre à jour pour vous assurer que vous disposez des classes les plus récentes pour la bibliothèque que vous testez. Pour mettre à jour la bibliothèque cliente, exécutez la commande suivante:
```
composer update google/apiclient --with-dependencies
```

Exécuter l'exemple de code

Utilisez la commande suivante pour exécuter l'exemple:

  php sample.php

La plupart des exemples impriment une réponse d'API (ou autre) à STDOUT.

Python

Prérequis

Python 2.7 ou Python 3.5+
Outil de gestion des packages pip
La bibliothèque cliente des API Google pour Python:
```
pip install --upgrade google-api-python-client
```
Les bibliothèques google-auth-oauthlib et google-auth-httplib2 pour l'autorisation utilisateur:
```
pip install --upgrade google-auth-oauthlib google-auth-httplib2
```

Configurer

Suivez les instructions de la documentation de l'API pour créer ou sélectionner un projet pour votre application et activer l'API.
Selon le type de données auquel la méthode accède, créez une clé API (données publiques) ou un ID client OAuth 2.0 (données privées).
Définissez le type d'application sur Application de bureau.
Si vous avez créé un ID client OAuth 2.0, téléchargez le fichier JSON contenant vos identifiants OAuth 2.0. Ce fichier porte un nom semblable à client_secret_CLIENTID.json, où CLIENTID correspond à l'ID client de votre projet.
Copiez l'exemple de code dans un fichier local et modifiez-le pour identifier correctement la clé API ou le fichier de secrets du client. Dans l'exemple, la valeur de clé API est YOUR_API_KEY et l'emplacement du fichier de secrets client est YOUR_CLIENT_SECRET_FILE.json.

Exécuter l'exemple de code

Utilisez la commande suivante pour exécuter l'exemple:

  python sample.py

La plupart des exemples impriment une réponse d'API (ou autre) à STDOUT.

Ruby

Prérequis

Ruby 2.0 ou version ultérieure
La bibliothèque cliente des API Google pour Ruby:
```
gem install google-api-client`
```

Configurer

Suivez les instructions de la documentation de l'API pour créer ou sélectionner un projet pour votre application et activer l'API.
Selon le type de données auquel la méthode accède, créez une clé API (données publiques) ou un ID client OAuth 2.0 (données privées).
Définissez le type d'application sur Application de bureau.
Si vous avez créé un ID client OAuth 2.0, téléchargez le fichier JSON contenant vos identifiants OAuth 2.0. Ce fichier porte un nom semblable à client_secret_CLIENTID.json, où CLIENTID correspond à l'ID client de votre projet.
Copiez l'exemple de code dans un fichier local et modifiez-le pour identifier correctement la clé API ou le fichier de secrets du client. Dans l'exemple, la valeur de clé API est YOUR_API_KEY et l'emplacement du fichier de secrets client est YOUR_CLIENT_SECRET_FILE.json.

Exécuter l'exemple de code

Utilisez la commande suivante pour exécuter l'exemple:

  ruby sample.rb

La plupart des exemples impriment une réponse d'API (ou autre) à STDOUT.

Résoudre les problèmes de l'échantillon

La boîte de dialogue d'autorisation ne s'affiche pas

APIs Explorer utilise un pop-up pour autoriser l'accès à vos données privées. Si votre navigateur bloque les pop-ups, ce pop-up ne s'affichera pas et vous ne pourrez pas accorder l'accès.

Si rien ne se produit lorsque vous cliquez sur "Autoriser" dans l'écran d'autorisation, essayez de modifier les paramètres de la fenêtre pop-up du navigateur pour activer les fenêtres pop-up.

Vous avez reçu une erreur 401 ou 403.

Si une erreur 401 ou 403 s'affiche lorsque vous testez un échantillon, cela est probablement dû à l'un des problèmes suivants:

L'API n'est pas activée pour votre projet. Consultez les instructions concernant votre API pour découvrir comment créer un projet et activer une API.
Vous n'utilisez pas le bon type d'autorisation (clé API au lieu de OAuth 2.0).
Vous utilisez OAuth 2.0, mais le champ d'application est trop restreint.
Lorsque vous configurez votre clé API, vous définissez des restrictions pour empêcher toute utilisation non autorisée de vos identifiants. Toutefois, la demande ne respecte pas ces restrictions. Pour en savoir plus, consultez la page Utiliser des restrictions de clés API.

Vous avez reçu un avertissement concernant du contenu mixte

Si vous utilisez Google Cloud Endpoints et que vous exécutez votre point de terminaison sur un serveur de développement, votre navigateur peut afficher un avertissement concernant le contenu mixte. Cet avertissement s'affiche parce qu'APIs Explorer est chargé via HTTPS, mais lorsque votre API s'exécute localement, elle est hébergée sur HTTP.

Pour masquer cet avertissement dans Chrome, démarrez une session Chrome avec des options spéciales comme suit:

path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port

Exemple :

/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080

Vous ne devez masquer cet avertissement qu'à des fins de test local.

JavaScript uniquement: gapi n'est pas défini

Une erreur "gapi non définie" se produit lorsque le code JavaScript tente d'appeler la bibliothèque cliente des API Google pour JavaScript avant son chargement. Assurez-vous que votre code qui fait référence à la variable gapi n'est appelé qu'après le chargement de la bibliothèque cliente.