Streaming laporan menggunakan GoogleAdsService

Untuk mengambil entity dan data pelaporan Google Ads API, gunakan salah satu metode berikut:

Berikut adalah perbedaan umum antara kedua metode tersebut:

GoogleAdsService.SearchStream GoogleAdsService.Search
Cocok untuk kode produksi Ya Ya
Layanan GoogleAdsService GoogleAdsService
Skenario Mengambil objek dan laporan Mengambil objek dan laporan
Respons Stream objek GoogleAdsRow Halaman objek GoogleAdsRow
Kolom respons Hanya yang ditentukan dalam kueri Hanya yang ditentukan dalam kueri
Batas harian Batas harian berdasarkan tingkat akses Batas harian berdasarkan tingkat akses

Meskipun Search mengirim beberapa permintaan yang diberi nomor halaman untuk mendownload seluruh laporan, SearchStream mengirim satu permintaan dan memulai koneksi gRPC persisten dengan Google Ads API, berapa pun ukuran laporannya.

Untuk SearchStream, paket data akan segera didownload dalam batch yang berisi SearchGoogleAdsStreamResponse objek. Kode Anda dapat melakukan iterasi pada batch yang masuk saat batch tersebut tiba tanpa menunggu seluruh streaming selesai.

Dengan menghilangkan waktu jaringan bolak-balik yang diperlukan untuk meminta setiap halaman respons Search, SearchStream menawarkan peningkatan performa dibandingkan paging, terutama untuk laporan berukuran besar.

Contoh

Contoh ini melihat laporan yang terdiri dari 100,000 baris. Tabel berikut menguraikan perbedaan permintaan dan respons antara kedua metode:

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

Untuk sebagian besar kasus penggunaan, sebaiknya gunakan SearchStream daripada Search karena alasan berikut:

  • Laporan satu halaman (di bawah 10.000 baris): Tidak ada perbedaan performa yang signifikan antara kedua metode tersebut.
  • Laporan multi-halaman: SearchStream biasanya lebih cepat karena beberapa perjalanan bolak-balik jaringan dihindari, dan pembacaan atau penulisan dari cache disk tidak terlalu berpengaruh.
  • Efisiensi memori: Saat memproses laporan besar dengan SearchStream, lakukan iterasi melalui potongan streaming dan proses baris saat tiba, bukan mem-buffer semua baris dalam memori sekaligus untuk menghindari error kehabisan memori (OOM).
  • Ketahanan koneksi: Karena SearchStream mengandalkan koneksi persisten, streaming yang berjalan lama dapat terganggu oleh penurunan jaringan atau waktu tunggu yang habis. Konfigurasikan waktu tunggu RPC yang sesuai dan terapkan logika percobaan ulang untuk error aliran data sementara.

Batas kapasitas

Batas operasi harian untuk kedua metode mematuhi batas standar dan tingkat akses project Google Cloud Anda. Satu kueri laporan logis dihitung sebagai satu operasi terhadap kuota operasi harian Anda, terlepas dari apakah hasilnya di-streaming dengan SearchStream atau diambil di beberapa halaman yang di-cache menggunakan Search dengan page_token. Namun, setiap permintaan Search yang diberi nomor halaman tetap dihitung sebagai panggilan RPC individual terhadap batas kapasitas jangka pendek.

Contoh kode

Contoh kode berikut menunjukkan cara menjalankan kueri laporan streaming menggunakan library klien:

Java

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V26.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}

PHP

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}

Python

def main(client: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

    query: str = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )

Ruby

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end

Perl

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V26::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}

curl

Sebelumnya
Label
Berikutnya
Paging