Para recuperar recursos PartnerLink, envía una solicitud SearchPartnerLinksRequest.
El campo parent de la solicitud es obligatorio. Configura parent con el nombre de recurso de una cuenta específica, con el siguiente formato:
accountTypes/{account_type}/accounts/{account}
Para brindar flexibilidad en diferentes casos de uso, SearchPartnerLinksResponse
contiene todos los recursos PartnerLink en los que parent en la solicitud es
uno de los siguientes:
- La cuenta identificada por el campo
owner_account - La cuenta identificada por el campo
partner_account
Configura los encabezados de solicitud si accedes a la cuenta parent con
un vínculo de socio, una cuenta de administrador de Google Ads superior o una cuenta de socio superior de Display & Video 360.
Filtra los resultados para limitar la respuesta a los recursos con atributos específicos.
El método Search muestra páginas de resultados. Para recuperar todos los recursos de una
solicitud, verifica next_page_token y pagina los resultados.
Configura los encabezados de solicitud
El método Search admite el encabezado login-account para definir la ruta de acceso de tus credenciales a la cuenta parent en la solicitud. El encabezado linked-account no es compatible con los PartnerLinkService
métodos.
Consulta Destinos y encabezados para obtener detalles e instrucciones sobre cómo configurar los encabezados para diferentes situaciones de acceso.
Filtrar resultados
Usa el campo filter de la solicitud para recuperar vínculos de socio específicos. El campo filter es una cadena que define el conjunto de condiciones que deseas aplicar, junto con si la API debe combinar las condiciones con AND o OR.
Obtén más información sobre las opciones de filtrado y la sintaxis en
AIP-160: Filtering.
Puedes definir el filter con el account_id de la cuenta propietaria o de la cuenta de socio:
owning_account.account_id: Elaccount_idde la cuenta propietaria.partner_account.account_id: Elaccount_idde la cuenta de socio.
Por ejemplo, aquí hay un filter que muestra todos los vínculos de socio en los que la cuenta propietaria tiene el ID de cuenta OWNING_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID
Aquí hay otro ejemplo de un filter. Esto muestra todos los vínculos de socio en los que la cuenta propietaria tiene el ID de cuenta OWNING_ACCOUNT_ID o la cuenta de socio tiene el ID de cuenta PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
Si modificas ese filter para usar AND en lugar de OR, los recursos que se muestran se limitan a los vínculos de socio en los que tanto la cuenta propietaria tiene el ID de cuenta OWNING_ACCOUNT_ID como la cuenta de socio tiene el ID de cuenta PARTNER_ACCOUNT_ID:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
Paginar los resultados
Usa el campo page_size para controlar la cantidad de resultados que se muestran en una sola respuesta. Por ejemplo, si configuras page_size en 10, la API mostrará como máximo 10 resultados por respuesta. Es posible que la API muestre menos de 10 resultados si hay menos de 10 resultados que coincidan con tu solicitud.
El page_size predeterminado es 50 y el máximo es 1,000.
Si hay más resultados de los que caben en una sola respuesta, la respuesta incluirá un next_page_token. Para recuperar la siguiente página o conjunto de resultados, vuelve a enviar la misma solicitud con el campo page_token configurado en este valor. Todos los demás parámetros deben ser los mismos que en la solicitud anterior.
Si el campo next_page_token no se incluye en la respuesta, significa que no hay más resultados.