Mencari REST API? Ad Manager API (Beta) kini tersedia.

Halaman ini diterjemahkan oleh Cloud Translation API.

Mulai

Anda 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 klien library untuk Java, .NET, Python, PHP, dan Ruby.

Untuk membuat permintaan API pertama Anda, ikuti langkah-langkah berikut:

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

Catat kode jaringan Anda. Anda dapat menemukannya di URL saat Anda login ke jaringan Anda. Misalnya, di 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-langkahnya di bawah membahas kasus penggunaan akses data Ad Manager Anda sendiri. Untuk detail selengkapnya dan opsi lainnya, lihat Authentication.

Buka Konsol API Google Halaman Credentials
Dari menu project, pilih Buat project, masukkan nama untuk project, dan jika perlu, edit ID Project yang diberikan. Klik Create.
Di halaman Credentials, pilih Create credentials, lalu pilih Kunci akun layanan.
Pilih Layanan baru akun Anda dan pilih JSON sebagai jenis kunci.
Klik Create untuk mendownload file yang berisi kunci pribadi.

Mengonfigurasi jaringan Ad Manager

Login ke Google Ads Manajer.
Di sidebar, klik Admin > Setelan global.
Di bagian Setelan umum > Akses API klik penggeser ke Aktif.
Klik tombol Simpan di bagian bawah halaman.

Siapkan klien Anda

Download salah satu library klien Ad Manager. Tujuan library menawarkan fungsi dan fitur wrapper yang membuatnya lebih mudah dan lebih cepat untuk mengembangkan aplikasi.

Tab di bawah ini menyediakan panduan memulai untuk melakukan coding dalam setiap bahasa yang sesuai dengan terdapat library klien.

Java

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

Menyiapkan kredensial

Jalankan perintah berikut di 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
[...]

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>

Tulis 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.v202408.Network;
import com.google.api.ads.admanager.axis.v202408.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());
  }
}

Lihat di GitHub

Python

Berikut adalah contoh dasar yang menunjukkan cara menggunakan library klien Python. Library Klien Python mendukung Python v3.6+. Untuk penggunaan yang lebih mendetail informasi, lihat README dalam distribusi library klien.

Instal library dan siapkan kredensial Anda.

Jalankan perintah berikut di shell:

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

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

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='v202408')

# 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']))

Lihat di GitHub

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 adsapi_php.ini ke direktori {i>home<i} 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

Siapkan file ~/adsapi_php.ini.

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 buat permintaan.

Kode contoh ini harus dijalankan dari command line, bukan browser. File yang berisi kode ini harus berada di root direktori project, tempat composer require dijalankan.

<?php
require 'vendor/autoload.php';
use Google\AdsApi\AdManager\AdManagerSession;
use Google\AdsApi\AdManager\AdManagerSessionBuilder;
use Google\AdsApi\AdManager\v202408\ApiException;
use Google\AdsApi\AdManager\v202408\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()
);

Lihat di GitHub

.NET

Berikut adalah contoh dasar yang menunjukkan cara menggunakan klien.NET koleksi

Membuat project baru
Buka Visual Studio dan buat project baru (Aplikasi Konsol).
Menambahkan referensi library yang diperlukan ke project
Tambahkan dependensi nuget untuk Google.Dfp.
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:
- 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" />

Menelepon ke koleksi

Anda dapat memanggil library seperti yang ditunjukkan dalam cuplikan kode C# berikut

Lihat di GitHub

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 ke artikel wiki ini cara alternatif dalam menggunakan class AdManagerUser. Untuk informasi lebih detail tentang penggunaan Library Klien .NET, lihat ke README . Jika Anda ingin mengembangkan aplikasi di .NET tanpa library klien, lihat NoClientLibrary artikel wiki.

Ruby

Berikut adalah contoh dasar yang menunjukkan cara menggunakan Ruby library klien. 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-api
curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
```
Jika Anda menemukan error seperti "cannot load such file -- mkmf (LoadError)" kapan saja saat menginstal gem, Anda mungkin perlu menginstal pustaka pengembangan ruby tambahan seperti ruby-dev, ruby-devel, xcode-select, dll. untuk lingkungan khusus Anda.
Menyiapkan kredensial
Isi kolom wajib diisi di ~/ad_manager_api.yml . Jika Anda belum memiliki keyfile OAuth2, Anda harus mengikuti langkah-langkah untuk membuat OAuth2 kredensial.
```
:authentication:
  :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
  :application_name: INSERT_APPLICATION_NAME_HERE
  :network_code: INSERT_NETWORK_CODE_HERE
```

Tulis 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, :v202408)

# Make a request.
network = network_service.get_current_network()

puts "The current network is %s (%d)." %
        [network[:display_name], network[:network_code]]

Lihat di GitHub

Langkah-langkah yang lebih detail untuk memulai dapat ditemukan di README yang didistribusikan dengan pustaka klien Ruby. Selain itu, lihat lengkap library contoh untuk Ruby.

Langkah berikutnya

Saat Anda memiliki library klien yang aktif dan berjalan, ubah contoh yang diberikan untuk memperluasnya untuk kebutuhan Anda.

Baca dokumentasi referensi untuk mempelajari lebih lanjut tentang API.

Jika Anda memerlukan bantuan, buka halaman Dukungan kami.

Mulai

Mendapatkan akses ke jaringan Ad Manager

Membuat kredensial autentikasi

Mengonfigurasi jaringan Ad Manager

Siapkan klien Anda

Java

Python

PHP

.NET

Ruby

Langkah berikutnya