SearchPartnerLinksRequest を送信して PartnerLink リソースを取得します。
リクエストの parent フィールドは必須です。parent を特定のアカウントのリソース名に設定します。形式は次のとおりです。
accountTypes/{account_type}/accounts/{account}
さまざまなユースケースに対応できるように、SearchPartnerLinksResponse には、リクエストの parent が次のいずれかであるすべての PartnerLink リソースが含まれています。
owner_accountフィールドで識別されるアカウントpartner_accountフィールドで識別されるアカウント
パートナー リンク、親 Google 広告クライアント センター（MCC）アカウント、または親ディスプレイ＆ビデオ 360 パートナー アカウントを使用して parent アカウントにアクセスする場合は、リクエスト ヘッダーを設定します。
結果をフィルタして、特定の属性を持つリソースのみをレスポンスに含めます。
Search メソッドは結果のページを返します。リクエストのすべてのリソースを取得するには、next_page_token と結果をページ分けします。
リクエスト ヘッダーを設定する
Search メソッドは、リクエストで parent アカウントに対する認証情報のアクセスパスを定義するために、login-account ヘッダーと linked-account ヘッダーをサポートしています。さまざまなアクセス シナリオでヘッダーを設定する方法の詳細と手順については、宛先とヘッダーをご覧ください。
結果をフィルタする
リクエストの filter フィールドを使用して、特定のパートナー リンクを取得します。filter フィールドは、適用する条件のセットと、API が AND または OR を使用して条件を結合するかどうかを定義する文字列です。フィルタ オプションと構文の詳細については、AIP-160: フィルタリングをご覧ください。
filter は、所有アカウントまたはパートナー アカウントの account_id を使用して定義できます。
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 を OR ではなく AND を使用するように変更すると、返されるリソースは、所有アカウントの 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 フィールドが含まれていない場合、それ以上結果がないことを示します。