Recupera recursos PartnerLink enviando un SearchPartnerLinksRequest.
El campo parent de la solicitud es obligatorio. Establece parent en el nombre del recurso de una cuenta específica con el siguiente formato:
accountTypes/{account_type}/accounts/{account}
Para brindar flexibilidad en diferentes casos de uso, el objeto SearchPartnerLinksResponse contiene todos los recursos PartnerLink en los que el objeto parent de 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 de parent a través de un vínculo de socio, una cuenta de administrador principal de Google Ads o una cuenta de socio principal de Display & Video 360.
Filtrar resultados para limitar la respuesta a los recursos con atributos específicos
El método Search devuelve páginas de resultados. Para recuperar todos los recursos de una solicitud, verifica next_page_token y pagina los resultados.
Cómo establecer encabezados de solicitud
El método Search admite los encabezados login-account y linked-account para definir la ruta de acceso de tus credenciales a la cuenta de parent en la solicitud. 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 socios específicos. El campo filter es una cadena que define el conjunto de condiciones que deseas aplicar, junto con la indicación de si la API debe combinar las condiciones con AND o OR.
Obtén más información sobre las opciones y la sintaxis de filtrado en AIP-160: Filtrado.
Puedes definir filter con el account_id de la cuenta propietaria o de la cuenta de socio:
owning_account.account_id: Es elaccount_idde la cuenta propietaria.partner_account.account_id: Es elaccount_idde la cuenta de socio.
Por ejemplo, aquí tienes un filter que devuelve 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
Este es otro ejemplo de un filter. Devuelve todos los vínculos de socios 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 que use AND en lugar de OR, se limitan los recursos devueltos 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 devolverá como máximo 10 resultados por respuesta. Es posible que la API devuelva menos de 10 resultados si hay menos de 10 resultados que coincidan con tu solicitud.
El valor predeterminado de page_size es 50 y el máximo es 1,000.
Si hay más resultados de los que caben en una sola respuesta, esta incluirá un next_page_token. Para recuperar la página siguiente o el siguiente conjunto de resultados, vuelve a enviar la misma solicitud con el campo page_token establecido en este valor. Todos los demás parámetros deben ser iguales a los de la solicitud anterior.
Si el campo next_page_token no se incluye en la respuesta, significa que no hay más resultados.