Cette page a été traduite par l'API Cloud Translation.

Premiers pas

Vous pouvez utiliser l'API Google Ad Manager pour créer des applications qui gèrent l'inventaire, créent des commandes, génèrent des rapports, etc.

L'API Ad Manager utilise le protocole SOAP. Pour vous aider à démarrer, nous mettons à votre disposition des bibliothèques clientes pour Java, .NET, Python, PHP et Ruby.

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

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 d'un compte AdSense à des fins de test.

Notez votre code de réseau. Vous la trouverez dans l'URL lorsque vous vous connectez à 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 d'OAuth 2.0. Les étapes ci-dessous décrivent le cas d'utilisation consistant à accéder à vos propres données Ad Manager. Pour en savoir plus et découvrir d'autres options, consultez la page Authentification.

Ouvrez la page "Identifiants" de la console Google APIs.
Dans le menu du projet, sélectionnez Créer un projet, saisissez un nom pour le projet et, éventuellement, modifiez l'ID de projet fourni. Cliquez sur Créer.
Sur la page "Identifiants", sélectionnez Créer des identifiants, puis Clé de compte de service.
Sélectionnez Nouveau compte de service, puis choisissez JSON comme type de clé.
Cliquez sur Créer pour télécharger un fichier contenant une clé privée.

Configurer votre réseau Ad Manager

Connectez-vous à Google Ad Manager.
Dans la barre latérale, cliquez sur Admin > Paramètres généraux.
Sous Paramètres généraux > Accès à l'API, cliquez sur le curseur sur Activé.
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 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 d'utilisation de la bibliothèque cliente Java. Pour obtenir des informations d'utilisation plus détaillées, consultez le fichier README dans la distribution de la bibliothèque cliente.

Configurer vos identifiants

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

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
[...]

Spécifier les dépendances

Modifiez le fichier pom.xml et ajoutez le code suivant à la balise dependencies. Le dernier numéro de version est disponible 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>

Écrivez 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.v202402.Network;
import com.google.api.ads.admanager.axis.v202402.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 illustrant comment utiliser la bibliothèque cliente Python. La bibliothèque cliente Python est compatible avec Python v3.6+. Pour des informations d'utilisation plus détaillées, consultez le fichier README dans la distribution de la bibliothèque cliente.

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/main/googleads.yaml \
     -o ~/googleads.yaml

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

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='v202402')

# 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 illustrant l'utilisation de la bibliothèque cliente PHP.

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/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
```

Configurer le 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"

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 depuis un navigateur. Le fichier contenant ce code doit se trouver à la racine du répertoire du projet, dans lequel 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\v202402\ApiException;
use Google\AdsApi\AdManager\v202402\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 montrant comment utiliser la bibliothèque cliente .NET.

Créer un projet
Ouvrez Visual Studio et créez un projet (application de la console).
Ajouter les références de bibliothèque requises à votre projet
Ajoutez une dépendance Nuget pour Google.Dfp.
Configurer un fichier App.config
Copiez src\App.config dans le répertoire de votre projet, puis 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

Configurer des 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" />

Appeler 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 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, consultez l'article wiki sur NoClientLibrary.

Ruby

Voici un exemple de base illustrant l'utilisation de la bibliothèque cliente Ruby. La bibliothèque cliente Ruby nécessite Ruby 2.1 ou une version ultérieure.

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/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)" 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.
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 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
```

Écrivez 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, :v202402)

# 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 étapes plus détaillées pour vous aider dans le fichier README distribué avec la bibliothèque cliente Ruby. Consultez également notre bibliothèque d'exemples complète pour Ruby.

Étapes suivantes

Une fois qu'une bibliothèque cliente est opérationnelle, modifiez les exemples fournis afin de l'é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.

Premiers pas

Accéder à un réseau Ad Manager

Créer des identifiants d'authentification

Configurer votre réseau Ad Manager

Configurer votre client

Java

Python

PHP

.NET

Ruby

Étapes suivantes