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

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

レポートのストリーミング

Search Ads 360 Reporting API を使用してエンティティを取得し、レポートデータを取得する方法は 2 つあります。

このガイドでは、主に SearchAds360Service からのストリーミングデータについて説明します。次の 2 つのデータ取得方法の概要を示します。

	SearchAds360Service.SearchStream	SearchAds360Service.Search
本番環境コードに適している	はい	はい
サービス	`SearchAds360Service`	`SearchAds360Service`
シナリオ	オブジェクトとレポートの取得	オブジェクトとレポートの取得
レスポンス	`SearchAds360Row` オブジェクトのストリーム	`SearchAds360Row` オブジェクトのページ
レスポンスのフィールド	クエリで指定されたもののみ	クエリで指定されたもののみ
1 日の利用時間の上限	API の制限と割り当てをご覧ください。	API の制限と割り当てをご覧ください。

SearchStream と Search の違い

Search は複数のページネーションリクエストを送信してレポート全体をダウンロードできますが、SearchStream は 1 つのリクエストを送信し、レポートのサイズに関係なく Search Ads 360 Reporting API との永続接続を開始します。

SearchStream の場合、データパケットはすぐにダウンロードを開始し、結果全体がデータバッファにキャッシュに保存されます。ストリーム全体が完了するまで待たずに、バッファに格納されたデータを読み取ることができます。

Search レスポンスの各ページをリクエストするために必要なラウンドトリップネットワーク時間を排除することで、アプリによっては、特に大規模なレポートで、SearchStream がページングよりもパフォーマンスを向上させることができます。

例

たとえば、100,000 行で構成されるレポートを取得します。次の表に、2 つの方法の違いを示します。

	SearchStream	検索
ページサイズ	該当なし	ページあたり 10,000 行
API リクエストの数	1 件のリクエスト	10 件のリクエスト
API レスポンス数	1 つの連続ストリーム	10 件の回答

パフォーマンスの要因

通常は、次の理由から Search ではなく SearchStream を使用することをおすすめします。

1 ページのレポート（10,000 行未満）の場合: 2 つの方法でパフォーマンスに大きな違いはありません。
複数ページのレポートの場合: 複数の往復が回避され、ディスクキャッシュからの読み取り/書き込みがあまり重要でないため、通常は SearchStream の方が高速です。

レート制限

どちらの方法でも、1 日あたりの上限は標準の API の制限と割り当てに準拠しています。1 つのクエリまたはレポートは、結果がページングされるかストリーミングされるかにかかわらず、1 つのオペレーションとしてカウントされます。

ストリーミングの例

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.SearchSearchAds360StreamRequest;
import com.google.ads.searchads360.v0.services.SearchSearchAds360StreamResponse;
import com.google.api.gax.rpc.ServerStream;

/** Get campaign details using SearchStream. */
public class GetCampaignsStream {
  private static class GetCampaignsStreamParams extends CodeSampleParams {

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

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

  public static void main(String[] args) {
    GetCampaignsStreamParams params = new GetCampaignsStreamParams();
    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 GetCampaignsStream().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";
    SearchSearchAds360StreamRequest request =
        SearchSearchAds360StreamRequest.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .build();

    // Issues a search stream request.
    ServerStream<SearchSearchAds360StreamResponse> stream =
        searchAds360ServiceClient.searchStreamCallable().call(request);

    for (SearchSearchAds360StreamResponse response : stream) {
      for (SearchAds360Row element : response.getResultsList()) {
        System.out.printf(
            "Campaign found with name '%s', ID %d, and status: %s.%n",
            element.getCampaign().getName(),
            element.getCampaign().getId(),
            element.getCampaign().getStatus());
      }
    }
  }
}

GetCampaignsStream.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 stream request."""

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


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

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

  request = SearchSearchAds360StreamRequest()
  request.customer_id = customer_id
  request.query = query

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

  for response in results:
    for result in response.results:
      campaign = result.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)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

get_campaigns_stream.py をダウンロードする