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

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

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

以下のセクションでは、Search Ads 360 Reporting API の利用方法について説明します。

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

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

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

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

Go to the Google API Console.
[ プロジェクトを作成]をクリックします。
名前を入力するか、生成された提案を受け入れます。
残りのフィールドを確認または編集します。
作成をクリックします。

OAuth2 認証情報を作成する

Search Ads 360 Reporting API では、認証と認可に OAuth 2.0 を使用します。OAuth 認証情報を使って Google でアプリを識別し、検索広告 360 ユーザーを管理するための OAuth トークンを生成できます。

Google API Console OAuth 2.0資格情報を作成するには、次のGoogle API Consoleを実行します。

Go to the Credentials page.
[ 認証情報を作成]> [OAuthクライアントID]をクリックします
アプリケーションのタイプを選択します。
フォームに入力し、[ 作成 ]をクリックします。

Search Ads 360 Reporting API を有効にする

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

プロジェクトのAPIを有効にするには：

Open the API LibraryのGoogle API Console
If prompted, select a project, or create a new one. API Libraryは、製品ファミリおよび人気度API Libraryグループ化された、利用可能なすべてのAPIをリストします。
有効にするAPIがリストに表示されない場合は、検索を使用してそれを見つけるか、それが属する製品ファミリで[すべて表示 ]をクリックします。
有効にするAPIを選択して、[ 有効にする ]ボタンをクリックします。
If prompted, enable billing.
If prompted, read and accept the API's Terms of Service.

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

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

プロジェクトの課金を有効にするには：

Billing pageます。
有効な請求先アカウントがない場合は、[ 請求先アカウントを追加 ] をクリックし、指示に従って作成します。

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

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

Consent Screen pageでGoogle API Consoleます。
If prompted, select a project, or create a new one.
フォームに入力して[ 保存 ]をクリックします。

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

特定のOAuth 2.0認証情報のリダイレクトURIを作成、表示、または編集するには、次の手順を実行します。

Go to the Credentials page.
ページのOAuth 2.0クライアントIDセクションで、認証情報をクリックします。
リダイレクトURIを表示または編集します。

[認証情報]ページにOAuth 2.0クライアントIDセクションがない場合、プロジェクトにはOAuth認証情報がありません。 アカウントを作成するには、[ 認証情報を作成]をクリックします。

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

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