Récupérer les liens de partenaires

Récupérez les ressources PartnerLink en envoyant une SearchPartnerLinksRequest.

Le champ parent de la requête est obligatoire. Définissez le parent sur le nom de ressource d'un compte spécifique, au format suivant :

accountTypes/{account_type}/accounts/{account}

Pour plus de flexibilité dans différents cas d'utilisation, le SearchPartnerLinksResponse contient toutes les ressources PartnerLink où le parent de la requête est l'un des éléments suivants :

• Le compte identifié par le owner_account champ
• Le compte identifié par le partner_account champ

Définissez les en-têtes de requête si vous accédez au compte parent à l'aide d'un lien partenaire, d'un compte administrateur Google Ads parent ou d'un compte partenaire Display & Video 360 parent.

Filtrez les résultats pour limiter la réponse aux ressources présentant des attributs spécifiques.

La méthode Search renvoie des pages de résultats. Pour récupérer toutes les ressources d'une requête, cochez le next_page_token et paginez les résultats.

Définir les en-têtes de requête

La méthode Search est compatible avec les en-têtes login-account et linked-account pour définir le chemin d'accès de vos identifiants au compte parent dans la requête. Pour en savoir plus et obtenir des instructions sur la définition des en-têtes pour différents scénarios d'accès, consultez Destinations et en-têtes pour plus de détails.

Filtrer les résultats

Utilisez le filter champ de la requête pour récupérer des liens partenaires spécifiques. Le champ filter est une chaîne qui définit l'ensemble des conditions que vous souhaitez appliquer, ainsi que si l'API doit combiner les conditions à l'aide de AND ou OR. Pour en savoir plus sur les options de filtrage et la syntaxe, consultez AIP-160 : Filtrage.

Vous pouvez définir le filter à l'aide du account_id du compte propriétaire ou du compte partenaire :

• owning_account.account_id : Le account_id du compte propriétaire.
• partner_account.account_id : account_id du compte partenaire.

Voici un exemple de filter qui renvoie tous les liens partenaires où le compte propriétaire a l'ID de compte OWNING_ACCOUNT_ID :

owning_account.account_id = OWNING_ACCOUNT_ID

Voici un autre exemple de filter. Il renvoie tous les liens partenaires où le compte propriétaire a l'ID de compte OWNING_ACCOUNT_ID ou le compte partenaire a l'ID de compte PARTNER_ACCOUNT_ID :

owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID

Si vous modifiez ce filter pour utiliser AND au lieu de OR, les ressources renvoyées sont limitées aux liens partenaires où à la fois le compte propriétaire a l'ID de compte OWNING_ACCOUNT_ID et le compte partenaire a l'ID de compte PARTNER_ACCOUNT_ID :

owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID

Paginer les résultats

Utilisez le champ page_size pour contrôler le nombre de résultats renvoyés dans une seule réponse. Par exemple, si vous définissez page_size sur 10, l'API renvoie au maximum 10 résultats par réponse. Il est possible que l'API renvoie moins de 10 résultats si moins de 10 résultats correspondent à votre requête.

La valeur par défaut de page_size est 50 et la valeur maximale est 1 000.

Si le nombre de résultats est supérieur à celui pouvant être inclus dans une seule réponse, la réponse inclura un next_page_token. Pour récupérer la page ou l'ensemble de résultats suivant, renvoyez la même requête avec le champ page_token défini sur cette valeur. Tous les autres paramètres doivent être identiques à ceux de la requête précédente.

Si le champ next_page_token n'est pas inclus dans la réponse, cela signifie qu'il n'y a plus de résultats.