Premiers pas

Vous pouvez utiliser l'API SOAP Google Ad Manager pour créer des applications qui gèrent l'inventaire, créent des ordres, extraient des rapports et plus encore.

Pour vous aider à vous lancer, nous proposons des bibliothèques clientes pour Java, .NET, Python, PHP et Ruby.

Pour effectuer votre première requête API, procédez comme suit :

Accéder à un réseau Ad Manager

Si vous n'en possédez pas déjà un, créez un compte Ad Manager. Vous pouvez également créer un réseau de test si vous souhaitez tester l'API dans un environnement distinct. Notez que vous n'avez pas besoin de compte AdSense pour les tests.

Notez votre code réseau. Vous le trouverez dans l'URL lorsque vous vous connecterez à votre réseau. Par exemple, dans l'URL https://admanager.google.com/1234#home, 1234 correspond à votre code réseau.

Remarque : En accédant à l'API Ad Manager ou en l'utilisant, vous acceptez les Conditions d'utilisation.

Créer des identifiants d'authentification

Vous devez authentifier toutes les requêtes de l'API SOAP Ad Manager à l'aide d'OAuth 2.0. Les étapes suivantes couvrent le cas d'utilisation de l'accès à vos propres données Ad Manager. Pour en savoir plus et découvrir d'autres options, consultez Authentification.

1. Ouvrez la page Identifiants de la console Google API.

2. Dans le menu du projet, sélectionnez Créer un projet, saisissez un nom pour le projet et, si vous le souhaitez, modifiez l'ID du projet fourni. Cliquez sur Créer.

3. Sur la page "Identifiants", sélectionnez Créer des identifiants, puis Clé de compte de service.

4. Sélectionnez Nouveau compte de service, puis JSON comme type de clé.

5. Cliquez sur Créer pour télécharger un fichier contenant une clé privée.

Configurer votre réseau Ad Manager

1. Connectez-vous à Google Ad Manager.

2. Dans la barre latérale, cliquez sur Admin > Paramètres généraux.

3. Sous Paramètres généraux > Accès à l'API, cliquez sur le curseur pour activer l'accès.

4. Cliquez sur le bouton Enregistrer en bas de la page.

Configurer votre client

Téléchargez l'une des bibliothèques clientes Ad Manager. Les bibliothèques proposent des fonctions et des fonctionnalités d'encapsulation qui facilitent et accélèrent le développement d'applications.

Les onglets suivants fournissent des guides de démarrage rapide pour coder dans chacun des langages pour lesquels une bibliothèque cliente est disponible.

Java

Voici un exemple de base qui montre comment utiliser la bibliothèque cliente Java. Pour obtenir des informations plus détaillées sur l'utilisation, consultez le fichier README dans la distribution de la bibliothèque cliente.

1. Configurer vos identifiants

   Exécutez la commande suivante dans un shell :

   curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties

   Ouvrez le fichier ~/ads.properties et renseignez les champs suivants :

   [...]
   api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE
   api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE
   api.admanager.networkCode=INSERT_NETWORK_CODE_HERE
   [...]

2. Spécifier des dépendances

   Modifiez votre fichier pom.xml et ajoutez les éléments suivants à la balise dependencies. Vous trouverez le dernier numéro de version sur GitHub.

   <dependency>
     <groupId>com.google.api-ads</groupId>
     <artifactId>ads-lib</artifactId>
     <version>RELEASE</version>
   </dependency>
   <dependency>
     <groupId>com.google.api-ads</groupId>
     <artifactId>dfp-axis</artifactId>
     <version>RELEASE</version>
   </dependency>

3. Écrivez du code et envoyez une requête !

   import com.google.api.ads.common.lib.auth.OfflineCredentials;
   import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
   import com.google.api.ads.admanager.axis.factory.AdManagerServices;
   import com.google.api.ads.admanager.axis.v202608.Network;
   import com.google.api.ads.admanager.axis.v202608.NetworkServiceInterface;
   import com.google.api.ads.admanager.lib.client.AdManagerSession;
   import com.google.api.client.auth.oauth2.Credential;
   
   public class App {
     public static void main(String[] args) throws Exception {
       Credential oAuth2Credential = new OfflineCredentials.Builder()
           .forApi(Api.AD_MANAGER)
           .fromFile()
           .build()
           .generateCredential();
   
       // Construct an AdManagerSession.
       AdManagerSession session = new AdManagerSession.Builder()
           .fromFile()
           .withOAuth2Credential(oAuth2Credential)
           .build();
   
       // Construct a Google Ad Manager service factory, which can only be used once per
       // thread, but should be reused as much as possible.
       AdManagerServices adManagerServices = new AdManagerServices();
   
       // Retrieve the appropriate service
       NetworkServiceInterface networkService = adManagerServices.get(session,
           NetworkServiceInterface.class);
   
       // Make a request
       Network network = networkService.getCurrentNetwork();
   
       System.out.printf("Current network has network code '%s' and display" +
           " name '%s'.%n", network.getNetworkCode(), network.getDisplayName());
     }
   }

   Afficher sur GitHub

