Recupere PartnerLink recursos enviando uma SearchPartnerLinksRequest.
O campo parent da solicitação é obrigatório. Defina o parent como o nome do recurso de uma conta específica, usando o formato:
accountTypes/{account_type}/accounts/{account}
Para flexibilidade em diferentes casos de uso, o SearchPartnerLinksResponse
contém todos os recursos PartnerLink em que o parent na solicitação é
- A conta identificada pelo campo
owner_account - A conta identificada pelo campo
partner_account
Defina os cabeçalhos de solicitação se estiver acessando a conta parent usando
um link de parceiro, uma conta de administrador do Google Ads principal ou uma conta de parceiro do Display & Video 360 principal
Filtre os resultados para limitar a resposta a recursos com atributos específicos.
O método Search retorna páginas de resultados. Para recuperar todos os recursos de uma
solicitação, verifique o next_page_token e pagine os resultados.
Definir cabeçalhos de solicitação
O método Search oferece suporte ao cabeçalho login-account para definir o caminho de acesso das suas credenciais à conta parent na solicitação. O cabeçalho linked-account não é compatível com os métodos PartnerLinkService.
Consulte Destinos e cabeçalhos para mais detalhes e instruções sobre como definir os cabeçalhos para diferentes cenários de acesso.
Filtrar resultados
Use o campo filter da solicitação para recuperar links de parceiros específicos. O campo filter é uma string que define o conjunto de condições que você quer aplicar, além de indicar se a API precisa combinar as condições usando AND ou OR.
Saiba mais sobre as opções e a sintaxe de filtragem em
AIP-160: filtragem.
Você pode definir o filter usando o account_id da conta proprietária ou da conta de parceiro:
owning_account.account_id: oaccount_idda conta proprietária.partner_account.account_id: Oaccount_idda conta de parceiro.
Por exemplo, este é um filter que retorna todos os links de parceiros em que a conta proprietária tem o ID OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Confira outro exemplo de filter. Ele retorna todos os links de parceiros em que a conta proprietária tem o ID OWNING_ACCOUNT_ID ou a conta de parceiro tem o ID PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
A modificação desse filter para usar AND em vez de OR limita os recursos retornados aos links de parceiros em que tanto a conta proprietária tem o ID OWNING_ACCOUNT_ID quanto a conta de parceiro tem o ID PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Paginar resultados
Use o campo page_size para controlar o número de resultados retornados em uma única resposta. Por exemplo, se você definir page_size como 10, a API vai retornar no máximo 10 resultados por resposta. É possível que a API retorne menos de 10 resultados se houver menos de 10 resultados que correspondam à sua solicitação.
O page_size padrão é 50, e o máximo é 1.000.
Se houver mais resultados do que cabem em uma única resposta, ela vai incluir um next_page_token. Para recuperar a próxima página ou conjunto de resultados, envie a mesma solicitação novamente com o campo page_token definido como esse valor. Todos os outros parâmetros precisam ser iguais à solicitação anterior.
Se o campo next_page_token não estiver incluído na resposta, isso indica que não há mais resultados.