Anda dapat menggunakan Google Ad Manager SOAP API untuk membuat aplikasi yang mengelola inventaris, membuat pesanan, menarik laporan, dan lainnya.
Untuk membantu Anda memulai, kami menawarkan library klien untuk Java, .NET, Python, PHP, dan Ruby.
Untuk membuat permintaan API pertama, ikuti langkah-langkah berikut:
Mendapatkan akses ke jaringan Ad Manager
Jika Anda belum memilikinya, daftar untuk membuat akun Ad Manager. Anda juga dapat membuat jaringan pengujian jika ingin menguji API di lingkungan terpisah. Perhatikan bahwa Anda tidak memerlukan akun AdSense untuk tujuan pengujian.
Catat kode jaringan Anda. Anda dapat menemukannya di URL saat login ke jaringan. Misalnya, di URL
https://admanager.google.com/1234#home, 1234 adalah kode jaringan Anda.
Membuat kredensial autentikasi
Anda harus mengautentikasi semua permintaan Ad Manager SOAP API menggunakan OAuth 2.0. Langkah-langkah berikut mencakup kasus penggunaan untuk mengakses data Ad Manager Anda sendiri. Untuk detail selengkapnya dan opsi lainnya, lihat Autentikasi.
Dari menu project, pilih Buat project, masukkan nama untuk project, dan opsional, edit Project ID yang diberikan. Klik Create.
Di halaman Kredensial, pilih Buat kredensial, lalu pilih Kunci akun layanan.
Pilih Akun layanan baru dan pilih
JSONsebagai jenis kunci.Klik Buat untuk mendownload file yang berisi kunci pribadi.
Mengonfigurasi jaringan Ad Manager Anda
Login ke Google Ad Manager.
Di sidebar, klik Admin > Setelan global.
Di bagian Setelan umum > Akses API, klik penggeser ke Diaktifkan.
Klik tombol Simpan di bagian bawah halaman.
Menyiapkan klien Anda
Download salah satu library klien Ad Manager. Library menawarkan fungsi dan fitur wrapper yang membuat pengembangan aplikasi menjadi lebih mudah dan cepat.
Tab berikut menyediakan panduan memulai untuk membuat kode dalam setiap bahasa yang memiliki library klien.
Java
Berikut adalah contoh dasar yang menunjukkan cara menggunakan library klien Java. Untuk mengetahui informasi penggunaan yang lebih mendetail, lihat file README dalam distribusi library klien.
- Menyiapkan kredensial Anda
Jalankan perintah berikut di shell:
Buka filecurl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties~/ads.propertiesdan isi kolom berikut:[...] api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE api.admanager.networkCode=INSERT_NETWORK_CODE_HERE [...]
-
Menentukan dependensi
Edit file
pom.xmlAnda dan tambahkan kode berikut ke tagdependencies. Anda dapat menemukan nomor versi terbaru di GitHub.<dependency> <groupId>com.google.api-ads</groupId> <artifactId>ads-lib</artifactId> <version>RELEASE</version> </dependency> <dependency> <groupId>com.google.api-ads</groupId> <artifactId>dfp-axis</artifactId> <version>RELEASE</version> </dependency>
-
Tulis beberapa kode dan ajukan permintaan.
import com.google.api.ads.common.lib.auth.OfflineCredentials; import com.google.api.ads.common.lib.auth.OfflineCredentials.Api; import com.google.api.ads.admanager.axis.factory.AdManagerServices; import com.google.api.ads.admanager.axis.v202608.Network; import com.google.api.ads.admanager.axis.v202608.NetworkServiceInterface; import com.google.api.ads.admanager.lib.client.AdManagerSession; import com.google.api.client.auth.oauth2.Credential; public class App { public static void main(String[] args) throws Exception { Credential oAuth2Credential = new OfflineCredentials.Builder() .forApi(Api.AD_MANAGER) .fromFile() .build() .generateCredential(); // Construct an AdManagerSession. AdManagerSession session = new AdManagerSession.Builder() .fromFile() .withOAuth2Credential(oAuth2Credential) .build(); // Construct a Google Ad Manager service factory, which can only be used once per // thread, but should be reused as much as possible. AdManagerServices adManagerServices = new AdManagerServices(); // Retrieve the appropriate service NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class); // Make a request Network network = networkService.getCurrentNetwork(); System.out.printf("Current network has network code '%s' and display" + " name '%s'.%n", network.getNetworkCode(), network.getDisplayName()); } }
Python
Berikut adalah contoh dasar yang menunjukkan cara menggunakan library klien Python. Library Klien Python mendukung Python v3.6+. Untuk informasi penggunaan yang lebih mendetail, lihat file README dalam distribusi library klien.
- Instal library dan siapkan kredensial Anda.
Jalankan perintah berikut di shell:
python3 -m pip install googleadscurl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \ -o ~/googleads.yaml - Siapkan file
~/googleads.yamlAnda.Isi kolom berikut:
ad_manager: application_name: INSERT_APPLICATION_NAME_HERE network_code: INSERT_NETWORK_CODE_HERE path_to_private_key_file: INSERT_PATH_TO_FILE_HERE
-
Jalankan beberapa kode dan ajukan permintaan.
# Import the library. from googleads import ad_manager # Initialize a client object, by default uses the credentials in ~/googleads.yaml. client = ad_manager.AdManagerClient.LoadFromStorage() # Initialize a service. network_service = client.GetService('NetworkService', version='v202608') # Make a request. current_network = network_service.getCurrentNetwork() print("Current network has network code '%s' and display name '%s'." % (current_network['networkCode'], current_network['displayName']))
PHP
Berikut adalah contoh dasar yang menunjukkan cara menggunakan library klien PHP.
-
Instal library dan siapkan kredensial Anda.
Jalankan perintah berikut di shell untuk menginstal library klien dan mendownload file adsapi_php.ini ke direktori utama Anda:
composer require googleads/googleads-php-libcurl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini -
Siapkan file
~/adsapi_php.iniAnda.Isi kolom berikut:
[AD_MANAGER] networkCode = "INSERT_NETWORK_CODE_HERE" applicationName = "INSERT_APPLICATION_NAME_HERE" [OAUTH2] jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE" scopes = "https://www.googleapis.com/auth/dfp"
-
Jalankan beberapa kode dan ajukan permintaan.
<?php require 'vendor/autoload.php'; use Google\AdsApi\AdManager\AdManagerSession; use Google\AdsApi\AdManager\AdManagerSessionBuilder; use Google\AdsApi\AdManager\v202608\ApiException; use Google\AdsApi\AdManager\v202608\ServiceFactory; use Google\AdsApi\Common\OAuth2TokenBuilder; // Generate a refreshable OAuth2 credential for authentication. $oAuth2Credential = (new OAuth2TokenBuilder()) ->fromFile() ->build(); // Construct an API session configured from a properties file and the OAuth2 // credentials above. $session = (new AdManagerSessionBuilder()) ->fromFile() ->withOAuth2Credential($oAuth2Credential) ->build(); // Get a service. $serviceFactory = new ServiceFactory(); $networkService = $serviceFactory->createNetworkService($session); // Make a request $network = $networkService->getCurrentNetwork(); printf( "Network with code %d and display name '%s' was found.\n", $network->getNetworkCode(), $network->getDisplayName() );
.NET
Berikut adalah contoh dasar yang menunjukkan cara menggunakan library klien .NET
- Membuat project baru
Buka Visual Studio dan buat project baru (Console Application).
- Menambahkan referensi library yang diperlukan ke project Anda
Tambahkan dependensi nuget untuk Google.Dfp.
- Menyiapkan App.config
Salin src\App.config ke direktori project Anda, lalu tambahkan ke project Anda. Jika aplikasi Anda memiliki App.config sendiri, Anda dapat menyalin node berikut ke App.config:
- configuration/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- configuration/system.net
- Menyiapkan kredensial
Buka App.config dan edit kunci berikut:
<add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" /> <add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" /> <add key="OAuth2Mode" value="SERVICE_ACCOUNT" /> <add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />
- Melakukan panggilan ke perpustakaan
Anda dapat memanggil library seperti yang ditunjukkan dalam cuplikan kode C# berikut
AdManagerUser user = new AdManagerUser(); using (InventoryService inventoryService = user.GetService<InventoryService>()) { // Create a statement to select ad units. int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT; StatementBuilder statementBuilder = new StatementBuilder().OrderBy("id ASC").Limit(pageSize); // Retrieve a small amount of ad units at a time, paging through until all // ad units have been retrieved. int totalResultSetSize = 0; do { AdUnitPage page = inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement()); // Print out some information for each ad unit. if (page.results != null) { totalResultSetSize = page.totalResultSetSize; int i = page.startIndex; foreach (AdUnit adUnit in page.results) { Console.WriteLine( "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++, adUnit.id, adUnit.name); } } statementBuilder.IncreaseOffsetBy(pageSize); } while (statementBuilder.GetOffset() < totalResultSetSize); Console.WriteLine("Number of results found: {0}", totalResultSetSize); }
Jika Anda tidak ingin menyetel kredensial di App.config, lihat artikel wiki ini untuk mengetahui cara alternatif menggunakan class AdManagerUser. Untuk informasi yang lebih mendetail tentang penggunaan Library Klien .NET, lihat README . Jika Anda ingin mengembangkan di .NET tanpa library klien, lihat artikel wiki NoClientLibrary.
Ruby
Berikut adalah contoh dasar yang menunjukkan cara menggunakan library klien Ruby. Library klien Ruby memerlukan Ruby 2.1 atau yang lebih baru.
-
Instal gem Ruby dan dapatkan file konfigurasi.
Jalankan perintah berikut di shell:
gem install google-dfp-apicurl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml -
Menyiapkan kredensial Anda
Isi kolom yang wajib diisi dalam file
~/ad_manager_api.ymltersebut. Jika belum memiliki file kunci OAuth2, Anda harus mengikuti langkah-langkah untuk membuat kredensial OAuth2.:authentication: :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE :application_name: INSERT_APPLICATION_NAME_HERE :network_code: INSERT_NETWORK_CODE_HERE
-
Tulis beberapa kode dan ajukan permintaan.
# Import the library. require 'ad_manager_api' # Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default). ad_manager = AdManagerApi::Api.new # Get a service instance. network_service = ad_manager.service(:NetworkService, :v202608) # Make a request. network = network_service.get_current_network() puts "The current network is %s (%d)." % [network[:display_name], network[:network_code]]
Langkah-langkah yang lebih mendetail untuk memulai dapat ditemukan di file README yang didistribusikan dengan library klien Ruby. Selain itu, lihat library contoh lengkap kami untuk Ruby.
Langkah berikutnya
Setelah library klien siap dan berjalan, ubah contoh yang diberikan untuk memperluasnya sesuai kebutuhan Anda.
Lihat dokumentasi referensi untuk mempelajari lebih lanjut API.
Jika Anda memerlukan bantuan, buka halaman Dukungan kami.