Votre première application: prérequis

Avant de commencer à coder votre première application cliente, vous devez suivre certaines étapes (si ce n'est déjà fait).

Créer un compte Google et obtenir les autorisations Search Ads 360

Pour utiliser l'API Search Ads 360, vous devez disposer d'un compte Google et des autorisations appropriées accordées à ce compte depuis Search Ads 360:

  1. Si vous ne possédez pas encore de compte Google, créez-en un.

  2. Demandez à un responsable d'agence Search Ads 360 de créer un utilisateur Search Ads 360 pour votre compte Google.

    Pour télécharger des rapports, vous devez disposer d'une autorisation d'affichage pour les annonceurs avec lesquels vous allez travailler.

    Pour ajouter ou modifier des conversions, vous devez disposer des droits de modification pour les annonceurs avec lesquels vous allez travailler. Dans le cas d'une configuration Floodlight partagée, vous devez disposer de droits de modification pour chaque annonceur enfant dans lequel vous souhaitez importer des conversions. Vous n'avez pas besoin d'accéder à l'annonceur parent ni aux annonceurs enfants dans lesquels vous n'importez pas de conversions. Si vous utilisez des ID de clic pour attribuer des conversions aux visites, assurez-vous de disposer d'un accès en modification à l'annonceur qui a généré l'ID de clic. Si vous spécifiez un ID de clic issu d'un annonceur que vous n'êtes pas autorisé à modifier, la demande n'aboutira pas.

    Le responsable d'agence peut configurer votre compte en tant qu'utilisateur d'un annonceur avec un accès spécifique à certains annonceurs ou via un niveau d'accès plus élevé (par exemple, utilisateur d'agence) pour tous les annonceurs de l'agence.

Activer le service de conversion de l'API

Si vous souhaitez importer des données sur les conversions, un utilisateur Search Ads 360 disposant des privilèges Responsable agence doit se connecter à l'interface utilisateur de Search Ads 360 et activer le service de conversion de l'API. Pour obtenir des instructions, consultez le Centre d'aide Search Ads 360.

Créer un projet dans la console Google APIs et des identifiants OAuth pour votre client

  1. Lancez l'outil de configuration de la console Google APIs.
    L'outil de configuration vous guide pour créer un projet (ou utiliser un projet existant), activer l'API Search Ads 360 et créer des identifiants OAuth 2.0.
  2. Sur la page Enregistrer votre application, sélectionnez un projet existant ou Créer un projet. Cliquez ensuite sur Continuer.
  3. Une fois que la console Google APIs a activé l'API Search Ads 360, cliquez sur le bouton Accéder aux identifiants.
  4. Sur la page Créer des identifiants, saisissez les informations suivantes :
    • Quelle API utilisez-vous ? L'API Google Marketing Platform Search
    • À quelles données allez-vous accéder ? Données utilisateur
  5. Cliquez sur le bouton Suivant.

    L'outil de configuration vous permet désormais de créer un ID client OAuth 2.0.

  6. Suivez le reste des étapes dans l'outil de configuration.

Installer sa360Api.py

Search Ads 360 fournit un script utilitaire facilitant le processus de configuration des autorisations. Vous pouvez également utiliser ce script pour envoyer et recevoir des données au format JSON si vous souhaitez essayer d'envoyer et de recevoir des données avant de concevoir et d'écrire une application complète. Vous pouvez copier de nombreux exemples JSON sur ce site de documentation et les saisir directement dans le script.

Pour installer le script:

  1. Installez Python 2.7.
    Le script ne fonctionne pas avec Python 3.x.
  2. Installez cURL.
  3. Téléchargez sa360Api.zip.
  4. Extraire sa360Api.py de sa360Api.zip.
  5. Rendez sa360Api.py exécutable.

Apprendre les bases de l'architecture REST

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

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

Il s'agit d'un style d'architecture logicielle qui permet de demander et modifier des données de manière pratique et cohérente.

Le terme REST est l'acronyme de Representational State Transfer. Dans le contexte des API Google, il désigne l'utilisation de verbes HTTP pour extraire et modifier des représentations de données stockées par Google.

Dans un système RESTful, les ressources sont stockées dans un datastore. Un client envoie une requête pour que le serveur exécute une action spécifique (par exemple la création, l'extraction, la mise à jour ou la suppression d'une ressource), et le serveur exécute l'action et envoie une réponse, souvent sous la forme d'une représentation de la ressource spécifiée.

Dans les API RESTful de Google, le client spécifie une action à l'aide d'un verbe HTTP tel que POST, GET, PUT ou DELETE. Elle spécifie une ressource par un URI unique au format suivant:

https://www.googleapis.com/apiName/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éthode figurant dans la documentation du standard HTTP 1.1 peuvent s'avérer utiles, car elles incluent les spécifications pour GET, POST, PUT, et DELETE.

REST dans l'API Search Ads 360

Les opérations de l'API Search Ads 360 sont directement mappées aux verbes HTTP REST.

Le format spécifique pour les URI de l'API Search Ads 360 est le suivant:

https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters

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

Apprendre les bases du format JSON

Si vous utilisez REST, vous devez utiliser le format JSON pour le corps des requêtes. Vous pouvez spécifier que les réponses sont au format JSON ou CSV.

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