Panduan Cara Kerja

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

Membuat Pengguna

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

1. Buat beberapa alamat Gmail baru seperti [e-mail]. Atau, daftarkan alamat non-gmail yang ada sebagai Akun Google baru.
2. Panggil createUsers dengan alamat baru tersebut dan Role yang dipilih.
3. Anda dapat melakukan autentikasi 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 paling atas yang mendukung modifikasi node turunannya disebut root efektif AdUnit.

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

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

Membuat kueri untuk Objek

Anda menelusuri objek berdasarkan kriteria penelusuran menggunakan metode getObjectsByStatement() yang diekspos oleh banyak layanan, di mana Object adalah jenis objek tertentu. Metode ini menggunakan kueri PQL, yang mirip dengan kueri SQL karena memungkinkan Anda menentukan kolom yang akan ditelusuri (dengan nama kolom dipetakan ke properti pada objek), mengurutkan, membatasi, dan melakukan offset pada hasil penelusuran. Lihat Panduan PQL untuk mempelajari PQL lebih lanjut, serta mempelajari kolom objek yang dapat difilter.

Membuat Pesanan

Untuk membuat pesanan, cukup buat objek Order dan tetapkan ID pengiklan, staf penjualan, dan pemroses iklan ke pengguna yang sesuai, tetapkan nama unik, dan panggil 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 yang sudah ada.
2. Buat objek LineItem baru, dan 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 yang akan ditargetkan atau dikecualikan.
4. Gabungkan objek InventoryTargeting Anda di dalam objek Targeting baru, dan tetapkan ke properti penargetan LineItem Anda.
5. Panggil metode layanan item baris createLineItems() dengan objek baru, dan periksa hasilnya untuk melihat apakah objek Anda dibuat.

Contoh

Lihat contoh kode Java untuk membuat item baris.

Membuat Materi Iklan

Berbagai jenis materi iklan mendukung komponen yang berbeda: misalnya, materi iklan gambar mendukung satu file sumber untuk gambar; materi iklan flash mendukung dua file aset pokok: file flash dan file gambar cadangan, jika file flash tidak dapat ditayangkan. Untuk materi iklan yang dihosting di situs pihak ketiga, Anda hanya akan mengupload cuplikan HTML yang merujuk ke file tersebut di server pihak ketiga. Lihat subclass Creative spesifik Anda untuk mempelajari aset yang harus diupload 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 dalam objek yang Anda kirim, objek yang disimpan akan mendapatkan nilai default untuk properti tersebut, bukan nilai sebelumnya.

Mengubah Status Objek

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

• Instance objek tindakan yang menjelaskan tindakan yang ingin Anda lakukan. Misalnya, layanan pesanan menampilkan beberapa tindakan termasuk ApproveOrders, PauseOrders, dan ArchiveOrders. Semua objek tindakan berasal dari class tindakan dasar yang sesuai untuk layanan Anda.
• Kueri PQL yang menjelaskan objek yang akan diubah. Anda dapat mengubah status satu atau beberapa objek sekaligus dengan menentukan pernyataan PQL yang sesuai.

Membuat Tag Iklan

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

Contoh Lainnya

Anda dapat menemukan lebih banyak contoh di kode contoh library klien kami, dalam berbagai bahasa pemrograman. Lihat halaman Library Klien & Kode Contoh untuk link ke contoh dalam bahasa pemrograman Anda.