SearchPartnerLinksRequest を送信して PartnerLink リソースを取得します。
リクエストの parent フィールドは必須です。parent を特定のアカウントのリソース名に設定します。形式は次のとおりです。
accountTypes/{account_type}/accounts/{account}
さまざまなユースケースに対応できるように、SearchPartnerLinksResponse
には、リクエストの parent が
次のいずれかであるすべての PartnerLink リソースが含まれます。
owner_accountフィールドで識別されるアカウントpartner_accountフィールドで識別されるアカウント
リクエスト ヘッダーを設定します。parent アカウントにアクセスする場合は、
パートナー リンク、親 Google 広告マネージャー アカウント、または親ディスプレイ＆ビデオ 360 パートナー
アカウントを使用します。
結果をフィルタして、レスポンスを特定の 属性を持つリソースに限定します。
Search メソッドは、結果のページを返します。リクエストのすべてのリソースを取得するには、next_page_token を確認して結果をページ分けします。
リクエスト ヘッダーを設定する
Search メソッドは、リクエストの parent アカウントへの認証情報のアクセス パスを定義する login-account ヘッダーをサポートしています。linked-account ヘッダーは PartnerLinkService
メソッドではサポートされていません。
さまざまなアクセス シナリオでヘッダーを設定する方法について詳しくは、宛先とヘッダーをご覧ください。
結果をフィルタする
特定のアカウント リンクを取得するには、リクエストの filter フィールドを使用します。filter フィールドは、適用する条件のセットを定義する文字列です。また、API で AND または OR を使用して条件を結合するかどうかも定義します。フィルタ オプションと構文について詳しくは、
AIP-160: フィルタリングをご覧ください。
filter は、所有アカウントまたはパートナー アカウントの account_id を使用して定義できます。
owning_account.account_id: 所有アカウントのaccount_id。partner_account.account_id: パートナー アカウントのaccount_id。
たとえば、所有アカウントの ID が OWNING_ACCOUNT_ID であるすべてのアカウント リンクを返す filter は次のようになります。
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
OR の代わりに AND を使用するように filter を変更すると、返される
リソースは、所有アカウントの 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 フィールドを使用して、1 回のレスポンスで返される結果の数を制御します。たとえば、page_size を 10 に設定すると、API はレスポンスごとに最大 10 件の結果を返します。 リクエストに一致する結果が 10 件未満の場合、API は 10 件未満の結果を返すことがあります。
デフォルトの page_size は 50、最大値は 1,000 です。
1 回のレスポンスに収まらない結果がある場合、レスポンスには next_page_token が含まれます。次のページまたは結果セットを取得するには、page_token フィールドをこの値に設定して、同じリクエストを再度送信します。他のすべてのパラメータは、前のリクエストと同じにする必要があります。
レスポンスに next_page_token フィールドが含まれていない場合、これ以上結果がないことを示します。