Recuperar links de parceiros

Recupere recursos PartnerLink enviando um 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 é um destes:

• A conta identificada pelo campo owner_account
• A conta identificada pelo campo partner_account

Defina cabeçalhos de solicitação se estiver acessando a conta parent usando um link de parceiro, uma conta de administrador principal do Google Ads ou uma conta de parceiro principal do Display & Video 360.

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 next_page_token e paginar resultados.

Definir cabeçalhos de solicitação

O método Search aceita os cabeçalhos login-account e linked-account para definir o caminho de acesso das suas credenciais à conta parent na solicitação. 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 deve combinar as condições usando AND ou OR. Leia mais sobre as opções e a sintaxe de filtragem em AIP-160: filtragem.

É possível definir o filter usando o account_id da conta proprietária ou da conta de parceiro:

• owning_account.account_id: o account_id da conta proprietária.
• partner_account.account_id: o account_id da conta de parceiro.

Por exemplo, aqui está um filter que retorna todos os links de parceiro em que a conta proprietária tem o ID OWNING_ACCOUNT_ID:

owning_account.account_id = OWNING_ACCOUNT_ID

Confira outro exemplo de filter. Isso retorna todos os links de parceiro 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

Modificar esse filter para usar AND em vez de OR limita os recursos retornados aos links de parceiro em que ambas as contas têm ID OWNING_ACCOUNT_ID e 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.