Recupera le risorse PartnerLink inviando un SearchPartnerLinksRequest.
Il campo parent della richiesta è obbligatorio. Imposta parent sul nome della risorsa di un account specifico, utilizzando il formato:
accountTypes/{account_type}/accounts/{account}
Per garantire la flessibilità in diversi casi d'uso, SearchPartnerLinksResponse
contiene tutte le risorse PartnerLink in cui parent nella richiesta è:
- L'account identificato dal campo
owner_account - L'account identificato dal campo
partner_account
Imposta le intestazioni della richiesta se accedi all'account parent utilizzando un link partner, un account amministratore Google Ads principale o un account partner Display & Video 360 principale.
Filtra i risultati per limitare la risposta alle risorse con attributi specifici.
Il metodo Search restituisce pagine di risultati. Per recuperare tutte le risorse per una richiesta, controlla next_page_token e impagina i risultati.
Imposta le intestazioni della richiesta
Il metodo Search supporta l'intestazione login-account per definire il percorso di accesso delle tue credenziali all'account parent nella richiesta. L'intestazione linked-account non è supportata per i metodi PartnerLinkService.
Per informazioni dettagliate e istruzioni su come impostare le intestazioni per i diversi scenari di accesso, consulta Destinazioni e intestazioni.
Filtra risultati
Utilizza il campo filter della richiesta per recuperare link partner specifici. Il campo filter è una stringa che definisce l'insieme di condizioni che vuoi applicare, oltre a indicare se l'API deve combinare le condizioni utilizzando AND o OR.
Scopri di più sulle opzioni e sulla sintassi di filtro in AIP-160: Filtering.
Puoi definire filter utilizzando account_id dell'account proprietario o dell'account partner:
owning_account.account_id:account_iddell'account proprietario.partner_account.account_id: l'account_iddell'account partner.
Ad esempio, ecco un filter che restituisce tutti i link partner in cui l'account proprietario ha l'ID account OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Ecco un altro esempio di filter. Vengono restituiti tutti i link dei partner in cui l'account proprietario ha l'ID account OWNING_ACCOUNT_ID o l'account partner ha l'ID account PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
Se modifichi filter in modo da utilizzare AND anziché OR, le risorse restituite vengono limitate ai link partner in cui sia l'account proprietario ha l'ID account OWNING_ACCOUNT_ID sia l'account partner ha l'ID account PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Impagina i risultati
Utilizza il campo page_size per controllare il numero di risultati restituiti in una singola risposta. Ad esempio, se imposti page_size su 10, l'API restituirà al massimo 10 risultati per risposta. È possibile che l'API restituisca meno di 10 risultati se sono presenti meno di 10 risultati corrispondenti alla tua richiesta.
Il valore predefinito di page_size è 50 e il valore massimo è 1000.
Se i risultati sono più di quelli che possono essere contenuti in una singola risposta, la risposta includerà un next_page_token. Per recuperare la pagina o l'insieme di risultati successivi, invia di nuovo la stessa richiesta con il campo page_token impostato su questo valore. Tutti gli altri parametri devono essere uguali a quelli della richiesta precedente.
Se il campo next_page_token non è incluso nella risposta, significa che non ci sono altri risultati.