Memulai

Anda dapat menggunakan API Google Ad Manager untuk membuat aplikasi yang mengelola inventaris, membuat pesanan, mengambil laporan, dan lainnya.

Ad Manager API menggunakan SOAP. Untuk membantu Anda memulai, kami menawarkan library klien untuk Java, .NET, Python, PHP, dan Ruby.

Untuk membuat permintaan API pertama Anda, 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 yang 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, dalam URL https://admanager.google.com/1234#home, 1234 adalah kode jaringan Anda.

Membuat kredensial autentikasi

Anda harus mengautentikasi semua permintaan Ad Manager API menggunakan OAuth 2.0. Langkah-langkah di bawah ini mencakup kasus penggunaan mengakses data Ad Manager Anda sendiri. Untuk mengetahui detail selengkapnya dan opsi lainnya, lihat Autentikasi.

  1. Buka halaman Kredensial Konsol API Google

  2. Dari menu project, pilih Buat project, masukkan nama untuk project, dan edit ID Project yang diberikan jika perlu. Klik Buat.

  3. Pada halaman Credentials, pilih Create credentials, lalu pilih Service account key.

  4. Pilih New service account dan pilih JSON sebagai jenis kunci.

  5. Klik Buat untuk mendownload file yang berisi kunci pribadi.

Mengonfigurasi jaringan Ad Manager Anda

  1. Login ke Google Ad Manager.

  2. Di sidebar, klik Admin > Setelan global.

  3. Di bagian Setelan umum > Akses API, klik penggeser ke Diaktifkan.

  4. Klik tombol Simpan di bagian bawah halaman.

Menyiapkan klien Anda

Download salah satu library klien Ad Manager. Library ini menawarkan fungsi dan fitur wrapper yang mempermudah dan mempercepat pengembangan aplikasi.

Tab di bawah ini menyediakan panduan memulai untuk coding dalam setiap bahasa yang tersedia library klien.

Java

Berikut adalah contoh dasar yang menunjukkan cara menggunakan library klien Java. Untuk informasi penggunaan yang lebih mendetail, lihat file README di distribusi library klien.

  1. Menyiapkan kredensial Anda

    Jalankan perintah berikut dalam shell:

    curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties
    Buka file ~/ads.properties dan 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
    [...]
  2. Menentukan dependensi

    Edit file pom.xml Anda dan tambahkan kode berikut ke tag dependencies. 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>

  3. Tulis beberapa kode dan buat 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.v202402.Network;
    import com.google.api.ads.admanager.axis.v202402.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 detail, lihat file README di distribusi library klien.

  1. Instal library dan siapkan kredensial Anda.

    Jalankan perintah berikut dalam shell:

    pip install googleads
    curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \
         -o ~/googleads.yaml
    
  2. Siapkan file ~/googleads.yaml.

    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
    
  3. Jalankan beberapa kode dan buat 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='v202402')
    
    # 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.

  1. 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-lib
    curl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
  2. Siapkan file ~/adsapi_php.ini Anda.

    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"
    
  3. Jalankan beberapa kode dan buat permintaan.
    <?php
    require 'vendor/autoload.php';
    use Google\AdsApi\AdManager\AdManagerSession;
    use Google\AdsApi\AdManager\AdManagerSessionBuilder;
    use Google\AdsApi\AdManager\v202402\ApiException;
    use Google\AdsApi\AdManager\v202402\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

  1. Membuat project baru

    Buka Visual Studio dan buat project baru (Aplikasi Konsol).

  2. Menambahkan referensi library yang diperlukan ke project Anda

    Tambahkan dependensi nuget untuk Google.Dfp.

  3. Menyiapkan App.config Anda

    Salin src\App.config ke direktori project dan tambahkan ke project Anda. Jika aplikasi Anda memiliki App.config sendiri, Anda dapat menyalin node berikut ke App.config:

    • konfigurasi/AdManagerApi
    • configuration/configSections/section[name="AdManagerApi"]
    • konfigurasi/system.net
  4. Kredensial penyiapan

    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" />
    

  5. Menelepon 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 tidak ingin menetapkan kredensial Anda di App.config, lihat artikel wiki ini untuk mengetahui cara alternatif menggunakan class AdManagerUser. Untuk mengetahui informasi lebih detail tentang penggunaan Library Klien .NET, lihat README . Jika Anda ingin mengembangkan aplikasi 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.

  1. Instal Ruby gem dan dapatkan file konfigurasi.

    Jalankan perintah berikut dalam shell:

    gem install google-dfp-api
    curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
    
  2. Menyiapkan kredensial Anda

    Isi kolom wajib diisi dalam file ~/ad_manager_api.yml. 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
    
  3. Tulis beberapa kode dan buat 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, :v202402)
    
    # 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 bersama library klien Ruby. Selain itu, lihat library contoh lengkap untuk Ruby.

Langkah berikutnya

Setelah Anda menyediakan dan menjalankan library klien, ubah contoh yang diberikan untuk memperluasnya sesuai kebutuhan Anda.

Baca dokumentasi referensi untuk mempelajari API lebih lanjut.

Jika Anda memerlukan bantuan, buka halaman Dukungan kami.