Mulai

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Developer dapat menggunakan Google Ad Manager API 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 di bawah ini.

Mendapatkan akses ke jaringan Ad Manager

Jika Anda belum memilikinya, daftar ke akun Ad Manager. Anda juga dapat membuat jaringan pengujian jika ingin menguji API tersebut di lingkungan terpisah. Perhatikan bahwa Anda tidak memerlukan akun AdSense untuk tujuan pengujian.

Catat kode jaringan Anda. Anda akan menemukan ini 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 OAuth2. Langkah-langkah di bawah mencakup kasus penggunaan sederhana untuk mengakses data Ad Manager Anda sendiri. Untuk mengetahui detail selengkapnya dan opsi lainnya, lihat Authentication.

  1. Buka halaman Credentials di Google API Console.
  2. Dari menu project, pilih Buat project, masukkan nama untuk project, dan secara opsional, edit Project ID yang disediakan. Klik Create.
  3. Di halaman Credentials, pilih Create credentials, lalu pilih Service account key.
  4. Pilih New account service, lalu pilih JSON sebagai jenis kunci.
  5. Klik Create untuk mendownload file yang berisi kunci pribadi.

Mengonfigurasi jaringan Ad Manager

  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 Save di bagian bawah halaman.

Menyiapkan klien

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

Tab di bawah menyediakan panduan memulai untuk coding 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 di distribusi library klien.

  1. Menyiapkan kredensial

    Jalankan perintah berikut dalam shell:

    curl https://raw.githubusercontent.com/googleads/googleads-java-lib/master/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 dan tambahkan hal 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 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.v202211.Network;
    import com.google.api.ads.admanager.axis.v202211.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.

  1. Instal library dan siapkan kredensial Anda.

    Jalankan perintah berikut dalam shell:

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

    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='v202211')
    
    # 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 beranda Anda:

    composer require googleads/googleads-php-lib
    curl https://raw.githubusercontent.com/googleads/googleads-php-lib/master/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\v202211\ApiException;
    use Google\AdsApi\AdManager\v202211\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 (yaitu, Aplikasi Console).

  2. Menambahkan referensi library yang diperlukan ke project

    Tambahkan dependensi nuget untuk Google.Dfp.

  3. Menyiapkan App.config

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

    • konfigurasi/AdManagerApi
    • konfigurasi/configSections/bagian[name="AdManagerApi"]
    • konfigurasi/sistem.net
  4. 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" />
    

  5. Melakukan panggilan ke library

    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 menetapkan kredensial di App.config, lihat artikel wiki ini untuk mengetahui cara alternatif menggunakan class AdManagerUser. Untuk mengetahui informasi selengkapnya tentang cara menggunakan Library Klien .NET, lihat README. Jika Anda ingin melakukan pengembangan dalam .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/master/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
    

  2. Menyiapkan kredensial

    Isi kolom yang 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 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, :v202211)
    
    # 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

Jika library klien Anda sudah aktif dan berjalan, ubah contoh yang diberikan untuk memperluasnya sesuai kebutuhan Anda.

Lihat dokumentasi referensi untuk mempelajari API lebih lanjut.

Jika Anda perlu bantuan, buka halaman Dukungan.