Votre première application: conditions préalables
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Avant de pouvoir commencer à coder votre première application cliente, vous devez suivre quelques é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 d'autorisations appropriées accordées à ce compte depuis Search Ads 360:
Si vous n'avez pas encore de compte Google,
créez-en un.
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 de l'autorisation de consultation pour les annonceurs avec lesquels vous collaborerez.
Pour ajouter ou modifier des conversions, vous devez disposer d'un accès en modification pour les annonceurs avec lesquels vous collaborerez. 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'avoir accès à l'annonceur parent ni aux annonceurs enfants dans lesquels vous n'importez pas de données de conversion. Si vous utilisez des ID de clic pour attribuer des conversions aux visites, assurez-vous d'être autorisé à modifier 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 échouera.
Le responsable d'agence peut configurer votre compte en tant qu'utilisateur annonceur avec un accès à des annonceurs spécifiques ou configurer votre compte avec un niveau d'accès plus élevé (par exemple, Utilisateur d'agence) avec un accès à tous les annonceurs de l'agence.
Activer le service de conversion de l'API
Pour importer des données sur les conversions, un utilisateur Search Ads 360 disposant des droits 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
- Lancez l'
outil de configuration de la console Google APIs.
L'outil de configuration vous guide tout au long de la création d'un projet (ou de l'utilisation d'un projet existant), de l'activation de l'API Search Ads 360 et de la création d'identifiants OAuth 2.0.
- Sur la page Enregistrer votre application, sélectionnez un projet existant ou sélectionnez Créer un projet. Cliquez ensuite sur Continuer.
- Une fois que la Google API Console a activé l'API Search Ads 360, cliquez sur le bouton Accéder aux identifiants.
- 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
- Cliquez sur le bouton Suivant.
L'outil de configuration vous propose désormais de créer un ID client OAuth 2.0.
- Suivez le reste des étapes dans l'outil de configuration.
Installer sa360Api.py
Search Ads 360 fournit un script utilitaire pour faciliter la configuration de l'autorisation. 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 de code JSON sur ce site de documentation et les saisir directement dans le script.
Pour installer le script:
- Installez Python 2.7.
Le script ne fonctionne pas avec Python 3.x.
- Installez cURL.
- Téléchargez sa360Api.zip.
- Extrayez
sa360Api.py de sa360Api.zip.
- 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 l'architecture REST.
REST est 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'architecture utilisant des 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 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 comme POST, GET, PUT ou DELETE. La ressource est désignée 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 mappées directement 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 les corps de requête. 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.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/11/07 (UTC).
[null,null,["Dernière mise à jour le 2024/11/07 (UTC)."],[[["\u003cp\u003eBefore using the Search Ads 360 API, ensure you have a Google Account with the necessary Search Ads 360 permissions, which may include view or edit access to specific advertisers.\u003c/p\u003e\n"],["\u003cp\u003eTo upload conversion data, the API Conversion Service must be activated by a Search Ads 360 user with Agency Manager privileges.\u003c/p\u003e\n"],["\u003cp\u003eSet up a Google API Console project and obtain OAuth credentials for your client application to authenticate and authorize API access.\u003c/p\u003e\n"],["\u003cp\u003eInstall the provided \u003ccode\u003esa360Api.py\u003c/code\u003e utility script and familiarize yourself with REST and JSON basics if you plan to interact with the API directly without client libraries.\u003c/p\u003e\n"]]],["To start coding, create a Google Account and request Search Ads 360 permissions from an Agency Manager, who will grant view or edit access to advertisers. Activate the API conversion service via the Search Ads 360 UI. Next, create a Google API Console project and OAuth 2.0 credentials. Install Python 2.7, cURL, and the `sa360Api.py` utility script. Finally, understand REST basics and JSON formatting, crucial for interacting with the API using HTTP requests.\n"],null,["# Your First App: Prerequisites\n\nBefore you can start coding your first client application, there are a few things you\nneed to do, if you haven't done them already.\n\nCreate a Google Account and get Search Ads 360 permissions\n----------------------------------------------------------\n\nTo use the Search Ads 360 API, you need a Google Account and appropriate permissions\ngranted to that account from Search Ads 360:\n\n1. If you don't already have a Google Account, [create one](https://support.google.com/accounts/answer/27441).\n\n2. Ask a Search Ads 360 **Agency Manager** to [create a Search Ads 360 user](https://support.google.com/searchads/answer/6051717) for your Google Account.\n\n To download reports, you'll need **view permission** for the advertisers\n you'll be working with.\n\n To add or edit conversions, you'll need **edit permission** for the advertisers\n you'll be working with. In a\n [shared Floodlight configuration](https://support.google.com/searchads/answer/2458167),\n you need edit permission for each child advertiser you want to upload conversions into.\n You don't need access to the parent advertiser, nor do you need access to child advertisers\n that you're not uploading conversions into. If you use click IDs to\n [attribute\n conversions to visits](/search-ads/v2/how-tos/conversions/insert#attribute-a-conversion-to-a-specific-visit), make sure you have edit access to the advertiser that generated\n the click ID. If you specify a click ID from an advertiser you don't have edit access to,\n the request will not succeed.\n\n The Agency Manager can set up your account as an **Advertiser user** with\n access to specific advertisers,\n or set up your account with a higher level of access such as **Agency user**\n with access to all advertisers in the agency.\n\nActivate the API Conversion Service\n-----------------------------------\n\n\nIf you want to upload data about conversions, a Search Ads 360 user with **Agency\nManager** privileges needs to sign in to the Search Ads 360 UI and\n**activate the API conversion service** . See the\n[Search Ads 360\nhelp center](https://support.google.com/searchads/answer/2604604#activate) for instructions.\n\nCreate a Google API Console project and OAuth credentials for your client\n-------------------------------------------------------------------------\n\n1. Start the Google API Console [setup tool](https://console.cloud.google.com/start/api?id=doubleclicksearch&credential=client_key). \n The setup tool guides you through creating a project (or using an existing project), enabling the Search Ads 360 API, and creating OAuth 2.0 credentials.\n2. On the **Register your application** page, select an existing project or select **Create a project** . Then click **Continue**.\n3. After the Google API Console enables the Search Ads 360 API, click the **Go to credentials** button.\n4. On the **Create credentials** page, enter the following information:\n - **Which API are you using?**: Search Ads 360 API\n - **What data will you be accessing?**: User data\n5. Click the **Next** button.\n\n The setup tool now offers to help you create an **OAuth 2.0 client ID**.\n6. Follow the rest of the steps in the setup tool.\n\nInstall sa360Api.py\n-------------------\n\nSearch Ads 360 provides a utility script to facilitate the process of setting up\nauthorization. You can also use this script to send and receive data in the JSON format,\nif you want to try sending and receiving data before you design and write a full\napplication. You can copy many of the JSON examples in this documentation site and input\nthem directly to the script.\n\nTo install the script:\n\n1. [Install Python](http://www.python.org/getit/) 2.7. \n The script does not work with Python 3.x.\n2. [Install cURL](http://curl.haxx.se/download.html).\n3. [Download sa360Api.zip](https://www.google.com/help/hc/downloads/sa360/sa360Api.zip).\n4. Extract `sa360Api.py` from `sa360Api.zip`.\n5. Make `sa360Api.py` executable.\n\nLearn REST basics\n-----------------\n\nThere are two ways to invoke the API:\n\n- Using [client libraries](/search-ads/v2/libraries).\n- Sending HTTP requests and parsing the responses.\n\nIf you decide not to use client libraries, you'll need to understand the basics of\nREST.\n\nREST is a style of software architecture that provides a convenient and consistent approach to requesting and modifying data.\n\nThe term REST is short for \"[Representational State Transfer](https://en.wikipedia.org/wiki/Representational_state_transfer).\" In the context of Google APIs, it refers to using HTTP verbs to retrieve and modify representations of data stored by Google.\n\nIn a RESTful system, resources are stored in a data store; a client sends a request that the server perform a particular action (such as creating, retrieving, updating, or deleting a resource), and the server performs the action and sends a response, often in the form of a representation of the specified resource.\n\nIn Google's RESTful APIs, the client specifies an action using an HTTP verb such as `POST`, `GET`, `PUT`, or `DELETE`. It specifies a resource by a globally-unique URI of the following form: \n\n```\nhttps://www.googleapis.com/apiName/apiVersion/resourcePath?parameters\n```\n\nBecause all API resources have unique HTTP-accessible URIs, REST enables data caching and is optimized to work with the web's distributed infrastructure.\n\nYou may find the [method definitions](https://tools.ietf.org/html/rfc7231#section-4.3) in the HTTP 1.1 standards documentation useful; they include specifications for `GET`, `POST`, `PUT`, and `DELETE`.\n\n### REST in the Search Ads 360 API\n\nThe Search Ads 360 API operations map directly to REST HTTP verbs.\n\nThe specific format for Search Ads 360 API URIs is: \n\n```\nhttps://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters\n```\n\n\nThe full set of URIs used for each supported operation in the API is summarized in the [API Reference](/search-ads/v2/reference).\n\nLearn JSON basics\n-----------------\n\nIf you use REST, you'll need to use the JSON format for the request bodies. You can\nspecify that the responses be either in the JSON or CSV format.\n\n\n[JSON](http://en.wikipedia.org/wiki/JSON) (JavaScript Object Notation) is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see [json.org](http://www.json.org/).\n\n\u003cbr /\u003e"]]
