Library klien

Library klien Google Ads API menyediakan tampilan tingkat tinggi dan blok penyusun dasar fungsi Google Ads API, sehingga memudahkan pengembangan aplikasi dengan cepat. Mulai dengan library klien jika Anda baru menggunakan API.

Perpustakaan komunitas

Kami mengetahui beberapa library yang dikelola oleh komunitas open source. Kami mengelola daftar ini untuk membantu developer yang berminat menemukannya. Kami tidak menguji, berkontribusi, atau memelihara library ini; gunakan dengan risiko Anda sendiri. Semua pertanyaan yang mungkin Anda miliki harus ditujukan kepada pemilik project open source.

Jika Anda mengetahui perpustakaan yang belum kami cantumkan, klik Kirim masukan di bagian atas halaman dan beri tahu kami.

• Node.js: google-ads-api di npm
• Go: google-ads-pb di GitHub

Versi API yang didukung

Tabel ini menunjukkan library klien mana yang kompatibel dengan versi API tertentu.

Versi library klien minimum yang tercantum sudah cukup untuk rilis utama Google Ads API (seperti v25). Untuk melihat versi library klien yang diperlukan untuk rilis kecil, lihat Log Perubahan yang ditautkan.

Konfigurasi

Setiap library klien Google Ads API menyediakan setelan konfigurasi dan metode pemuatan yang berbeda yang dapat Anda gunakan untuk menyesuaikan perilakunya.

Berikut adalah variabel lingkungan standar yang dapat Anda gunakan untuk mengonfigurasi library klien:

• Library klien
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH: Jalur ke file konfigurasi (dibaca secara otomatis saat memuat dari file konfigurasi tanpa argumen jalur eksplisit di Java (fromPropertiesFile()), Perl (Client->new()), PHP (fromFile()), Python (load_from_storage(), dan juga diperiksa oleh load_from_env()), dan Ruby (GoogleAdsClient.new); di .NET, muat variabel ini secara eksplisit menggunakan config.TryLoadFromEnvironmentFilePath atau muat file konfigurasi menggunakan LoadFromSettingsJson, LoadFromConfigurationSection, atau LoadFromConfigurationRoot).
• OAuth2
  • Mode aplikasi
    • GOOGLE_ADS_CLIENT_ID: Tetapkan nilai ini ke client ID OAuth2 Anda.
    • GOOGLE_ADS_CLIENT_SECRET: Tetapkan nilai ini ke secret klien OAuth2 Anda.
    • GOOGLE_ADS_REFRESH_TOKEN: Tetapkan nilai ini ke token refresh OAuth2 yang telah dibuat sebelumnya jika Anda ingin menggunakan kembali token OAuth2. Setelan ini bersifat opsional.
  • Mode akun layanan
    • GOOGLE_ADS_JSON_KEY_FILE_PATH: Tetapkan nilai ini ke jalur file kunci JSON OAuth2 Anda (di .NET, tetapkan juga GOOGLE_ADS_OAUTH2_MODE ke SERVICE_ACCOUNT, karena OAuth2Mode secara default adalah APPLICATION; di PHP versi yang lebih lama dari v32.1.0 atau saat menggunakan cakupan kustom, tetapkan juga [OAUTH2] scopes di google_ads_php.ini atau panggil withScopes(), karena fromEnvironmentVariables() tidak membaca cakupan OAuth2 dari variabel lingkungan).
    • GOOGLE_ADS_IMPERSONATED_EMAIL: Tetapkan nilai ini ke alamat email akun yang Anda tiru identitasnya saat menggunakan delegasi di seluruh domain Google Workspace. Setelan ini bersifat opsional.
  • Mode Kredensial Default Aplikasi
    • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: Tetapkan nilai ini ke true untuk melakukan autentikasi menggunakan Kredensial Default Aplikasi (ADC). Didukung di Java v41.1.0 dan yang lebih baru, Python v28.3.0 dan yang lebih baru, serta Ruby v36.1.0 dan yang lebih baru (di .NET v24.1.0 dan yang lebih baru, LoadFromEnvironmentVariables() membaca variabel USE_APPLICATION_DEFAULT_CREDENTIALS yang tidak memiliki awalan, atau menetapkan UseApplicationDefaultCredentials = true di GoogleAdsConfig; di PHP, OAuth2TokenBuilder otomatis melakukan penggantian ke ADC jika tidak ada kredensial OAuth2 eksplisit yang ditetapkan; Perl tidak mendukung ADC).
• Google Ads API
  • GOOGLE_ADS_DEVELOPER_TOKEN: Opsional dalam rilis terbaru (Java v46.0.0 dan yang lebih baru, .NET v27.3.0 dan yang lebih baru, PHP v35.0.0 dan yang lebih baru, Python v32.0.0 dan yang lebih baru, Ruby v45.0.0 dan yang lebih baru, dan Perl v35.0.0 dan yang lebih baru). Token developer dihentikan pada 9 September 2026, dan server API mengabaikan header developer-token terlepas dari versi library klien (hingga versi utama Google Ads API di masa mendatang menolaknya). Versi library klien sebelumnya masih memerlukan nilai yang tidak kosong untuk validasi sisi klien lokal; lihat panduan konfigurasi setiap library untuk mengetahui detail khusus versi.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID: Ini adalah ID pelanggan dari pelanggan yang diberi otorisasi untuk digunakan dalam permintaan, tanpa tanda hubung (-).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID: Header ini hanya diperlukan untuk metode yang memperbarui resource entity jika diberi izin melalui Akun Tertaut di UI Google Ads (resource AccountLink di Google Ads API). Tetapkan nilai ini ke ID pelanggan penyedia data yang memperbarui resource ID pelanggan yang ditentukan. ID harus ditetapkan tanpa tanda hubung (-). Untuk mempelajari lebih lanjut Akun Tertaut, buka Pusat Bantuan.

Variabel lingkungan biasanya ditentukan dalam file konfigurasi bash seperti file .bashrc atau .bash_profile yang terletak di direktori $HOME. Kolom ini juga dapat ditentukan menggunakan command line.

Berikut beberapa langkah dasar untuk menentukan variabel lingkungan menggunakan file .bashrc menggunakan terminal:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
source ~/.bashrc

Variabel lingkungan juga dapat ditetapkan di instance terminal Anda langsung dari command line:

export GOOGLE_ADS_CLIENT_ID=1234567890

Alternatif lainnya adalah menetapkan variabel lingkungan saat memanggil perintah yang menggunakannya:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

Mengambil entitas

GoogleAdsService.SearchStream biasanya digunakan untuk mengambil entity, dan hasilnya ditampilkan sebagai aliran baris. Atau, Anda dapat menggunakan GoogleAdsService.Search untuk mengambil entitas melalui koneksi internet yang tidak andal. GoogleAdsService.Search menampilkan hasil sebagai ukuran halaman tetap sebesar 10.000 baris per halaman.

Library klien secara otomatis menerapkan penomoran halaman saat Anda melakukan iterasi hasil sehingga Anda dapat mendownload dan memprosesnya secara berurutan sekaligus.

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

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V25.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;
    }
}
GetCampaigns.cs
      

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
        );
    }
}
GetCampaigns.php
      

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.'
            )
get_campaigns.py
      

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
get_campaigns.rb
      

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::V25::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;
}
get_campaigns.pl
      

Contoh kode

Lihat contoh kode kami untuk beberapa fungsi umum di Google Ads API.