Die neue Search Ads 360 Reporting API ist jetzt verfügbar. Treten Sie der Google-Gruppe searchads-api-announcements bei, um über kommende Verbesserungen und Releases auf dem Laufenden zu bleiben.

Diese Seite wurde von der Cloud Translation API übersetzt.

Erste Schritte mit der Search Ads 360 Reporting API

In den folgenden Abschnitten wird beschrieben, wie Sie die Search Ads 360 Reporting API verwenden.

Projekt in Google Cloud einrichten

Wenn Sie die Search Ads 360 Reporting API verwenden möchten, müssen Sie ein Projekt für Ihre Anwendung in Google Cloud erstellen.

Google-Projekt erstellen

Ein Google-Projekt dient als Ressourcencontainer für Ihre Google Cloud-Ressourcen.

Go to the Google API Console.
Klicken Sie auf Projekt erstellen .
Geben Sie einen Namen ein oder akzeptieren Sie den generierten Vorschlag.
Bestätigen oder bearbeiten Sie alle verbleibenden Felder.
Klicken Sie auf Erstellen .

OAuth2-Anmeldedaten erstellen

Die Search Ads 360 Reporting API verwendet OAuth 2.0 für die Authentifizierung und Autorisierung. OAuth-Anmeldedaten identifizieren Ihre App bei Google und ermöglichen es Ihnen, OAuth-Tokens zum Verwalten von Search Ads 360-Nutzern zu generieren.

Google API Console wie Google API Console , um einen OAuth 2.0-Berechtigungsnachweis in Google API Console zu erstellen:

Go to the Credentials page.
Klicken Sie auf Anmeldeinformationen erstellen> OAuth-Client-ID
Wählen Sie Ihren Anwendungstyp.
Füllen Sie das Formular aus und klicken Sie auf Erstellen .

Search Ads 360 Reporting API aktivieren

Wenn Sie die API verwenden möchten, müssen Sie die Search Ads 360 Reporting API für Ihr Projekt in der Google API Console aktivieren.

So aktivieren Sie eine API für Ihr Projekt:

Open the API Library im Google API Console .
If prompted, select a project, or create a new one. Der API Library listet alle verfügbaren APIs auf, gruppiert nach Produktfamilie und Beliebtheit.
Wenn die API, die Sie aktivieren möchten, in der Liste nicht sichtbar ist, suchen Sie sie mithilfe der Suche oder klicken Sie in der Produktfamilie, zu der sie gehört, auf Alle anzeigen.
Wählen Sie die API Sie aktivieren möchten, und klicken Sie auf die Schaltfläche Aktivieren.
If prompted, enable billing.
If prompted, read and accept the API's Terms of Service.

Optional: Abrechnung für Ihr Projekt aktivieren

Die Verwendung der Search Ads 360 Reporting API in Google Cloud ist kostenlos. Es gibt jedoch ein Kontingent für die Gesamtzahl der kostenlosen Cloud-Projekte für jedes Konto. Wenn Sie das Limit erreicht haben, können Sie sich für ein neues Google-Konto registrieren, das ein kostenloses Projektkontingent enthält.

So aktivieren Sie die Abrechnung für Ihr Projekt:

Besuchen Sie die Billing page .
Wenn Sie kein aktives Abrechnungskonto haben, erstellen Sie ein Konto, indem Sie auf Abrechnungskonto hinzufügen klicken und den Anweisungen folgen.

Zustimmungsbildschirm Ihres Projekts aktivieren

So aktivieren Sie den Zustimmungsbildschirm Ihres Projekts:

Öffnen Sie das Consent Screen page im Google API Console .
If prompted, select a project, or create a new one.
Füllen Sie das Formular aus und klicken Sie auf Speichern .

Weiterleitungs-URIs erstellen, bearbeiten oder aufrufen

Gehen Sie wie folgt vor, um die Umleitungs-URIs für einen bestimmten OAuth 2.0-Berechtigungsnachweis zu erstellen, anzuzeigen oder zu bearbeiten:

Go to the Credentials page.
Klicken Sie im Abschnitt OAuth 2.0-Client-IDs der Seite auf einen Berechtigungsnachweis.
Anzeigen oder Bearbeiten der Umleitungs-URIs.

Wenn auf der Seite Anmeldeinformationen kein Abschnitt zu OAuth 2.0-Client-IDs vorhanden ist, verfügt Ihr Projekt über keine OAuth-Anmeldeinformationen. Um einen zu erstellen, klicken Sie auf Anmeldeinformationen erstellen .

Clientbibliothek herunterladen

Die Verwendung einer Search Ads 360 Reporting API-Clientbibliothek ist die empfohlene Methode, um eine Verbindung zur Search Ads 360 Reporting API herzustellen.

Laden Sie die Search Ads 360 Reporting API-Clientbibliothek für Ihre Entwicklungsumgebung herunter. Folgen Sie der sprachspezifischen Anleitung zum Einrichten der Konfigurationsdatei der Clientbibliothek. In den meisten Fällen können Sie Ihre vorhandene Konfiguration bei der Migration zur neuen Search Ads 360 Reporting API-Clientbibliothek wiederverwenden.

