L'API Verifications et l'API Business Information sont désormais disponibles. Vous devez suivre le processus de migration. Pour plus d'informations sur les points de terminaison obsolètes, veuillez consulter notre planning d'abandon. Vous pouvez également vous inscrire à notre liste de diffusion pour recevoir des informations.

Configuration de base

Avant de continuer, assurez-vous d'avoir suivi les étapes de la section Conditions préalables et que votre projet est autorisé à accéder à l'API Google My Business.

Activer les API

À l'heure actuelle, vous devez activer sept API associées à Google My Business dans la console Google APIs :

  • API Google My Business
  • API My Business Account Management
  • API My Business Lodging
  • API My Business Place Actions
  • API My Business Notifications
  • API My Business Verifications
  • API My Business Business Information

Activer l'API

Si vous avez suivi toutes les étapes de la section Conditions préalables et si des droits d'accès à l'API vous ont été accordés, mais que vous n'avez pas pu utiliser le raccourci fourni, vous pouvez activer l'API manuellement en suivant la procédure ci-dessous.

Pour activer une API pour votre projet, procédez comme suit :

  1. Dans la console Google APIs, ouvrez la bibliothèque des API. Si vous y êtes invité, sélectionnez un projet ou créez-en un. La bibliothèque des API répertorie toutes les API disponibles, regroupées par famille de produits et classées en fonction de leur popularité.
  2. Si l'API que vous souhaitez activer n'apparaît pas dans la liste, utilisez la recherche pour la trouver.
  3. Sélectionnez l'API que vous souhaitez activer, puis cliquez sur le bouton Activer.
  4. Si vous y êtes invité, activez la facturation.
  5. Si vous y êtes invité, acceptez les conditions d'utilisation de l'API.

Demander un ID client OAuth 2.0

Vous devez disposer d'un ID client OAuth 2.0, car votre application accède à des données protégées et non publiques. Cela permet à votre application de demander l'autorisation d'accéder aux données de localisation de votre organisation pour le compte de ses utilisateurs.

Votre application doit envoyer un jeton OAuth 2.0 avec toute requête de l'API Google My Business qui accède à des informations confidentielles sur l'utilisateur.

Si vous ne l'avez pas déjà fait, accédez à la section "Identifiants" de la console Google APIs et cliquez sur Créer des identifiants > ID client OAuth pour créer vos identifiants OAuth 2.0. Une fois les identifiants créés, votre ID client s'affiche sur la page Identifiants. Cliquez sur l'ID client pour obtenir des détails, tels que le code secret du client, les URI de redirection, l'adresse d'origine JavaScript et l'adresse e-mail.

Apprendre les bases de l'architecture REST

Il existe deux façons d'appeler l'API :

Si vous décidez de ne pas utiliser des bibliothèques clientes, vous devez comprendre les principes de base de l'architecture REST.

REST est un style d'architecture logicielle qui fournit une approche pratique et cohérente pour demander et modifier des données.

Le terme REST est l'acronyme de Representational State Transfer. Dans le contexte des API Google, il fait référence à l'utilisation de verbes HTTP pour récupérer et modifier les représentations des données stockées par Google.

Dans un système RESTful, les ressources sont stockées dans un magasin de données. Un client envoie une requête au serveur pour effectuer une action particulière (par exemple, pour créer, récupérer, mettre à jour ou supprimer une ressource), et le serveur effectue l'action et envoie une réponse. Cette réponse prend souvent la forme d'une représentation de la ressource spécifiée.

Dans les API RESTful de Google, le client spécifie une action avec un verbe HTTP, tel que GET, POST, PUT ou DELETE. Le client spécifie une ressource par un identifiant de ressource uniforme globalement unique (URI) au format suivant :

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

Étant donné que toutes les ressources d'API possèdent des URI uniques accessibles via HTTP, REST permet la mise en cache des données, et son fonctionnement est optimisé pour l'infrastructure distribuée du Web.

Les définitions de méthodes, fournies dans la documentation sur les normes HTTP 1.1, peuvent vous être utiles. Elles incluent des spécifications pour GET, POST, PUT et DELETE.

REST dans les API Google My Business

Les opérations des API Google My Business correspondent directement aux verbes HTTP REST.

Le format spécifique des API Google My Business est indiqué dans l'URI suivant :

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

L'ensemble complet des URI utilisés pour chaque opération acceptée dans l'API est récapitulé dans la documentation de référence de l'API Google My Business.

Les chemins d'accès aux ressources varient selon le point de terminaison.

Par exemple, le chemin d'accès à la ressource d'un compte s'affiche comme dans l'exemple suivant :

accounts/accountId

Le chemin d'accès à la ressource d'un établissement apparaît au format suivant :

locations/locationId

Apprendre les bases du format JSON

L'API Google My Business affiche les données au format JSON.

JavaScript Object Notation (JSON) est un format de données commun qui ne dépend pas du langage et qui fournit une représentation textuelle simple de structures de données arbitraires. Pour en savoir plus, accédez à json.org.

Envoyer une requête HTTP simple

Vous pouvez tester l'API Google My Business sur la plate-forme OAuth 2.0 Playground. L'API Google My Business n'étant pas une API publique, vous devez compléter quelques étapes supplémentaires pour l'utiliser dans Playground. Avant de vous lancer, assurez-vous de disposer d'un ID client pour une application Web.

  1. Ouvrez votre projet dans la console Google APIs. Si vous ne possédez pas d'ID client OAuth pour les applications Web, créez-en un maintenant :
    1. Dans la liste déroulante Créer des identifiants, sélectionnez ID client OAuth.
    2. Dans le champ Type d'application, cliquez sur Application Web.
    3. Ajoutez l'élément suivant en tant qu'URI de redirection valide :

       https://developers.google.com/oauthplayground
       
    4. Cliquez sur Créer.
  2. Copiez l'ID client dans le presse-papiers.
  3. Accédez à l'outil OAuth 2.0 Playground.
  4. Cliquez sur l'icône en forme de roue dentée pour ouvrir les options de configuration, puis apportez les modifications suivantes :
    1. Définissez OAuth flow (flux OAuth) sur Client-side (côté client).
    2. Cochez la case Use your own OAuth credentials (Utiliser vos propres identifiants OAuth).
    3. Dans le champ "OAuth Client ID", collez votre ID client OAuth.
  5. Fermez les options de configuration.
  6. Sous "Step 1 – Select & authorize APIs" (Étape 1 – Sélectionner et autoriser des API"), collez le champ d'application suivant pour l'API Google My Business dans le champ Input your own scopes (Saisir vos propres champs d'application) :

    https://www.googleapis.com/auth/business.manage
    
  7. Cliquez sur Authorize APIs (Autoriser les API).
  8. Lorsque vous y êtes invité, cliquez sur Accept (Accepter).
  9. Sous "Step 2 – Configure request to API" (Étape 2 – Configurer la requête d'API), collez l'URI suivant dans le champ Request URI (URI de la demande) :

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
    
  10. Cliquez sur Send the request (Envoyer la requête). La réponse devrait afficher l'état 200 OK.

Pour en savoir plus sur les différents types de requêtes, consultez la documentation de référence de l'API Google My Business.

Bibliothèques clientes

Les bibliothèques clientes de l'API Google My Business sont compatibles avec les fonctionnalités de l'API Google My Business. Elles offrent des fonctionnalités communes à toutes les API Google, comme le transport HTTP, la gestion des erreurs, l'authentification et l'analyse JSON.

Vous pouvez télécharger des bibliothèques clientes à partir de la section Bibliothèques.