Search Ads 360 Reporting API のスタートガイド

以降のセクションでは、Search Ads 360 Reporting API の使用を開始する方法について説明します。

Google Cloud でプロジェクトを設定する

Search Ads 360 Reporting API を使用するには、Google Cloud でアプリケーションのプロジェクトを作成する必要があります。

Google プロジェクトを作成する

Google プロジェクトは、Google Cloud リソースのリソース コンテナとして機能します。

OAuth2 認証情報を作成する

Search Ads 360 Reporting API は、認証と承認に OAuth 2.0 を使用します。OAuth 認証情報によりアプリケーションが識別され、検索広告 360 のユーザーを管理するための OAuth トークンが生成されます。

警告: 検索広告 360 レポート スコープの認証情報を取得するために使用される Google Cloud アプリは、Google OAuth の確認が必要です。確認を行うと、ログイン時にユーザーに未確認の UI 画面が表示されなくなります。

Search Ads 360 Reporting API を有効にする

この API を使用するには、Google API Console でプロジェクトの Search Ads 360 Reporting API を有効にする必要があります。

必要に応じてプロジェクトの課金を有効にする

Google Cloud で Search Ads 360 Reporting API を使用するのに料金はかかりません。ただし、アカウントごとの無料 Cloud プロジェクトの合計数には割り当てがあります。上限に達した場合は、プロジェクトの無料割り当てが含まれる新しい Google アカウントに登録できます。

注: すでに課金が有効になっている場合（Google Cloud など）、プロジェクトの請求先アカウントを選択する必要があります。

プロジェクトの同意画面を有効にする

リダイレクト URI を作成、編集、表示する

クライアント ライブラリをダウンロードする

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

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

重要な変更のひとつは、新しい login-customer-id ヘッダーです。構成に追加する必要がある場合の詳細については、ログイン カスタマー ID ヘッダーをご覧ください。

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

クライアント ライブラリを構成したら、最初の呼び出しを行うことができます。

キャンペーンを取得する

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 の詳細

• クエリ:

  • 検索広告 360 クエリ言語
  • 検索レポートを作成する
  • メタデータを取得する

• コンセプト:

  • Search Ads 360 Reporting API の構造
  • Search Ads 360 Reporting API の呼び出し構造
  • Search Ads 360 Reporting API でのバージョニング
  • Search Ads 360 Reporting API のクライアント ライブラリ