Eine wichtige Änderung ist die neue Überschrift login-customer-id. Unter Header „Kunden-ID für Anmeldung“ finden Sie weitere Informationen dazu, wann Sie diesen Ihrer Konfiguration hinzufügen müssen.

Erste Anrufe

Nachdem Sie die Clientbibliothek konfiguriert haben, können Sie Ihren ersten Aufruf starten.

Kampagnen abrufen

Führen Sie in Ihrer IDE den folgenden Code aus:

Java

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package sample;

import com.beust.jcommander.Parameter;
import com.google.ads.searchads360.v0.lib.SearchAds360Client;
import com.google.ads.searchads360.v0.services.SearchAds360Row;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;
import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;

/** Get campaign details. */
public class GetCampaigns {
  private static final int PAGE_SIZE = 200;

  private static class GetCampaignsParams extends CodeSampleParams {

    @Parameter(names = "--customerId", required = true)
    private String customerId;

    @Parameter(names = "--loginCustomerId")
    private String loginCustomerId;
  }

  public static void main(String[] args) {
    GetCampaignsParams params = new GetCampaignsParams();
    if (!params.parseArguments(args)) {
      // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
      // here (10 digits, no dashes). If neither are set, customerId will be used as
      // loginCustomerId.
      // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
    }
    final String loginCustomerId = params.loginCustomerId;
    final String customerId = params.customerId;

    try {
      // Creates a SearchAds360Client with the specified loginCustomerId. If there's
      // no loginCustomerId, customerId will be used instead.
      final SearchAds360Client searchAds360Client =
          SearchAds360Client.newBuilder()
              .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
              .fromPropertiesFile()
              .build();
      // Creates the Search Ads 360 Service client.
      SearchAds360ServiceClient client = searchAds360Client.create();
      new GetCampaigns().runExample(client, customerId);
    } catch (Exception exception) {
      System.err.printf("Failed with exception: %s%n", exception);
      exception.printStackTrace();
      System.exit(1);
    }
  }

  private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
    // Creates a query that retrieves all campaigns under the customerId.
    String query = "SELECT campaign.name, campaign.id, campaign.status FROM campaign";
    SearchSearchAds360Request request =
        SearchSearchAds360Request.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .setPageSize(PAGE_SIZE)
            .build();

    // Issues a search request.
    final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
    for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
      System.out.printf(
          "Campaign found with name '%s', ID %d, and status: %s.%n",
          element.getCampaign().getName(),
          element.getCampaign().getId(),
          element.getCampaign().getStatus());
    }
  }
}

GetCampaigns.java herunterladen

Python

#!/usr/bin/env python
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Retrieves campaigns for a customer using a pagination search request."""

import argparse
import traceback
from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360Request
from util_searchads360 import SearchAds360Client

_DEFAULT_PAGE_SIZE = 10000


def main(client, customer_id, page_size) -> None:
  search_ads_360_service = client.get_service()

  query = """
      SELECT
        campaign.name,
        campaign.id,
        campaign.status
      FROM campaign"""

  request = SearchSearchAds360Request()
  request.customer_id = customer_id
  request.query = query
  request.page_size = page_size

  # Issues a search request.
  results = search_ads_360_service.search(request=request)

  for row in results:
    campaign = row.campaign
    print(
        f'campaign "{campaign.name}" has id {campaign.id} and status {campaign.status.name}'
    )


if __name__ == "__main__":
  # SearchAds360Client will read the search-ads-360.yaml configuration file in
  # the home directory if none is specified.
  search_ads_360_client = SearchAds360Client.load_from_file()

  parser = argparse.ArgumentParser(
      description=("Retrieves campaigns for a customer."))
  # Arguments to provide to run the example.
  parser.add_argument(
      "-c",
      "--customer_id",
      type=str,
      required=True,
      help="The Search Ads 360 customer ID (10 digits, no dashes).",
  )

  parser.add_argument(
      "-l",
      "--login_customer_id",
      type=str,
      required=False,
      help="The Search Ads 360 login customer ID (10 digits, no dashes).",
  )

  args = parser.parse_args()

  search_ads_360_client.set_ids(args.customer_id, args.login_customer_id)

  try:
    main(search_ads_360_client, args.customer_id, _DEFAULT_PAGE_SIZE)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

get_campaigns.py herunterladen

In der Konsole sollte eine Liste der Kampagnen in Ihrem Konto angezeigt werden.

REST verwenden

Wenn Sie sich gegen die Verwendung einer Clientbibliothek entscheiden, müssen Sie mit der REST-Nutzung vertraut sein.

Wenn Sie REST mit der alten Search Ads 360 API verwendet haben, funktionieren Ihre Anmeldedaten auch mit der neuen Search Ads 360 Reporting API. Den neuen Endpunkt und weitere Details findest du im Referenzabschnitt für REST.

Weitere Informationen

Weitere Informationen zur Search Ads 360 Reporting API