Search Ads 360 Reporting API versi sebelumnya akan dihentikan dan dinonaktifkan pada 30 Juni 2024. Perhatikan bahwa Search Ads 360 Conversion API tidak terpengaruh dan akan terus didukung. Semua pengembangan pelaporan baru harus menggunakan Search Ads 360 Reporting API versi baru.

Mulai April 2024, error supportedApiVersion akan ditampilkan saat meminta laporan. Lihat detailnya di sini.

Sebaiknya migrasikan juga penerapan Search Ads 360 yang ada ke API baru. Lihat Memulai dan Panduan Migrasi Search Ads 360 Reporting API versi baru untuk mendapatkan informasi selengkapnya.

Halaman ini diterjemahkan oleh Cloud Translation API.

Aplikasi Pertama Anda: Prasyarat

Sebelum dapat memulai coding aplikasi klien pertama Anda, ada beberapa hal yang perlu dilakukan, jika Anda belum melakukannya.

Buat Akun Google dan dapatkan izin Search Ads 360

Untuk menggunakan Search Ads 360 API, Anda memerlukan Akun Google dan izin yang sesuai yang diberikan ke akun tersebut dari Search Ads 360:

Buat Akun Google jika Anda belum memilikinya.
Minta Pengelola Agensi Search Ads 360 untuk membuat pengguna Search Ads 360 untuk Akun Google Anda.

Untuk mendownload laporan, Anda memerlukan izin lihat untuk pengiklan yang akan bekerja sama dengan Anda.

Untuk menambahkan atau mengedit konversi, Anda memerlukan izin edit untuk pengiklan yang akan bekerja sama dengan Anda. Dalam konfigurasi Floodlight bersama, Anda memerlukan izin edit untuk setiap pengiklan turunan yang ingin Anda upload konversinya. Anda tidak memerlukan akses ke pengiklan induk, juga tidak memerlukan akses ke pengiklan turunan yang konversinya tidak Anda upload. Jika menggunakan ID klik untuk mengatribusikan konversi ke kunjungan, pastikan Anda memiliki akses edit ke pengiklan yang menghasilkan ID klik. Jika Anda menentukan ID klik dari pengiklan yang akses editnya tidak Anda miliki, permintaan tidak akan berhasil.

Pengelola Agensi dapat menyiapkan akun Anda sebagai Pengguna pengiklan dengan akses ke pengiklan tertentu, atau menyiapkan akun Anda dengan tingkat akses yang lebih tinggi seperti Pengguna agensi dengan akses ke semua pengiklan di agensi ini.

Mengaktifkan Layanan Konversi API

Jika Anda ingin mengupload data tentang konversi, pengguna Search Ads 360 yang memiliki hak istimewa Pengelola Agensi harus login ke UI Search Ads 360 dan mengaktifkan layanan konversi API. Lihat pusat bantuan Search Ads 360 untuk mendapatkan petunjuk.

Membuat project Konsol API Google dan kredensial OAuth untuk klien Anda

Mulai alat penyiapan Konsol API Google.
Alat penyiapan ini akan memandu Anda membuat project (atau menggunakan project yang sudah ada), mengaktifkan Search Ads 360 API, dan membuat kredensial OAuth 2.0.
Pada halaman Register your application, pilih project yang sudah ada atau pilih Create a project. Selanjutnya, klik Lanjutkan.
Setelah Google API Console mengaktifkan Search Ads 360 API, klik tombol Buka kredensial.
Di halaman Create credentials, masukkan informasi berikut:
- API mana yang Anda gunakan?: API Search Ads 360
- Data apa yang akan Anda akses?: Data pengguna
Klik tombol Berikutnya.
Alat penyiapan kini menawarkan untuk membantu Anda membuat client ID OAuth 2.0.
Ikuti langkah selanjutnya di alat penyiapan.

Menginstal sa360Api.py

Search Ads 360 menyediakan skrip utilitas untuk memfasilitasi proses penyiapan otorisasi. Anda juga dapat menggunakan skrip ini untuk mengirim dan menerima data dalam format JSON, jika ingin mencoba mengirim dan menerima data sebelum mendesain dan menulis aplikasi lengkap. Anda dapat menyalin banyak contoh JSON di situs dokumentasi ini dan memasukkannya langsung ke skrip.

Untuk menginstal skrip:

Instal Python 2.7.
Skrip tidak berfungsi dengan Python 3.x.
Menginstal cURL.
Mendownload sa360Api.zip.
Ekstrak sa360Api.py dari sa360Api.zip.
Menjadikan sa360Api.py dapat dieksekusi.

Mempelajari dasar-dasar REST

Ada dua cara untuk memanggil API:

Menggunakan library klien.
Mengirim permintaan HTTP dan mengurai respons.

Jika memutuskan untuk tidak menggunakan library klien, Anda harus memahami dasar-dasar REST.

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

Istilah REST adalah singkatan dari "Representational State Transfer". Dalam konteks Google API, 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 serta 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. Instance ini menentukan resource berdasarkan URI yang unik secara global dengan bentuk 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.

Sebaiknya lihat definisi metode dalam dokumentasi standar HTTP 1.1; definisi tersebut mencakup spesifikasi untuk GET, POST, PUT, dan DELETE.

REST di Search Ads 360 API

Operasi Search Ads 360 API dipetakan langsung ke kata kerja HTTP REST.

Format spesifik untuk URI Search Ads 360 API adalah:

https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters

Kumpulan lengkap URI yang digunakan untuk setiap operasi yang didukung di API diringkas dalam Referensi API.

Mempelajari dasar-dasar JSON

Jika menggunakan REST, Anda harus menggunakan format JSON untuk isi permintaan. Anda dapat menentukan bahwa responsnya dibuat dalam format JSON atau CSV.

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