Checkliste für die Migration

  1. Sehen Sie sich die Zuordnungen der alten Search Ads 360 API zur neuen Search Ads 360 Reporting API an:

  2. Aktivieren Sie die Search Ads Reporting 360 API in Ihrem Google Cloud-Projekt.

    • Öffnen Sie die API-Bibliothek in der Google API Console. Wenn Sie dazu aufgefordert werden, wählen Sie Ihr Projekt aus oder erstellen Sie ein neues. In der API-Bibliothek sind alle verfügbaren APIs aufgeführt, gruppiert nach Produktfamilie und Beliebtheit.
    • Verwenden Sie die Suche, um die Search Ads 360 Reporting API zu finden, falls sie nicht in der Liste aufgeführt ist.
    • Wählen Sie Search Ads 360 Reporting API aus und klicken Sie auf Aktivieren.
  3. Wählen Sie Ihre Clientbibliothek aus.

  4. Tätigen Sie Ihren ersten Anruf.

Clientbibliotheken verwenden

Wir empfehlen die Verwendung einer Search Ads 360 Reporting API-Clientbibliothek, 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 unter Konfigurationsdatei für Clientbibliotheken einrichten. 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 der neue login-customer-id-Header. Unter Header für die Log-in-Kundennummer erfahren Sie, wann Sie dies Ihrer Konfiguration hinzufügen müssen.

Java-Konfigurationsbeispiel

In diesem Beispiel wird gezeigt, wie Sie die Datei searchads360.properties für die Java-Clientbibliothek aktualisieren, indem Sie doubleclicksearch für die Authentifizierungsattribute durch searchads360 ersetzen.

api.doubleclicksearch.clientId       -> api.searchads360.clientId
api.doubleclicksearch.clientSecret   -> api.searchads360.clientSecret
api.doubleclicksearch.refreshToken   -> api.searchads360.refreshToken

Erster Anruf starten

Nachdem Sie die Konfigurationsdatei aktualisiert haben, können Sie Ihren ersten Aufruf ausführen.

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

Über die Konsole sollte eine Liste der Kampagnen in Ihrem Konto ausgegeben werden.

REST verwenden

Wenn Sie keine Clientbibliothek verwenden möchten, müssen Sie wissen, wie REST verwendet wird.

Wenn Sie REST mit der alten Search Ads 360 API verwendet haben, funktionieren Ihre Anmeldedaten weiterhin für die neue Search Ads 360 Reporting API. Den neuen Endpunkt und andere Details finden Sie im Abschnitt REST-Referenz.

Weitere Informationen

Weitere Informationen zur Search Ads 360 Reporting API.