Commencer

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

L'API Google Ad Manager permet aux développeurs de créer des applications permettant de gérer l'inventaire, de créer des campagnes, de générer des rapports, etc.

L'API Ad Manager utilise le protocole SOAP. Pour vous aider à démarrer, nous proposons des bibliothèques clientes pour Java, .NET, Python, PHP et Ruby. Pour envoyer votre première requête API, procédez comme suit :

Accéder à un réseau Ad Manager

Si vous n'en avez pas, 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 d'un compte AdSense à des fins de test.

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

Créer des identifiants d'authentification

Vous devez authentifier toutes les demandes de l'API Ad Manager à l'aide du protocole OAuth2. Les étapes ci-dessous décrivent le cas d'utilisation simple d'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 APIs.
  2. Dans le menu du projet, sélectionnez Créer un projet, saisissez un nom pour le projet et modifiez éventuellement l'ID de projet fourni. Cliquez sur Créer.
  3. Sur la page "Identifiants", sélectionnez Créer des identifiants, puis sélectionnez Clé de compte de service.
  4. Sélectionnez Nouveau compte de service, puis choisissez le type de clé JSON.
  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 sur Activé.
  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 offrent des fonctions et des fonctionnalités de wrapper qui facilitent et accélèrent le développement d'applications.

Les onglets ci-dessous fournissent des guides de démarrage rapide pour le codage dans chacun des langages pour lesquels il existe une bibliothèque cliente.

Java

Voici un exemple de base montrant comment utiliser la bibliothèque cliente Java. Pour plus d'informations sur l'utilisation, reportez-vous au fichier README dans la distribution de la bibliothèque cliente.

  1. Configurer vos identifiants

    Exécutez la commande suivante dans une interface système:

    curl https://raw.githubusercontent.com/googleads/googleads-java-lib/master/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 les dépendances

    Modifiez le fichier pom.xml et ajoutez le code suivant à 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. Rédigez du code et faites une demande !

    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.v202211.Network;
    import com.google.api.ads.admanager.axis.v202211.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());
      }
    }
    

Python

Voici un exemple de base montrant comment utiliser la bibliothèque cliente Python. La bibliothèque cliente Python est compatible avec Python 3.6 ou version ultérieure. Pour obtenir des informations plus détaillées sur l'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 une interface système:

    pip install googleads
    curl https://raw.githubusercontent.com/googleads/googleads-python-lib/master/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 effectuez 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='v202211')
    
    # 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']))
    

PHP

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

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

    Exécutez les commandes suivantes dans une interface système 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/master/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 faites une demande !
    <?php
    require 'vendor/autoload.php';
    use Google\AdsApi\AdManager\AdManagerSession;
    use Google\AdsApi\AdManager\AdManagerSessionBuilder;
    use Google\AdsApi\AdManager\v202211\ApiException;
    use Google\AdsApi\AdManager\v202211\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()
    );
    

.NET

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

  1. Créer un projet

    Ouvrez Visual Studio et créez un projet (c'est-à-dire une 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 copier les nœuds suivants dans votre fichier App.config:

    • configuration/AdManagerApi
    • configuration/configSections/section[name=\"quot;AdManagerApi"]
    • configuration/system.net.
  4. Identifiants de configuration

    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. Appeler la bibliothèque

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

    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 App.config, reportez-vous à cet article 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 dans .NET sans la bibliothèque cliente, veuillez consulter l'article sur le wiki NoClientLibrary.

Ruby

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

  1. Installez le gem Ruby et récupérez le fichier de configuration.

    Exécutez les commandes suivantes dans une interface système:

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

  2. Configurer vos identifiants

    Renseignez les champs obligatoires dans le fichier ~/ad_manager_api.yml. Si vous n'avez pas encore de fichier de clé OAuth2, vous devez suivre la procédure permettant de 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. Rédigez du code et faites une demande !
    # 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, :v202211)
    
    # Make a request.
    network = network_service.get_current_network()
    
    puts "The current network is %s (%d)." %
            [network[:display_name], network[:network_code]]
    

Vous trouverez des étapes plus détaillées pour commencer dans le fichier README distribué avec la bibliothèque cliente Ruby. Consultez également notre exemple de bibliothèque complet pour Ruby.

Next Steps

Lorsque vous disposez d'une bibliothèque cliente opérationnelle, modifiez les exemples fournis pour les étendre à 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.