Premiers pas avec l'API

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

Ce document explique comment créer des applications qui utilisent l'API Google Bid Manager. L'API vous permet de gérer les requêtes et de récupérer les métadonnées de rapport.

L'API Bid Manager v2 est la dernière version disponible et recommandée.

1. Avant de commencer

Si vous ne connaissez pas les concepts de Display & Video 360, consultez le Centre d'aide Display & Video 360 et testez l'interface utilisateur.

2. Préparer l'authentification

Pour commencer à utiliser l'API Bid Manager, vous devez d'abord utiliser l'outil de configuration. Celui-ci vous explique comment créer un projet dans la console Google APIs, activer l'API et créer des identifiants.

Si vous ne l'avez pas déjà fait, créez vos identifiants OAuth 2.0 en cliquant sur Créer des identifiants > ID client OAuth. Une fois les identifiants créés, votre ID client s'affiche sur la page Identifiants. Cliquez sur l'ID client pour obtenir des informations telles que le code secret du client, les URI de redirection, l'adresse d'origine JavaScript et l'adresse e-mail.

Pour en savoir plus, consultez Autoriser les requêtes.

3. Appeler l'API Bid Manager

Les onglets ci-dessous proposent des guides de démarrage rapide pour le codage dans différents langages. Un exemple de code similaire est également disponible dans le dépôt de l'exemple d'API Bid Manager.

Java

  1. Importez les bibliothèques nécessaires.

    import static java.nio.charset.StandardCharsets.UTF_8;
    import com.google.api.client.auth.oauth2.Credential;
    import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
    import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
    import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
    import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
    import com.google.api.client.googleapis.util.Utils;
    import com.google.api.services.doubleclickbidmanager.DoubleClickBidManager;
    import com.google.api.services.doubleclickbidmanager.model.ListQueriesResponse;
    import com.google.api.services.doubleclickbidmanager.model.Query;
    import java.io.Reader;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
  2. Chargez le fichier de secrets du client et générez des identifiants d'autorisation.

    La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté avec un compte Google ayant accès à Display & Video 360. Votre application sera autorisée à accéder aux données pour le compte du compte actuellement connecté.

    // Read client secrets file.
    GoogleClientSecrets clientSecrets;
    try (Reader reader = Files.newBufferedReader(Paths.get(path-to-client-secrets-file), UTF_8)) {
      clientSecrets = GoogleClientSecrets.load(Utils.getDefaultJsonFactory(), reader);
    }
    
    // Generate authorization credentials.
    // Set up the authorization code flow.
    GoogleAuthorizationCodeFlow flow =
        new GoogleAuthorizationCodeFlow.Builder(
            Utils.getDefaultTransport(),
            Utils.getDefaultJsonFactory(),
            clientSecrets,
            oauth-scopes)
        .build();
    
    Credential credential =
        new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
    
  3. Créez un client API autorisé.

    // Create authorized API client.
    DoubleClickBidManager service =
        new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("bidmanager-java-installed-app-sample")
            .build();
    
  4. Effectuez une opération.

    // Perform an operation.
    // Call the API, getting a list of 10 queries.
    ListQueriesResponse queriesResponse = service.queries().list().setPageSize(10).execute();
    
    // Print them out.
    System.out.println("Id\t\tName");
    if (queriesResponse.getQueries().size() > 0) {
      for (int i = 0; i < queriesResponse.getQueries().size(); i++) {
        Query currentQuery = queriesResponse.getQueries().get(i);
        System.out.printf(
            "%s\t%s%n",
            currentQuery.getQueryId(),
            currentQuery.getMetadata().getTitle());
      }
    } else {
      System.out.println("No queries exist.");
    }
    

Pour en savoir plus sur l'utilisation de l'API Bid Manager avec Java, consultez le fichier README dans les exemples d'API Bid Manager.

