Panduan Cara Kerja

Halaman ini menyediakan detail tentang cara melakukan tugas umum menggunakan API.

Membuat Pengguna

UserService memungkinkan pengguna dengan hak Administrator untuk membuat pengguna langsung di jaringan mereka. Setiap developer dapat melakukannya tanpa meminta pengguna baru mendaftar terlebih dahulu. Misalnya, jika Anda mencoba API untuk pertama kali, daripada melakukan setiap panggilan API sebagai Administrator (setelan untuk alamat email), sebaiknya buat beberapa pengguna dengan peran Staf Penjualan, Pemroses Iklan, atau Pengiklan untuk menguji alur kerja di dunia nyata.

  1. Buat beberapa alamat Gmail baru seperti my.name.salesperson@gmail.com. Sebagai alternatif, mendaftarkan alamat non-gmail yang ada sebagai alamat Akun Google.
  2. Panggil createUsers dengan alamat baru tersebut dan Role yang dipilih.
  3. Anda dapat mengautentikasi sebagai pengguna baru tersebut, menggunakan OAuth 2.0 untuk membuat token akses.

Mendapatkan AdUnit Root

AdUnit teratas tempat Anda dapat menambahkan node turunan dan kedalaman hierarki yang diizinkan bergantung pada jenis akun Anda (Small Business atau Premium). AdUnit teratas yang mendukung modifikasi node turunannya disebut AdUnit root efektif.

Untuk mengambil root efektif, panggil NetworkService.getCurrentNetwork(), dan periksa kolom effectiveRootAdUnitId pada objek Network yang ditampilkan.

Catatan: Jenis akun yang berbeda mendukung pola hierarki yang berbeda.

Membuat Kueri untuk Objek

Anda menelusuri objek menurut kriteria penelusuran menggunakan metode getObjectsByStatement() diekspos oleh banyak layanan, di mana Object adalah jenis objek tertentu. Ini mengambil kueri PQL, yang mirip dengan kueri SQL karena memungkinkan Anda menentukan yang akan ditelusuri (nama kolom dipetakan ke properti pada objek), mengurutkan, membatasi, dan menyesuaikan hasil pencarian Anda. Lihat PQL Panduan untuk mempelajari PQL lebih lanjut, dan juga untuk mempelajari kolom objek mana yang dapat filter menurut.

Membuat Pesanan

Untuk membuat pesanan, cukup buat objek Order dan tetapkan pengiklan, staf penjualan, dan ID pemroses iklan ke pengguna yang sesuai, tetapkan nama unik, dan memanggil createOrders(). Hasilnya akan menyertakan Order yang baru dibuat, atau error.

Contoh

Lihat contoh kode Java untuk membuat pesanan.

Membuat Item Baris

Berikut langkah-langkah untuk membuat item baris baru:

  1. Buat objek Order baru atau gunakan objek yang sudah ada.
  2. Buat objek LineItem baru, lalu tetapkan jenis rotasi, array ukuran materi iklan, tanggal mulai dan akhir, serta properti lainnya.
  3. Buat objek InventoryTargeting baru, dan tentukan objek Placement atau AdUnit mana yang akan ditargetkan atau dikecualikan.
  4. Gabungkan objek InventoryTargeting Anda di dalam objek Targeting baru, dan tetapkan ke properti penargetan LineItem.
  5. Panggil metode layanan item baris createLineItems() dengan objek baru Anda, dan periksa hasilnya untuk mengetahui apakah objek Anda sudah dibuat.

Contoh

Lihat contoh kode Java untuk membuat item baris.

Membuat Materi Iklan

Berbagai jenis materi iklan mendukung komponen yang berbeda: misalnya gambar materi iklan mendukung satu file sumber untuk gambar; materi iklan flash mendukung dua file aset pokok: file flash dan file gambar cadangan, jika flash file tidak dapat ditayangkan. Untuk materi iklan yang dihosting di situs pihak ketiga, Anda harus mengupload hanya cuplikan HTML yang merujuk file pada server pihak ketiga. Lihat subclass Creative spesifik untuk mempelajari aset yang harus Anda upload secara berurutan untuk membuat materi iklan.

Contoh

Lihat contoh kode Java untuk membuat materi iklan gambar.

Mengubah Objek yang Ada

Untuk mengubah objek yang ada, buat kueri untuk objek Anda dengan memanggil getObjectsByStatement(), perbarui nilai dalam objek yang ditampilkan, lalu panggil updateObjects().

Catatan: Objek yang diperbarui akan sepenuhnya menggantikan objek yang ada, jadi jika Anda lalai menetapkan nilai properti pada objek yang Anda kirim, objek yang disimpan akan dapatkan nilai {i>default<i} untuk properti tersebut, bukan nilai sebelumnya.

Mengubah Status Objek

Status objek diubah dengan memanggil metode performObjectAction() diekspos oleh layanan Anda. Metode ini menggunakan dua parameter:

  • Instance objek tindakan yang mendeskripsikan tindakan yang ingin Anda lakukan. Sebagai instance, layanan pesanan mengekspos beberapa tindakan termasuk ApproveOrders, PauseOrders, dan ArchiveOrders. Semua objek tindakan berasal dari tindakan dasar yang sesuai untuk layanan Anda.
  • Kueri PQL yang menjelaskan objek mana yang akan diubah. Anda dapat mengubah status satu atau beberapa objek pada satu waktu dengan menentukan PQL yang sesuai pernyataan pribadi Anda.

Membuat Tag Iklan

Anda tidak dapat membuat tag iklan menggunakan API; sebagai gantinya, Anda harus menggunakan situs Google Ad Manager. Lihat bagian Pemberian Tag Bagian Pusat Bantuan untuk informasi selengkapnya.

Contoh Lainnya

Anda bisa menemukan lebih banyak contoh dalam kode contoh library klien kami, di beberapa bahasa pemrograman yang berbeda. Lihat Pustaka Klien & Kode Contoh untuk link ke contoh dalam bahasa pemrograman Anda.