Erste Schritte mit der API

In diesem Dokument wird erläutert, wie Sie mit dem Schreiben von Apps beginnen, die die Google Bid Manager API verwenden. Mit der API können Sie Abfragen verwalten und Bericht Metadaten abrufen.

Die Bid Manager API v2 ist die neueste verfügbare und empfohlene Version.

1. Vorbereitung

Wenn Sie mit den Konzepten von Google Display & Video 360 nicht vertraut sind, lesen Sie die Display & Video 360-Hilfe und probieren Sie die Benutzeroberfläche aus.

2. Auf die Authentifizierung vorbereiten

Damit Sie die Bid Manager API verwenden können, müssen Sie zuerst mithilfe des Einrichtungstoolsein Projekt in der Google API Console erstellen und die API aktivieren.

Erstellen Sie, falls noch nicht geschehen, Ihre OAuth 2.0-Anmeldedaten. Klicken Sie dazu auf Anmeldedaten erstellen > OAuth-Client-ID. Danach wird Ihre Client-ID auf der Seite Anmeldedaten angezeigt. Klicken Sie auf die Client-ID, um Details wie Clientschlüssel, Weiterleitungs-URIs, JavaScript-Quellen und E-Mail-Adresse zu sehen.

Weitere Informationen finden Sie unter Anfragen autorisieren.

3. Die Bid Manager API aufrufen

Auf den Tabs unten finden Sie Schnellstarts für die Programmierung in verschiedenen Sprachen. Ähnlicher Beispielcode ist auch im Bid Manager API Examples -Repository verfügbar.

Java

  1. Importieren Sie die erforderlichen Bibliotheken.

    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. Laden Sie die Secrets-Datei mit den Clientschlüsseln und generieren Sie Anmeldedaten für die Autorisierung.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie in Ihrem Browser aufgefordert, eine Autorisierungsaufforderung zu akzeptieren. Achten Sie darauf, dass Sie mit einem Google-Konto angemeldet sind, das Zugriff auf Display & Video 360 hat. Ihre App wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie derzeit angemeldet sind.

    // 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. Erstellen Sie einen autorisierten API-Client.

    // Create authorized API client.
    DoubleClickBidManager service =
        new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("bidmanager-java-installed-app-sample")
            .build();
  4. Führen Sie einen Vorgang aus.

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

Weitere Informationen zur Verwendung der Bid Manager API mit Java, finden Sie in der README Datei in den Bid Manager API-Beispielen.

Python

  1. Importieren Sie die erforderlichen Bibliotheken.

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
  2. Laden Sie die Secrets-Datei mit den Clientschlüsseln und generieren Sie Anmeldedaten für die Autorisierung.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie in Ihrem Browser aufgefordert, eine Autorisierungsaufforderung zu akzeptieren. Achten Sie darauf, dass Sie mit einem Google-Konto angemeldet sind, das Zugriff auf Display & Video 360 hat. Ihre App wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie derzeit angemeldet sind.

    # 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. Erstellen Sie einen autorisierten API-Client.

    # 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. Führen Sie einen Vorgang aus.

    # 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.')

Weitere Informationen zur Verwendung der Bid Manager API mit Python, finden Sie in der README -Datei in den Bid Manager API-Beispielen.

PHP

In diesem Beispiel wird davon ausgegangen, dass Sie PHP mit einem integrierten Webserver ausführen und Ihre Anmeldedaten so konfiguriert haben, dass sie zur entsprechenden Webseite weiterleiten. Dieser Code in einer index.php-Datei kann beispielsweise mit dem folgenden Befehl und Anmeldedaten ausgeführt werden, die so konfiguriert sind, dass sie nach der Authentifizierung zu http://localhost:8000 weiterleiten:

php -S localhost:8000 -t ./

  1. Laden Sie den Google API-Client für PHP herunter und installieren Sie ihn.

    Die bevorzugte Methode ist Composer:

    composer require google/apiclient:^2.12.1

    Nach der Installation müssen Sie den Autoloader einfügen.

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

  2. Erstellen Sie ein Google_Client-Objekt.

    $client = new Google_Client();
  3. Richten Sie den Client ein, leiten Sie ihn bei Bedarf zur Authentifizierungs-URL weiter und rufen Sie ein Zugriffstoken ab.

    Wenn Sie diesen Schritt zum ersten Mal ausführen, werden Sie in Ihrem Browser aufgefordert, eine Autorisierungsaufforderung zu akzeptieren. Achten Sie darauf, dass Sie mit einem Google-Konto angemeldet sind, das Zugriff auf Display & Video 360 hat. Ihre App wird autorisiert, auf Daten im Namen des Kontos zuzugreifen, mit dem Sie derzeit angemeldet sind.

    // 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. Erstellen Sie einen Client für den Display &Video 360 API-Dienst.

    $service = new Google_Service_DoubleClickBidManager($client);
  5. Führen Sie einen Vorgang aus.

    // 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>';
    }

Weitere Informationen zur Verwendung der Bid Manager API mit PHP, finden Sie in der README Datei in den Bid Manager API-Beispielen.

4. Nächste Schritte

Nachdem Sie eine Clientbibliothek eingerichtet haben, können Sie sich die Referenzdokumentation ansehen und mit der Implementierung beginnen.

Weitere Anleitungen zur Verwendung geplanter Berichte und zu Best Practices für Berichte sind ebenfalls verfügbar.