Library Klien

Library klien kami menyediakan tampilan tingkat tinggi dan elemen penyusun dasar dari Fungsi Google Ads API, yang memudahkan pengembangan aplikasi dengan cepat. Saran dari kami memulai dengan salah satunya jika Anda baru mengenal API.

Library klien	Sumber	Distribusi	Contoh kode
Java	google-ads-java	Maven, tar.gz	Lihat di GitHub
.NET	google-ads-dotnet	nuget, tar.gz, zip	Lihat di GitHub
PHP	google-ads-php	tar.gz	Lihat di GitHub
Python	google-ads-python	tar.gz, zip	Lihat di GitHub
Ruby	google-ads-ruby	gem, tar.gz, zip	Lihat di GitHub
Perl	google-ads-perl	tar.gz, zip	Lihat di GitHub

Versi API yang didukung

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

Java

Google Ads API	Library klien untuk Java
v17	32.0.0 Min: Max: -
v16	30.0.0 Min: Max: -
v15	28.0.0 Min: Max: -

C#

Google Ads API	Library klien untuk .NET
v17	20.1.0 Min: Max: -
v16	18.1.0 Min: Max: -
v15	17.1.0 Min: Max: -

PHP

Google Ads API	Library klien untuk PHP
v17	23.1.0 Min: Max: -
v16	22.1.0 Min: Max: -
v15	21.1.0 Min: Max: -

Python

Google Ads API	Library klien untuk Python
v17	24.1.0 Min: Max: -
v16	23.1.0 Min: Max: -
v15	22.1.0 Min: Max: -

Ruby

Google Ads API	Library klien untuk Ruby
v17	29.0.0 Min: Max: -
v16	27.0.0 Min: Max: -
v15	25.0.0 Min: Max: -

Perl

Google Ads API	Library klien untuk Perl
v17	23.0.0 Min: Max: -
v16	21.0.0 Min: Max: -
v15	19.0.0 Min: Max: -

Konfigurasi

Setiap pustaka Klien Ads API menyediakan setelan konfigurasi yang berbeda dan metode pemuatan yang dapat Anda gunakan untuk menyesuaikan perilakunya.

Berikut adalah variabel lingkungan yang umum untuk semua library klien dan yang dapat dimuat untuk mengatur pengaturan konfigurasi:

• Library klien
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH: Jalur ke file konfigurasi.
• OAuth2
  • Mode Aplikasi
    • GOOGLE_ADS_CLIENT_ID : Tetapkan nilai ini ke client ID OAuth2 Anda.
    • GOOGLE_ADS_CLIENT_SECRET : Tetapkan nilai ini ke rahasia 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 konfigurasi JSON OAuth2 .
    • GOOGLE_ADS_IMPERSONATED_EMAIL : Setel nilai ini ke alamat email akun yang Anda tiru.
• API Google Ads
  • GOOGLE_ADS_DEVELOPER_TOKEN : Tetapkan string ini ke token developer Anda.
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID : Ini adalah ID pelanggan dari pelanggan yang diotorisasi yang akan digunakan di permintaan, tanpa tanda hubung (-).
  • GOOGLE_ADS_LINKED_CUSTOMER_ID : Header ini hanya diperlukan untuk metode yang mengupdate resource entitas jika diberi izin melalui Akun Tertaut UI Google Ads (referensi AccountLink di Google Ads API). Tetapkan nilai ini ke ID pelanggan penyedia data yang memperbarui resource penyedia ID pelanggan tertentu. Kolom ini harus ditetapkan tanpa tanda hubung (-). Untuk mempelajari lebih lanjut tentang Akun Tertaut, buka Pusat Bantuan.

Catatan: Untuk mengetahui detail selengkapnya tentang cara menggunakannya dan klien tambahan lainnya variabel lingkungan khusus library, lihat panduan konfigurasi yang dikhususkan untuk setiap library klien: Java, .NET, PHP, Python, Ruby, Perl.

Variabel lingkungan biasanya didefinisikan dalam file konfigurasi bash seperti sebagai file .bashrc atau .bash_profile yang berada di direktori $HOME. Mereka juga dapat ditentukan dengan menggunakan baris perintah.

Catatan: Petunjuk ini mengasumsikan bahwa Anda menggunakan Bash. Jika Anda menggunakan baca dokumentasi untuk mengetahui perintah yang setara.

Berikut adalah beberapa langkah dasar untuk menentukan variabel lingkungan menggunakan .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.
src ~/.bashrc

Variabel lingkungan juga bisa ditetapkan di instance terminal secara langsung dari baris perintah:

export GOOGLE_ADS_CLIENT_ID=1234567890

Alternatif lain adalah dengan mengatur variabel lingkungan saat memanggil perintah yang menggunakannya:

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

Penomoran halaman penelusuran

GoogleAdsService.Search biasanya adalah digunakan dalam aplikasi interaktif yang menampilkan halaman hasil.

Library klien kami secara otomatis menerapkan paging saat Anda melakukan iterasi hasil sehingga Anda dapat mendownload secara berurutan dan memproses semuanya sekaligus, misalnya:

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

C#

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

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

Python

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

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

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py
      

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

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::V17::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
      

Bergantung pada kasus penggunaannya, Anda mungkin perlu:

• Optimalkan jumlah halaman yang diambil.
• Optimalkan jumlah hasil yang disimpan sekaligus.
• Download dan proses halaman hasil dalam urutan tertentu.

Hal ini dapat dilakukan dengan menyimpan token halaman, bukan hasil, yang menambahkan kompleksitas yang lebih tinggi pada kode Anda.

Contoh kode

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