傳送 SearchPartnerLinksRequest 即可擷取 PartnerLink 資源。
要求必須包含 parent 欄位。使用以下格式,將 parent 設為特定帳戶的資源名稱:
accountTypes/{account_type}/accounts/{account}
為因應不同用途的彈性需求,SearchPartnerLinksResponse 包含所有 PartnerLink 資源,其中要求中的 parent 符合下列任一條件:
- 由
owner_account欄位識別的帳戶 - 由
partner_account欄位識別的帳戶
如果您是透過合作夥伴連結、上層 Google Ads 管理員帳戶或上層 Display & Video 360 合作夥伴帳戶存取 parent 帳戶,請設定要求標頭。
篩選結果,將回應限制為具有特定屬性的資源。
Search 方法會傳回結果頁面。如要擷取要求的所有資源,請檢查 next_page_token 並將結果分頁。
設定要求標頭
Search 方法支援 login-account 和 linked-account 標頭,可在要求中定義憑證的存取路徑至 parent 帳戶。如需詳細資料和不同存取情境的標頭設定說明,請參閱「目的地和標頭」。
篩選結果
使用要求的 filter 欄位擷取特定合作夥伴連結。filter 欄位是字串,用於定義要套用的一組條件,以及 API 應使用 AND 或 OR 合併條件。如要進一步瞭解篩選選項和語法,請參閱 AIP-160:篩選。
您可以使用擁有者帳戶或合作夥伴帳戶的 account_id 定義 filter:
owning_account.account_id:擁有者帳戶的account_id。partner_account.account_id:合作夥伴帳戶的account_id。
舉例來說,以下 filter 會傳回所有合作夥伴連結,其中擁有帳戶的帳戶 ID 為 OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
以下是另一個 filter 的範例。這會傳回所有合作夥伴連結,其中擁有帳戶的帳戶 ID 為 OWNING_ACCOUNT_ID,或合作夥伴帳戶的帳戶 ID 為 PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
將該 filter 修改為使用 AND (而非 OR),可將傳回的資源限制為同時擁有帳戶 ID OWNING_ACCOUNT_ID 和帳戶 ID PARTNER_ACCOUNT_ID 的合作夥伴連結:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
分頁顯示結果
使用 page_size 欄位控管單一回應中傳回的結果數量。舉例來說,如果將 page_size 設為 10,API 每個回應最多會傳回 10 個結果。如果符合要求結果少於 10 個,API 可能會傳回少於 10 個結果。
預設 page_size 為 50,上限為 1000。
如果結果數量超過單一回應可容納的範圍,回應中就會包含 next_page_token。如要擷取下一頁或下一組結果,請再次傳送相同要求,並將 page_token 欄位設為這個值。其他所有參數都必須與先前的要求相同。
如果回應中未包含 next_page_token 欄位,表示沒有其他結果。