Python

  1. Importez les bibliothèques nécessaires.

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. Chargez le fichier de secrets du client et générez des identifiants d'autorisation.

    La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté avec un compte Google ayant accès à Display & Video 360. Votre application sera autorisée à accéder aux données pour le compte du compte actuellement connecté.

    # Set up a flow object to create the credentials using the
    # client secrets file and OAuth scopes.
    credentials = InstalledAppFlow.from_client_secrets_file(
        path-to-client-secrets-file, oauth-scopes).run_local_server()
    
  3. Créez un client API autorisé.

    # Build the discovery document URL.
    discovery_url = f'https://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2'
    
    # Build the API service.
    service = discovery.build(
        'doubleclickbidmanager',
        'v2',
        discoveryServiceUrl=discovery_url,
        credentials=credentials)
    
  4. Effectuez une opération.

    # Build and execute queries.listqueries request.
    response = service.queries().list(pageSize='10').execute()
    
    # Print queries out.
    if 'queries' in response:
      print('Id\t\tName')
      for query in response['queries']:
        print('%s\t%s' % (query['queryId'], query['metadata']['title']))
    else:
      print('No queries exist.')
    

Pour en savoir plus sur l'utilisation de l'API Bid Manager avec Python, reportez-vous au fichier README dans les exemples d'API Bid Manager.

PHP

Cet exemple suppose que vous exécutez PHP avec un serveur Web intégré et que vous avez configuré vos identifiants pour rediriger vers la page Web appropriée. Par exemple, ce code, dans un fichier index.php, peut être exécuté à l'aide de la commande et des identifiants suivants, configurés pour rediriger les utilisateurs vers http://localhost:8000 après l'authentification:

php -S localhost:8000 -t ./

  1. Téléchargez et installez le client PHP des API Google.

    La méthode privilégiée est via Composer :

    composer require google/apiclient:^2.12.1
    

    N'oubliez pas d'inclure le chargeur automatique

    require_once '/path/to/your-project/vendor/autoload.php';
    

  2. Créez un objet Google_Client.

    $client = new Google_Client();
    
  3. Configurez le client, redirigez les utilisateurs vers une URL d'authentification si nécessaire et récupérez un jeton d'accès.

    La première fois que vous effectuez cette étape, vous êtes invité à accepter une invite d'autorisation dans votre navigateur. Avant d'accepter, vérifiez que vous êtes connecté avec un compte Google ayant accès à Display & Video 360. Votre application sera autorisée à accéder aux données pour le compte du compte actuellement connecté.

    // Set up the client.
    $client->setApplicationName('DBM API PHP Samples');
    $client->addScope(oauth-scope);
    $client->setAccessType('offline');
    $client->setAuthConfigFile(path-to-client-secrets-file);
    
    // If the code is passed, authenticate. If not, redirect to authentication page.
    if (isset($_GET['code'])) {
      $client->authenticate($_GET['code']);
    } else {
      $authUrl = $client->createAuthUrl();
      header('Location: ' . $authUrl);
    }
    
    // Exchange authorization code for an access token.
    $accessToken = $client->getAccessToken();
    $client->setAccessToken($accessToken);
    
  4. Construisez un client pour le service d'API Display &Video 360.

    $service = new Google_Service_DoubleClickBidManager($client);
    
  5. Effectuez une opération.

    // Configure params for the Queries.listqueries request.
    $optParams = array('pageSize' => 10);
    
    // Execute the request.
    $result = $service->queries->listQueries($optParams);
    
    // Print the retrieved queries.
    if (!empty($result->getQueries())) {
      print('<pre><p>Id Name</p>');
      foreach ($result->getQueries() as $query) {
        printf('<p>%s %s</p>', $query->queryId, $query->metadata->title);
      }
      print('</pre>');
    } else {
      print '<p>No queries exist.</p>';
    }
    

Pour en savoir plus sur l'utilisation de l'API Bid Manager avec PHP, reportez-vous au fichier README dans les exemples d'API Bid Manager.

4. Étapes suivantes

Maintenant que vous disposez d'une bibliothèque cliente opérationnelle, explorez la documentation de référence et commencez à développer votre mise en œuvre.

Des guides supplémentaires sont également disponibles sur l'utilisation des rapports planifiés et les bonnes pratiques concernant la création de rapports.