新しい Search Ads 360 Reporting API をご利用いただけるようになりました。Google グループ searchads-api-announcements に参加すると、今後の機能強化やリリースに関する最新情報を入手できます。

このページは Cloud Translation API によって翻訳されました。

移行チェックリスト

従来版の Search Ads 360 API から新しい Search Ads 360 Reporting API へのマッピングを確認します。
Google Cloud プロジェクトで Search Ads Reporting 360 API を有効にします。
- Google API Console で API ライブラリを開きます。プロンプトが表示されたら、プロジェクトを選択するか、新しいプロジェクトを作成します。API ライブラリには、利用可能なすべての API がプロダクトファミリーと人気度別にグループ化されて一覧表示されます。
- Search Ads 360 Reporting API がリストに表示されない場合は、検索を使用して探します。
- [Search Ads 360 Reporting API] を選択し、[有効にする] をクリックします。
注: 従来版の Search Ads 360 API で使用していた OAuth2 認証情報は、新しい Search Ads 360 Reporting API でも引き続き有効です。clientId と clientSecret のペアを新しく作成しないでください。
クライアントライブラリを選択します。
最初の電話を行います。

クライアントライブラリの使用

Search Ads 360 Reporting API に接続するには、Search Ads 360 Reporting API クライアントライブラリの使用をおすすめします。

開発環境に適した Search Ads 360 Reporting API クライアントライブラリをダウンロードします。クライアントライブラリの構成ファイルを設定する方法で、言語別の手順に沿って操作します。ほとんどの場合、新しい Search Ads 360 Reporting API クライアントライブラリに移行する際に既存の設定を再利用できます。

重要な変更点の一つは、新しい login-customer-id ヘッダーです。このヘッダーを設定に追加する必要がある状況について詳しくは、ログインお客様 ID ヘッダーをご覧ください。

Java の設定例

この例では、認証プロパティの doubleclicksearch を searchads360 に置き換えて、Java クライアントライブラリの searchads360.properties ファイルを更新する方法を示します。

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

最初の呼び出しを実行する

構成ファイルを更新したら、最初の呼び出しを行うことができます。

キャンペーンの取得

IDE で次のコードを実行します。

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 をダウンロード

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 をダウンロード

コンソールにアカウントのキャンペーンの一覧が表示されます。

REST を使用する

クライアントライブラリを使用しない場合は、REST の使用方法を理解しておく必要があります。

以前の Search Ads 360 API で REST を使用していた場合、認証情報は新しい Search Ads 360 Reporting API でも引き続き機能します。REST リファレンスセクションで新しいエンドポイントとその他の詳細を確認してください。

詳細

Search Ads 360 Reporting API の詳細