Membuat permintaan langsung

Sebaiknya Anda menggunakan klien library dan contoh untuk implementasi Anda. Namun, jika integrasi Anda dengan API memiliki kebutuhan khusus, seperti menggunakan bahasa yang tidak didukung, Anda dapat membuat permintaan langsung seperti dijelaskan di bawah ini.

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 AdSense Management API

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

Format khusus untuk URI AdSense Management API adalah:

https://adsense.googleapis.com/v2/resourceID?parameters

dengan resourceID adalah ID untuk iklan klien, unit iklan, saluran URL, saluran khusus atau kumpulan laporan, dan parameters adalah parameter apa pun yang akan diterapkan kueri.

Format ekstensi jalur resourceID memungkinkan Anda mengidentifikasi sumber daya tempat Anda beroperasi saat ini, untuk contoh:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

Kumpulan lengkap URI yang digunakan untuk setiap operasi yang didukung dalam API adalah diringkas dalam Referensi AdSense Management API dokumen.

Berikut adalah beberapa contoh cara kerjanya di AdSense Management API.

Daftar klien iklan:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

Cantumkan unit iklan di klien iklan ca-pub-1234567890123456:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

Format data

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.

Mengotorisasi permintaan

Perhatikan bahwa AdSense tidak mendukung Akun Layanan, tetapi Anda harus menggunakan alur Aplikasi Terpasang.

Setiap permintaan yang dikirimkan aplikasi Anda ke AdSense Management API harus menyertakan token otorisasi. Token ini juga mengidentifikasi aplikasi Anda ke Google.

Tentang protokol otorisasi

Aplikasi Anda harus menggunakan OAuth 2.0 untuk mengizinkan permintaan. Tidak ada protokol otorisasi lain yang didukung. Jika aplikasi Anda menggunakan Login dengan Google, beberapa aspek otorisasi akan ditangani untuk Anda.

Mengizinkan permintaan dengan OAuth 2.0

Semua permintaan ke AdSense Management API harus diizinkan oleh pengguna terautentikasi.

Proses ini difasilitasi dengan client ID OAuth.

Mendapatkan client ID OAuth

Atau buat satu di halaman Credentials.

Detail proses otorisasi, atau "alur", untuk OAuth 2.0 bervariasi bergantung pada jenis aplikasi yang Anda tulis. Proses umum berikut berlaku untuk semua jenis aplikasi:

  1. Saat memerlukan akses ke data pengguna, aplikasi Anda akan meminta cakupan akses tertentu kepada Google.
  2. Google menampilkan layar izin kepada pengguna, yang meminta mereka mengizinkan aplikasi Anda untuk meminta beberapa data.
  3. Jika pengguna menyetujui, Google akan memberikan token akses berumur singkat ke aplikasi Anda.
  4. Aplikasi Anda meminta data pengguna, dengan menambahkan token akses ke permintaan.
  5. Jika Google menentukan bahwa permintaan Anda dan token tersebut valid, data yang diminta akan ditampilkan.

Beberapa alur mencakup langkah tambahan, seperti penggunaan token refresh untuk memperoleh token akses baru. Informasi selengkapnya tentang alur untuk berbagai jenis aplikasi dapat dilihat di dokumentasi OAuth 2.0 Google.

Berikut adalah informasi cakupan OAuth 2.0 untuk AdSense Management API:

Cakupan Arti
https://www.googleapis.com/auth/adsense Akses baca/tulis ke data AdSense.
https://www.googleapis.com/auth/adsense.readonly Akses hanya baca ke data AdSense.

Untuk meminta akses menggunakan OAuth 2.0, aplikasi Anda memerlukan informasi cakupan, serta informasi yang disediakan oleh Google saat Anda mendaftarkan aplikasi (seperti ID klien dan rahasia klien).

Tips: Library klien Google API dapat menangani beberapa proses otorisasi secara otomatis. Library klien ini tersedia untuk berbagai bahasa pemrograman. Periksa halaman yang menjelaskan library beserta contohnya untuk mendapatkan informasi lebih mendetail.

Membuat permintaan

Langkah terakhir adalah membuat permintaan API. Lihat dokumentasi referensi untuk informasi tidak akurat atau tidak sesuai.