Partnerlinks abrufen

Rufen Sie PartnerLink-Ressourcen ab, indem Sie einen SearchPartnerLinksRequest senden.

Das Feld parent der Anfrage ist erforderlich. Legen Sie für parent den Ressourcennamen eines bestimmten Kontos im folgenden Format fest:

accountTypes/{account_type}/accounts/{account}

Für Flexibilität bei verschiedenen Anwendungsfällen enthält die SearchPartnerLinksResponse alle PartnerLink-Ressourcen, bei denen die parent in der Anfrage entweder:

  • Das durch das Feld owner_account identifizierte Konto
  • Das durch das Feld partner_account identifizierte Konto

Legen Sie Anfrageheader fest, wenn Sie über einen Partnerlink, ein übergeordnetes Google Ads-Verwaltungskonto oder ein übergeordnetes Display & Video 360-Partnerkonto auf das parent-Konto zugreifen.

Filtern Sie die Ergebnisse, um die Antwort auf Ressourcen mit bestimmten Attributen zu beschränken.

Die Methode Search gibt Ergebnisseiten zurück. Wenn Sie alle Ressourcen für eine Anfrage abrufen möchten, prüfen Sie das next_page_token und paginieren Sie die Ergebnisse.

Anfrageheader festlegen

Die Methode Search unterstützt den Header login-account, um den Zugriffspfad Ihrer Anmeldedaten auf das parent-Konto in der Anfrage zu definieren. Der linked-account-Header wird für PartnerLinkService-Methoden nicht unterstützt.

Weitere Informationen und Anleitungen zum Festlegen der Header für verschiedene Zugriffsszenarien finden Sie unter Ziele und Header.

Ergebnisse filtern

Verwenden Sie das Feld filter der Anfrage, um bestimmte Partnerlinks abzurufen. Das Feld filter ist ein String, der die anzuwendenden Bedingungen definiert und angibt, ob die API die Bedingungen mit AND oder OR kombinieren soll. Weitere Informationen zu Filteroptionen und zur Syntax finden Sie unter AIP-160: Filtern.

Sie können die filter mit der account_id des Inhaberkontos oder des Partnerkontos definieren:

  • owning_account.account_id: Die account_id des Inhaberkontos.
  • partner_account.account_id: Die account_id des Partnerkontos.

Hier ist beispielsweise ein filter, der alle Partnerlinks zurückgibt, bei denen das Inhaberkonto die Konto-ID OWNING_ACCOUNT_ID hat:

owning_account.account_id = OWNING_ACCOUNT_ID

Hier ist ein weiteres Beispiel für eine filter. Dadurch werden alle Partnerlinks zurückgegeben, bei denen das Inhaberkonto die Konto-ID OWNING_ACCOUNT_ID oder das Partnerkonto die Konto-ID PARTNER_ACCOUNT_ID hat:

owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID

Wenn Sie filter so ändern, dass AND anstelle von OR verwendet wird, werden die zurückgegebenen Ressourcen auf die Partnerverknüpfungen beschränkt, bei denen sowohl das Inhaberkonto die Konto-ID OWNING_ACCOUNT_ID als auch das Partnerkonto die Konto-ID PARTNER_ACCOUNT_ID hat:

owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID

Paginierungsergebnisse

Verwenden Sie das Feld page_size, um die Anzahl der Ergebnisse zu steuern, die in einer einzelnen Antwort zurückgegeben werden. Wenn Sie beispielsweise page_size auf 10 festlegen, gibt die API höchstens 10 Ergebnisse pro Antwort zurück. Es ist möglich, dass die API weniger als 10 Ergebnisse zurückgibt, wenn weniger als 10 Ergebnisse mit Ihrer Anfrage übereinstimmen.

Der Standardwert für page_size ist 50 und der Höchstwert 1.000.

Wenn mehr Ergebnisse vorhanden sind, als in eine einzelne Antwort passen, enthält die Antwort ein next_page_token. Wenn Sie die nächste Seite oder den nächsten Ergebnissatz abrufen möchten, senden Sie dieselbe Anfrage noch einmal, wobei das Feld page_token auf diesen Wert gesetzt ist. Alle anderen Parameter müssen mit denen der vorherigen Anfrage übereinstimmen.

Wenn das Feld next_page_token nicht in der Antwort enthalten ist, gibt es keine weiteren Ergebnisse.

Zurück
Partnerlink erstellen oder löschen