Library klien kami menyediakan tampilan tingkat tinggi dan elemen penyusun dasar fungsi Google Ads API, sehingga memudahkan pengembangan aplikasi dengan cepat. Sebaiknya mulai dengan salah satunya jika Anda baru menggunakan 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 |
Library Komunitas
Kami mengetahui beberapa library yang dikelola oleh komunitas open source. Kami mengelola daftar ini untuk membantu developer yang tertarik menemukannya. Kami tidak menguji, berkontribusi, atau mengelola library ini; gunakan library ini dengan risiko Anda sendiri. Setiap pertanyaan yang mungkin Anda miliki harus diajukan kepada pemilik project open source.
Jika Anda mengetahui library yang terlewat, klik Kirim masukan di bagian atas halaman dan beri tahu kami.
Versi API yang didukung
Tabel menunjukkan library klien yang berfungsi dengan versi API tertentu.
Java
Google Ads API |
Library klien untuk Java |
v18 |
Min: 34.0.0 Max: - |
v17 |
Min: 32.0.0 Max: - |
v16 |
Min: 30.0.0 Max: - |
C#
Google Ads API |
Library klien untuk .NET |
v18 |
Min: 21.1.0 Max: - |
v17 |
Min: 20.1.0 Max: - |
v16 |
Min: 18.1.0 Max: - |
PHP
Google Ads API |
Library klien untuk PHP |
v18 |
Min: 25.0.0 Max: - |
v17 |
Min: 23.1.0 Max: - |
v16 |
Min: 22.1.0 Max: - |
Python
Google Ads API |
Library klien untuk Python |
v18 |
Min: 25.1.0 Max: - |
v17 |
Min: 24.1.0 Max: - |
v16 |
Min: 23.1.0 Max: - |
Ruby
Google Ads API |
Library klien untuk Ruby |
v18 |
Min: 31.0.0 Max: - |
v17 |
Min: 29.0.0 Max: - |
v16 |
Min: 27.0.0 Max: - |
Perl
Google Ads API |
Library klien untuk Perl |
v18 |
Min: 25.0.1 Max: - |
v17 |
Min: 23.0.0 Max: - |
v16 |
Min: 21.0.0 Max: - |
Konfigurasi
Setiap library Klien Ads API menyediakan setelan konfigurasi dan metode pemuatan yang berbeda yang dapat Anda gunakan untuk menyesuaikan perilakunya.
Berikut adalah variabel lingkungan yang umum untuk semua library klien dan yang dapat dimuat untuk menetapkan setelan 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 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 konfigurasi JSON OAuth2.GOOGLE_ADS_IMPERSONATED_EMAIL
: Tetapkan nilai ini ke alamat email akun yang Anda tirukan.
- Mode Aplikasi
- Google Ads API
GOOGLE_ADS_DEVELOPER_TOKEN
: Tetapkan ke token developer Anda.GOOGLE_ADS_LOGIN_CUSTOMER_ID
: Ini adalah ID pelanggan dari pelanggan yang diotorisasi untuk digunakan dalam permintaan, tanpa tanda hubung (-
).GOOGLE_ADS_LINKED_CUSTOMER_ID
: Header ini hanya diperlukan untuk metode yang memperbarui resource entity saat diberi otorisasi melalui Akun Tertaut di UI Google Ads (resourceAccountLink
di Google Ads API). Tetapkan nilai ini ke ID pelanggan penyedia data yang memperbarui resource ID pelanggan yang ditentukan. Akun harus ditetapkan tanpa tanda hubung (-
). Untuk mempelajari Akun Tertaut lebih lanjut, buka Pusat Bantuan.
Variabel lingkungan biasanya ditentukan dalam file konfigurasi bash seperti
file .bashrc
atau .bash_profile
yang terletak di direktori $HOME
. Parameter ini
juga dapat ditentukan menggunakan command line.
Berikut adalah 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.
src ~/.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 entity
GoogleAdsService.SearchStream
biasanya digunakan untuk mengambil entity, dan hasilnya ditampilkan sebagai streaming
baris. Atau, Anda dapat menggunakan
GoogleAdsService.Search
untuk mengambil
entitas melalui koneksi internet yang tidak dapat diandalkan. GoogleAdsService.Search
menampilkan hasil sebagai ukuran halaman tetap sebesar 10.000 baris per halaman.
Library klien kami otomatis menerapkan paging saat Anda melakukan iterasi hasil sehingga Anda dapat mendownload dan memprosesnya secara berurutan sekaligus.
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.V18.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, 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.' )
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::V18::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; }
Contoh kode
Lihat contoh kode kami untuk beberapa fungsi umum di Google Ads API.