Partnerlinks abrufen

Rufen Sie PartnerLink-Ressourcen ab, indem Sie eine SearchPartnerLinksRequest-Anfrage senden.

Das Feld parent der Anfrage ist erforderlich. Legen Sie parent auf den Ressourcennamen eines bestimmten Kontos fest. Verwenden Sie dazu das folgende Format:

accountTypes/{account_type}/accounts/{account}

Um Flexibilität für verschiedene Anwendungsfälle zu bieten, enthält die SearchPartnerLinksResponse alle PartnerLink Ressourcen, bei denen parent in der Anfrage entweder Folgendes ist:

  • Das Konto, das durch das Feld owner_account identifiziert wird
  • Das Konto, das durch das Feld partner_account identifiziert wird

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

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

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

Anfrageheader festlegen

Die Methode Search unterstützt den Header login-account, um den Zugriffspfad Ihrer Anmeldedaten zum 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 Gruppe der Bedingungen definiert, die Sie anwenden möchten, und gibt an, ob die API die Bedingungen mit AND oder OR kombinieren soll. Weitere Informationen zu Filteroptionen und -syntax finden Sie unter AIP-160: Filtering.

Sie können 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 ein Beispiel für einen 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 einen filter. Dieser gibt alle Partnerlinks zurück, 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 diesen filter so ändern, dass AND anstelle von OR verwendet wird, werden die zurückgegebenen Ressourcen auf die Partnerlinks 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

Mit dem Feld page_size können Sie die Anzahl der Ergebnisse steuern, die in einer einzelnen Antwort zurückgegeben werden. Wenn Sie page_size beispielsweise auf 10 festlegen, gibt die API maximal 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 ist 1.000.

Wenn es mehr Ergebnisse gibt, als in eine einzelne Antwort passen, enthält die Antwort ein next_page_token. Wenn Sie die nächste Seite oder Gruppe von Ergebnissen abrufen möchten, senden Sie dieselbe Anfrage noch einmal und legen Sie das Feld page_token auf diesen Wert fest. Alle anderen Parameter müssen mit 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