Latar belakang

Sebelum memulai

  1. Minta perwakilan akun Anda untuk menyiapkan izin yang tepat untuk akun yang akan diakses aplikasi Anda.
  2. Jika Anda kurang memahami konsep Authorized Buyers, buka Pusat Bantuan Authorized Buyers dan bereksperimen dengan antarmuka pengguna. Jika aplikasi Anda diharapkan menjalankan bidding real-time, baca Protokol RTB.
  3. Kunjungi Konsol API untuk menyiapkan project baru. Login ke Akun Google developer Anda atau membuat akun. Anda kemudian akan diminta untuk membuat project dan keluar dari berdasarkan beberapa Persyaratan Layanan.

Akun orang tua dan anak

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

Akun turunan

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

Akun orang tua

Pengguna dengan kredensial yang memberikan akses ke akun induk dapat melihat dan mengubah aset untuk akun induk selain semua yang terkait akun anak. Untuk operasi yang mencantumkan semua sumber daya yang diberikan, pengguna ini akan menerima tanggapan, termasuk data untuk akun mereka dan semua akun anak. Perhatikan bahwa untuk jenis permintaan lain yang menargetkan resource untuk slot turunan, akun induk harus menentukan parameter jalur accountId untuk turunan bukan accountId mereka sendiri.

Model data REST API

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

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

Selain referensi dan pengumpulan Akun, Ad Exchange Buyer API mendefinisikan struktur data berikut ini:

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 adalah contoh lokasi bidder, yang dinyatakan dalam JSON: 

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

Item

Item memberikan daftar akun. Berikut adalah contoh item, yang dinyatakan dalam JSON: 

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

Operasi yang didukung

Anda bisa memanggil tiga metode berbeda pada koleksi dan resource dalam 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 autentikasi yang saat ini . GET pada URI koleksi.
dapatkan Mendapatkan resource Akun tertentu. GET pada URI resource.
info terbaru Memperbarui resource Akun tertentu. PUT pada URI resource, tempat Anda meneruskan data untuk resource yang diperbarui.

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, REST merujuk pada penggunaan kata kerja HTTP untuk mengambil dan memodifikasi 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. Kata kerja ini menentukan resource berdasarkan URI yang unik secara global untuk 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 khusus 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 tempat Anda beroperasi saat ini, 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 adalah diringkas dalam dokumentasi referensi.

Berikut adalah contoh cara kerjanya di Ad Exchange Buyer API.

Dapatkan daftar akun pengguna yang diautentikasi:

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.