Penggunaan lanjutan

Panduan ini menjelaskan cara menyesuaikan beberapa aspek yang lebih canggih dari library klien Java. Pola yang umum adalah banyak dari fitur ini mengandalkan Callable yang mendasarinya, bukan metode praktis standar. Callable umumnya merupakan tempat yang baik untuk mencari fitur per RPC lainnya yang tidak didokumentasikan di sini.

Waktu habis

Library Java menyediakan platform untuk menetapkan waktu tunggu pada tingkat per panggilan. Nilai default ditetapkan berdasarkan setelan method_config/timeout di googleads_grpc_service_config.json. Tetapkan nilai yang lebih rendah jika Anda perlu menerapkan batas yang lebih singkat pada waktu maksimum untuk panggilan API.

Untuk menggunakan fitur ini, panggil objek Callable secara langsung. Misalnya, saat memanggil GoogleAdsService.searchStream(), tetapkan waktu tunggu sebagai berikut:

try (GoogleAdsServiceClient googleAdsServiceClient =
    googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
  // Constructs the SearchGoogleAdsStreamRequest.
  SearchGoogleAdsStreamRequest request =
      SearchGoogleAdsStreamRequest.newBuilder()
          .setCustomerId(Long.toString(customerId))
          .setQuery("SELECT campaign.id, campaign.name FROM campaign")
          .build();

  // Executes the API call with a timeout of 5 minutes.
  ServerStream<SearchGoogleAdsStreamResponse> stream =
      googleAdsServiceClient
          .searchStreamCallable()
          .call(
              request,
              GrpcCallContext.createDefault()
                  .withTimeout(Duration.of(5, ChronoUnit.MINUTES)));
  for (SearchGoogleAdsStreamResponse response : stream) {
    // Processes the response rows.
  }
}

Anda dapat menetapkan waktu tunggu ke 2 jam atau lebih, tetapi API mungkin masih akan menghentikan permintaan yang berjalan sangat lama dan menampilkan error DEADLINE_EXCEEDED. Jika hal ini menjadi masalah, biasanya sebaiknya bagi kueri dan jalankan potongan secara paralel; hal ini menghindari situasi saat permintaan yang berjalan lama gagal dan satu-satunya cara untuk memulihkannya adalah dengan memicu permintaan lagi dari awal.

Coba lagi setelan

Library Java juga menyediakan platform untuk mengonfigurasi setelan percobaan ulang pada tingkat per panggilan. Untuk menggunakan fitur ini, panggil objek Callable secara langsung. Misalnya, saat memanggil GoogleAdsService.searchStream(), konfigurasikan setelan percobaan ulang sebagai berikut:

try (GoogleAdsServiceClient googleAdsServiceClient =
    googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
  SearchGoogleAdsStreamRequest request =
      SearchGoogleAdsStreamRequest.newBuilder()
          .setCustomerId(Long.toString(customerId))
          .setQuery("SELECT campaign.id, campaign.name FROM campaign")
          .build();

  // Creates a context object with the custom retry settings.
  GrpcCallContext context =
      GrpcCallContext.createDefault()
          .withRetrySettings(
              RetrySettings.newBuilder()
                  .setInitialRetryDelay(Duration.ofMillis(10L))
                  .setMaxRetryDelay(Duration.ofSeconds(10L))
                  .setRetryDelayMultiplier(1.4)
                  .setMaxAttempts(10)
                  .setLogicalTimeout(Duration.ofSeconds(30L))
                  .build());

  // Issues the streaming search request.
  ServerStream<SearchGoogleAdsStreamResponse> stream =
      googleAdsServiceClient.searchStreamCallable().call(request, context);
  for (SearchGoogleAdsStreamResponse response : stream) {
    // Processes the response rows.
  }
}

Pengoptimalan performa waktu startup

Anda mungkin melihat sedikit keterlambatan saat pertama kali instance GoogleAdsClient dibuat. Hal ini disebabkan oleh antarmuka yang lancar untuk layanan (GoogleAdsClient.getLatestVersion()), yang memuat class layanan API sekaligus untuk menyediakan mekanisme yang mudah dalam membuat klien layanan.

Jika performa permintaan pertama berada di jalur penting untuk aplikasi Anda, ikuti langkah-langkah berikut:

  1. Buat GoogleAdsClient saat memulai, sebelum menyajikan permintaan pengguna.

  2. Kirim beberapa permintaan pemanasan ke Google Ads API saat proses pertama kali dimulai. Contoh:

    // Runs some warm-up requests.
try (GoogleAdsServiceClient googleAdsServiceClient =
    googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
  // Runs 5 warm-up requests. In our profiling we see that 90% of
  // performance loss is only experienced on the first API call. After 3
  // subsequent calls we saw a negligible improvement in performance.
  for (int i = 0; i < 5; ++i) {
    // Warm-up queries are run with a nonexistent CID so the calls will
    // fail. If you have a CID that you know will be accessible with the
    // OAuth credentials provided you may want to provide that instead and
    // avoid the try-catch.
    try {
      googleAdsServiceClient.search("-1", "Warm-up query");
    } catch (ApiException ex) {
      // Do nothing, we're expecting this to fail.
    }
  }
}

Warm-up request hanya perlu dijalankan sekali per proses. Setiap pembuatan klien layanan berikutnya akan otomatis menggunakan kembali class yang telah dimuat sebelumnya.

Penggunaan ulang klien layanan

Anda harus menggunakan kembali instance klien layanan jika memungkinkan karena setiap panggilan ke GoogleAdsClient.getLatestVersion().createYYYServiceClient() (atau pengakses khusus versi seperti getVersion26()) membuat koneksi pokok baru dan resource terkait.

Pastikan Anda menutup klien layanan jika tidak lagi diperlukan. Anda dapat melakukannya di blok try-with-resources atau dengan memanggil close() pada klien layanan.

Jika Anda mencoba menggunakan klien layanan tertutup untuk membuat permintaan API, metode klien layanan akan menampilkan java.util.concurrent.RejectedExecutionException.

App Engine gagal di-deploy jika JAR > 32 MB

App Engine memiliki kuota 32 MB untuk setiap file yang diupload. JAR untuk google-ads jauh lebih besar dari ini, terutama saat menggunakan deployment JAR shade atau shadow. Jika Anda men-deploy JAR secara manual, Anda mungkin mendapatkan error seperti:

ERROR: (gcloud.app.deploy) Cannot upload file [<your-app>/WEB-INF/lib/google-ads-48.1.0.jar],
which has size [66095767] (greater than maximum allowed size of [33554432])

Sebagai gantinya, deploy menggunakan plugin Gradle atau plugin Maven App Engine. Setiap plugin menyediakan opsi enableJarSplitting yang membagi setiap JAR menjadi potongan berukuran 10 MB dan menguploadnya.

Dependensi shadow

Jika project Anda memiliki dependensi yang bertentangan dengan dependensi library, periksa hierarki dependensi project menggunakan salah satu perintah berikut, lalu ubah dependensi project sesuai kebutuhan (atau gunakan Bill of Materials):

Maven

mvn dependency:tree

Gradle

./gradlew dependencies

Jika penyelesaian konflik dependensi tidak memungkinkan, Anda dapat bergantung pada versi library yang di-shaded:

Maven

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads-shadowjar</artifactId>
  <version>48.1.0</version>
</dependency>

Gradle

implementation 'com.google.api-ads:google-ads-shadowjar:48.1.0'