Récupérez les ressources PartnerLink en envoyant un SearchPartnerLinksRequest.
Le champ parent de la demande est obligatoire. Définissez 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, SearchPartnerLinksResponse contient toutes les ressources PartnerLink où parent dans la requête est :
- Compte identifié par le champ
owner_account - Compte identifié par le champ
partner_account
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, vérifiez next_page_token et paginez les résultats.
Définir les en-têtes de requête
La méthode Search accepte 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 obtenir des informations et des instructions sur la façon de définir les en-têtes pour différents scénarios d'accès, consultez Destinations et en-têtes.
Filtrer les résultats
Utilisez le champ filter 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 la manière dont 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:account_iddu compte propriétaire.partner_account.account_id:account_iddu compte partenaire.
Par exemple, voici un filter qui renvoie tous les liens partenaires dont le compte propriétaire possède l'ID de compte OWNING_ACCOUNT_ID :
owning_account.account_id = OWNING_ACCOUNT_ID
Voici un autre exemple de filter. Cette requête renvoie tous les liens partenaires dont le compte propriétaire a l'ID de compte OWNING_ACCOUNT_ID ou dont 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 filter pour utiliser AND au lieu de OR, les ressources renvoyées seront 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 renverra au maximum 10 résultats par réponse. Il est possible que l'API renvoie moins de 10 résultats si le nombre de résultats correspondant à votre requête est inférieur à 10.
La valeur par défaut page_size est 50 et la valeur maximale est 1 000.
Si le nombre de résultats est supérieur à ce qui peut tenir dans une seule réponse, la réponse inclut un next_page_token. Pour récupérer la page ou l'ensemble de résultats suivants, 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.