Python

Voici un exemple de base qui montre comment utiliser la bibliothèque cliente Python. La bibliothèque cliente Python est compatible avec Python 3.6 et versions ultérieures. Pour en savoir plus sur son utilisation, consultez le fichier README dans la distribution de la bibliothèque cliente.

1. Installez la bibliothèque et configurez vos identifiants.

   Exécutez les commandes suivantes dans un shell :

   python3 -m pip install googleads
   curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \
        -o ~/googleads.yaml

2. Configurez votre fichier ~/googleads.yaml.

   Renseignez les champs suivants :

   ad_manager:
     application_name: INSERT_APPLICATION_NAME_HERE
     network_code: INSERT_NETWORK_CODE_HERE
     path_to_private_key_file: INSERT_PATH_TO_FILE_HERE

3. Exécutez du code et envoyez une requête.

   # Import the library.
   from googleads import ad_manager
   
   # Initialize a client object, by default uses the credentials in ~/googleads.yaml.
   client = ad_manager.AdManagerClient.LoadFromStorage()
   
   # Initialize a service.
   network_service = client.GetService('NetworkService', version='v202608')
   
   # Make a request.
   current_network = network_service.getCurrentNetwork()
   
   print("Current network has network code '%s' and display name '%s'." %
           (current_network['networkCode'], current_network['displayName']))

   Afficher sur GitHub

PHP

Voici un exemple de base qui montre comment utiliser la bibliothèque cliente PHP.

1. Installez la bibliothèque et configurez vos identifiants.

   Exécutez les commandes suivantes dans un shell pour installer la bibliothèque cliente et télécharger le fichier adsapi_php.ini dans votre répertoire d'accueil :

   composer require googleads/googleads-php-lib
   curl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini

2. Configurez votre fichier ~/adsapi_php.ini.

   Renseignez les champs suivants :

   [AD_MANAGER]
   networkCode = "INSERT_NETWORK_CODE_HERE"
   applicationName = "INSERT_APPLICATION_NAME_HERE"
   
   [OAUTH2]
   jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE"
   scopes = "https://www.googleapis.com/auth/dfp"

3. Exécutez du code et envoyez une requête !
   Cet exemple de code doit être exécuté à partir de la ligne de commande, et non d'un navigateur. Le fichier contenant ce code doit se trouver à la racine du répertoire du projet, où composer require a été exécuté.

   <?php
   require 'vendor/autoload.php';
   use Google\AdsApi\AdManager\AdManagerSession;
   use Google\AdsApi\AdManager\AdManagerSessionBuilder;
   use Google\AdsApi\AdManager\v202608\ApiException;
   use Google\AdsApi\AdManager\v202608\ServiceFactory;
   use Google\AdsApi\Common\OAuth2TokenBuilder;
   
   // Generate a refreshable OAuth2 credential for authentication.
   $oAuth2Credential = (new OAuth2TokenBuilder())
       ->fromFile()
       ->build();
   // Construct an API session configured from a properties file and the OAuth2
   // credentials above.
   $session = (new AdManagerSessionBuilder())
       ->fromFile()
       ->withOAuth2Credential($oAuth2Credential)
       ->build();
   
   // Get a service.
   $serviceFactory = new ServiceFactory();
   $networkService = $serviceFactory->createNetworkService($session);
   
   // Make a request
   $network = $networkService->getCurrentNetwork();
   printf(
       "Network with code %d and display name '%s' was found.\n",
       $network->getNetworkCode(),
       $network->getDisplayName()
   );

   Afficher sur GitHub

.NET

Voici un exemple de base qui montre comment utiliser la bibliothèque cliente .NET.

1. Créer un projet

   Ouvrez Visual Studio et créez un projet (application console).

