Streaming Laporan

Ada dua metode untuk mengambil entitas dan data pelaporan dengan Search Ads 360 Reporting API.

Panduan ini terutama berfokus pada streaming data dari SearchAds360Service. Berikut adalah perbedaan tingkat tinggi untuk dua metode pengambilan data:

SearchAds360Service.SearchStream SearchAds360Service.Search
Cocok untuk kode produksi Ya Ya
Layanan SearchAds360Service SearchAds360Service
Skenario Mengambil objek dan laporan Mengambil objek dan laporan
Respons Streaming objek SearchAds360Row Halaman objek SearchAds360Row
Kolom respons Hanya yang ditentukan dalam kueri Hanya yang ditentukan dalam kueri
Batas harian Lihat Batas dan kuota API. Lihat Batas dan kuota API.

Meskipun Search dapat mengirim beberapa permintaan bernomor halaman untuk mendownload seluruh laporan, SearchStream mengirim satu permintaan dan memulai koneksi persisten dengan Search Ads 360 Reporting API, terlepas dari ukuran laporan.

Untuk SearchStream, paket data akan langsung mulai didownload dengan seluruh hasil di-cache dalam buffering data. Kode Anda dapat mulai membaca data yang dibuffer tanpa harus menunggu seluruh streaming selesai.

Dengan menghilangkan waktu jaringan bolak-balik yang diperlukan untuk meminta setiap halaman respons Search, bergantung pada aplikasi Anda, SearchStream dapat menawarkan performa yang lebih baik daripada paging, terutama untuk laporan yang lebih besar.

Contoh

Misalnya, ambil laporan yang terdiri dari 100,000 baris. Tabel berikut memerinci perbedaan akuntansi antara kedua metode tersebut.

SearchStream Telusuri
Ukuran halaman Tidak Berlaku 10.000 baris per halaman
Jumlah permintaan API 1 permintaan 10 permintaan
Jumlah respons API 1 streaming berkelanjutan 10 respons

Faktor performa

Secara umum, kami merekomendasikan SearchStream daripada Search karena alasan berikut.

  • Untuk laporan satu halaman (di bawah 10.000 baris): Tidak ada perbedaan performa yang signifikan antara kedua metode tersebut.

  • Untuk laporan beberapa halaman: SearchStream biasanya lebih cepat karena beberapa perjalanan bolak-balik dihindari dan pembacaan/penulisan dari cache disk tidak terlalu berpengaruh.

Batas kapasitas

Batas harian untuk kedua metode tersebut mematuhi batas dan kuota API standar. Satu kueri atau laporan dihitung sebagai satu operasi, terlepas dari hasil yang di-paging atau di-streaming.

Contoh streaming

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());
      }
    }
  }
}

Download 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()

Mendownload get_campaigns_stream.py