Ambil resource PartnerLink dengan mengirimkan SearchPartnerLinksRequest.
Kolom parent permintaan wajib diisi. Tetapkan parent ke nama resource akun tertentu, menggunakan format:
accountTypes/{account_type}/accounts/{account}
Untuk fleksibilitas di berbagai kasus penggunaan, SearchPartnerLinksResponse
berisi semua resource PartnerLink dengan parent dalam permintaan adalah:
- Akun yang diidentifikasi oleh kolom
owner_account - Akun yang diidentifikasi oleh kolom
partner_account
Tetapkan header permintaan jika Anda mengakses akun parent menggunakan
link partner, akun pengelola Google Ads induk, atau akun partner Display & Video 360
induk.
Filter hasil untuk membatasi respons ke resource dengan atribut tertentu.
Metode Search menampilkan halaman hasil. Untuk mengambil semua resource untuk
permintaan, periksa next_page_token dan beri nomor halaman pada hasil.
Menetapkan header permintaan
Metode Search mendukung header login-account
untuk menentukan jalur akses kredensial Anda ke akun parent dalam
permintaan. Header linked-account tidak didukung untuk metode PartnerLinkService.
Lihat Tujuan dan header untuk mengetahui detail dan petunjuk tentang cara menetapkan header untuk berbagai skenario akses.
Filter hasil
Gunakan kolom filter permintaan untuk mengambil link partner tertentu. Kolom
filter adalah string yang menentukan kumpulan kondisi yang ingin Anda terapkan,
beserta apakah API harus menggabungkan kondisi menggunakan AND atau OR.
Baca selengkapnya tentang opsi dan sintaksis pemfilteran di
AIP-160: Pemfilteran.
Anda dapat menentukan filter menggunakan account_id akun pemilik atau akun partner:
owning_account.account_id:account_idakun pemilik.partner_account.account_id:account_idakun partner.
Misalnya, berikut adalah filter yang menampilkan semua penautan partner yang akun pemiliknya memiliki ID akun OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Berikut contoh lain dari filter. Tindakan ini akan menampilkan semua penautan partner yang
akun pemiliknya memiliki ID akun OWNING_ACCOUNT_ID atau
akun partnernya memiliki ID akun
PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
Mengubah filter tersebut untuk menggunakan AND, bukan OR, akan membatasi resource yang ditampilkan ke link partner tempat kedua akun pemilik memiliki ID akun OWNING_ACCOUNT_ID dan akun partner memiliki ID akun PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Memberi nomor halaman pada hasil
Gunakan kolom page_size untuk mengontrol jumlah hasil yang ditampilkan dalam satu
respons. Misalnya, jika Anda menetapkan page_size ke 10, API akan menampilkan maksimal 10 hasil per respons. API mungkin akan menampilkan kurang dari 10 hasil jika ada kurang dari 10 hasil yang cocok dengan permintaan Anda.
page_size default adalah 50 dan maksimumnya adalah 1.000.
Jika ada lebih banyak hasil daripada yang dapat dimuat dalam satu respons, respons akan menyertakan next_page_token. Untuk mengambil halaman atau kumpulan hasil berikutnya, kirim
permintaan yang sama lagi dengan kolom page_token yang ditetapkan ke nilai ini. Semua parameter lainnya harus sama dengan permintaan sebelumnya.
Jika kolom next_page_token tidak disertakan dalam respons, hal ini menunjukkan
bahwa tidak ada hasil lagi.