2. Ajouter les références de bibliothèque requises à votre projet

   Ajoutez une dépendance NuGet pour Google.Dfp.

3. Configurer votre fichier App.config

   Copiez src\App.config dans le répertoire de votre projet et ajoutez-le à votre projet. Si votre application possède son propre fichier App.config, vous pouvez y copier les nœuds suivants :

   • configuration/AdManagerApi
   • configuration/configSections/section[name="AdManagerApi"]
   • configuration/system.net
4. Configurer les identifiants

   Ouvrez App.config et modifiez les clés suivantes :

   <add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" />
   <add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" />
   <add key="OAuth2Mode" value="SERVICE_ACCOUNT" />
   <add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />

5. Passer un appel à la bibliothèque

   Vous pouvez appeler la bibliothèque comme indiqué dans l'extrait de code C# suivant.

   Afficher sur GitHub

   AdManagerUser user = new AdManagerUser();
         using (InventoryService inventoryService = user.GetService<InventoryService>())
               {
                   // Create a statement to select ad units.
                   int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT;
                   StatementBuilder statementBuilder =
                       new StatementBuilder().OrderBy("id ASC").Limit(pageSize);
   
                   // Retrieve a small amount of ad units at a time, paging through until all
                   // ad units have been retrieved.
                   int totalResultSetSize = 0;
                   do
                   {
                       AdUnitPage page =
                           inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement());
   
                       // Print out some information for each ad unit.
                       if (page.results != null)
                       {
                           totalResultSetSize = page.totalResultSetSize;
                           int i = page.startIndex;
                           foreach (AdUnit adUnit in page.results)
                           {
                               Console.WriteLine(
                                   "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++,
                                   adUnit.id, adUnit.name);
                           }
                       }
   
                       statementBuilder.IncreaseOffsetBy(pageSize);
                   } while (statementBuilder.GetOffset() < totalResultSetSize);
   
                   Console.WriteLine("Number of results found: {0}", totalResultSetSize);
               }
           

Si vous ne souhaitez pas définir vos identifiants dans votre fichier App.config, consultez cet article du wiki pour découvrir d'autres façons d'utiliser la classe AdManagerUser. Pour en savoir plus sur l'utilisation de la bibliothèque cliente .NET, consultez le fichier README . Si vous souhaitez développer en .NET sans la bibliothèque cliente, veuillez consulter l'article wiki NoClientLibrary.

Ruby

Voici un exemple de base qui montre comment utiliser la bibliothèque cliente Ruby. La bibliothèque cliente Ruby nécessite Ruby 2.1 ou une version ultérieure.

1. Installez le gem Ruby et obtenez le fichier de configuration.

   Exécutez les commandes suivantes dans un shell :

   gem install google-dfp-api
   curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml

   Si vous rencontrez une erreur telle que "cannot load such file -- mkmf (LoadError)" à un moment donné lors de l'installation de vos gems, vous devrez peut-être installer des bibliothèques de développement Ruby supplémentaires telles que ruby-dev, ruby-devel, xcode-select, etc. pour votre environnement spécifique.
2. Configurer vos identifiants

   Remplissez les champs obligatoires du fichier ~/ad_manager_api.yml. Si vous ne possédez pas encore de fichier de clés OAuth2, vous devez suivre la procédure pour créer vos identifiants OAuth2.

   :authentication:
     :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
     :application_name: INSERT_APPLICATION_NAME_HERE
     :network_code: INSERT_NETWORK_CODE_HERE

3. Écrivez du code et envoyez une requête !

   # Import the library.
   require 'ad_manager_api'
   
   # Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default).
   ad_manager = AdManagerApi::Api.new
   
   # Get a service instance.
   network_service = ad_manager.service(:NetworkService, :v202608)
   
   # Make a request.
   network = network_service.get_current_network()
   
   puts "The current network is %s (%d)." %
           [network[:display_name], network[:network_code]]

   Afficher sur GitHub

Vous trouverez des instructions plus détaillées pour vous lancer dans le fichier README distribué avec la bibliothèque cliente Ruby. Consultez également notre bibliothèque d'exemples complets pour Ruby.

Étapes suivantes

Une fois que vous avez une bibliothèque cliente opérationnelle, modifiez les exemples fournis pour les adapter à vos besoins.

Parcourez la documentation de référence pour en savoir plus sur l'API.

Si vous avez besoin d'aide, consultez notre page d'assistance.