Latar belakang

Sebelum memulai

  1. Minta perwakilan akun Anda untuk menyiapkan izin yang tepat untuk akun yang akan diakses oleh aplikasi Anda.
  2. Jika Anda tidak memahami konsep Authorized Buyers, buka Pusat Bantuan Authorized Buyers dan lakukan eksperimen dengan antarmuka pengguna. Jika aplikasi Anda diharapkan melakukan bidding real-time, baca dokumentasi Protokol RTB.
  3. Buka Konsol API untuk menyiapkan project baru. Login ke Akun Google developer Anda atau buat akun. Kemudian, Anda akan diminta untuk membuat project dan menyetujui beberapa Persyaratan Layanan.

Akun orang tua dan anak

Jika menggunakan struktur akun yang berisi akun induk dan turunan, Anda mungkin dapat bekerja secara lebih efektif jika memahami cara mereka berinteraksi. Berikut ringkasan singkatnya:

Akun turunan

Pengguna dengan kredensial yang memberikan akses ke akun turunan hanya dapat melihat dan mengubah resource yang terkait dengan akunnya. Akun turunan tidak dapat melihat atau mengubah resource milik akun turunan atau akun induk yang lain.

Akun orang tua

Pengguna dengan kredensial yang memberikan akses ke akun induk dapat melihat dan mengubah resource untuk akun induk, selain semua akun turunan yang terkait. Untuk operasi yang mencantumkan semua resource yang diberikan, pengguna ini akan menerima respons yang mencakup data untuk akun mereka dan semua akun turunannya. Perhatikan bahwa untuk jenis permintaan lain yang menargetkan resource untuk kursi turunan, akun induk harus menentukan parameter jalur accountId untuk akun turunan, bukan accountId-nya sendiri.

Model data REST API

Resource adalah entity data individual dengan ID unik. Resource akun mewakili entri akun Authorized Buyers, dan merupakan class data root untuk Ad Exchange Buyer API. Metode API beroperasi pada resource Akun individual, dan pada kumpulan resource Akun.

Resource Akun mencakup: ID Akun, informasi yang digunakan dalam pencocokan cookie, lokasi bidder, URL tujuan pengiriman permintaan bid, dan permintaan untuk menentukan kueri maksimum per detik yang akan dikirim oleh Ad Exchange.

Selain resource dan pengumpulan Akun, Ad Exchange Buyer API menentukan struktur data berikut:

Lokasi bidder

Lokasi bidder adalah struktur yang ditampilkan dengan Resource Akun untuk memberikan URL tujuan pengiriman permintaan bid oleh Ad Exchange dan jumlah maksimum kueri per detik yang harus dikirim oleh Ad Exchange. Berikut contoh lokasi bidder, yang dinyatakan dalam JSON:

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

Item

Item akan menampilkan daftar akun. Berikut ini contoh item, yang dinyatakan dalam JSON:

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

Operasi yang didukung

Anda dapat memanggil tiga metode berbeda pada koleksi dan resource di Ad Exchange Buyer API seperti yang dijelaskan dalam tabel berikut. Semua operasi memerlukan otorisasi.

Operasi Deskripsi Pemetaan HTTP REST
list Mencantumkan semua akun yang dapat diakses oleh pengguna yang saat ini diautentikasi. GET pada URI koleksi.
dapatkan Mendapatkan resource Akun tertentu. GET pada URI resource.
pembaruan Memperbarui resource Akun tertentu. PUT di URI resource, tempat Anda meneruskan data untuk resource yang diupdate.

Gaya panggilan

REST adalah gaya arsitektur software yang memberikan pendekatan yang praktis dan konsisten untuk meminta dan memodifikasi data.

Istilah REST adalah singkatan dari "Representational State Transfer". Dalam konteks Google API, ini mengacu pada penggunaan kata kerja HTTP untuk mengambil dan mengubah representasi data yang disimpan oleh Google.

Dalam sistem RESTful, resource disimpan di penyimpanan data; klien mengirim permintaan agar server melakukan tindakan tertentu (seperti membuat, mengambil, memperbarui, atau menghapus resource), dan server melakukan tindakan dan mengirim respons, sering kali dalam bentuk representasi resource yang ditentukan.

Di RESTful API Google, klien menentukan tindakan menggunakan kata kerja HTTP seperti POST, GET, PUT, atau DELETE. Class ini menetapkan resource melalui URI unik global dengan form berikut:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Karena semua resource API memiliki URI unik yang dapat diakses HTTP, REST memungkinkan caching data dan dioptimalkan untuk berfungsi dengan infrastruktur terdistribusi web.

Anda dapat memperoleh manfaat dari definisi metode dalam dokumentasi standar HTTP 1.1; dokumentasi tersebut menyertakan spesifikasi untuk GET, POST, PUT, dan DELETE.

REST di Ad Exchange Buyer API

Operasi yang didukung dipetakan langsung ke kata kerja HTTP REST, seperti yang dijelaskan dalam operasi API.

Format spesifik untuk URI API adalah:

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

dengan resourceID adalah ID untuk resource Akun, dan parameters adalah parameter yang akan diterapkan pada kueri. Lihat parameter kueri standar dan dokumentasi referensi untuk mengetahui detailnya.

Format ekstensi jalur resourceID memungkinkan Anda mengidentifikasi resource yang saat ini Anda operasikan, misalnya:

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

Kumpulan lengkap URI yang digunakan untuk setiap operasi yang didukung dalam API diringkas dalam dokumentasi referensi.

Berikut adalah contoh cara kerjanya di Ad Exchange Buyer API.

Dapatkan daftar akun pengguna terautentikasi:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

Format data

JSON

JSON (JavaScript Object Notation) adalah format data umum independen bahasa yang memberikan representasi teks sederhana untuk struktur data arbitrer. Untuk informasi selengkapnya, lihat json.org.