擷取合作夥伴連結

傳送 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 標頭,可定義憑證在要求中存取 parent 帳戶的路徑。PartnerLinkService 方法不支援 linked-account 標頭。

如需詳細資訊和操作說明,瞭解如何為不同存取情境設定標頭,請參閱「目的地和標頭」。

篩選結果

使用要求的 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 欄位,表示沒有更多結果。