En esta guía, se describe la estructura común de todas las llamadas a la API.
Si usas una biblioteca cliente para interactuar con la API, no podrás debes preocuparte por los detalles de la solicitud subyacente. Sin embargo, saber un poco sobre ellas puede ser útil cuando se hacen pruebas y depuraciones.
La API de Google Ads es una API de gRPC, con vinculaciones de REST. Esto significa que hay dos formas de realizar llamadas a la API.
[Preferido] Crea el cuerpo de la solicitud como un búfer de protocolo, envíalo al servidor con HTTP/2, deserializa la respuesta a un protocolo almacenar en búfer e interpretar los resultados. La mayor parte de nuestra documentación describe el uso gRPC.
[Opcional] Crea el cuerpo de la solicitud como un objeto JSON, envíalo al servidor mediante HTTP 1.1 deserializar la respuesta como un objeto JSON y, luego, interpretar los resultados. Consulta la guía Interfaz REST para obtener más información sobre el uso REST
Nombres de recursos
La mayoría de los objetos en la API se identifican por sus cadenas de nombre de recurso. Estos también funcionan como URLs cuando se usa la interfaz REST. Consulta REST los nombres de recursos de la interfaz para sus en la nube.
IDs compuestos
Si el ID de un objeto no es único a nivel global, un ID compuesto para ese objeto se crea anteponiendo su ID superior y una virgulilla (~).
Por ejemplo, dado que el ID de un grupo de anuncios no es único globalmente, anteponemos su el ID de objeto superior (grupo de anuncios) para crear un ID compuesto único:
AdGroupIdde123+~+AdGroupAdIdde45678= anuncio compuesto con el ID de anuncio del grupo123~45678.
Encabezados de la solicitud
Estos son los encabezados HTTP (o grpc, metadatos) que acompañan el cuerpo de la solicitud:
Autorización
Debes incluir un token de acceso OAuth2 en la forma de
Authorization: Bearer YOUR_ACCESS_TOKEN que identifica un
cuenta de administrador que actúa en nombre de un cliente o un anunciante directamente
administrar su propia cuenta. Instrucciones para recuperar un token de acceso
en la guía de OAuth2. Los
el token de acceso es válido durante una hora después de su adquisición; cuando
vence, actualiza el token de acceso para recuperar uno nuevo. Ten en cuenta que
nuestras bibliotecas cliente actualizan
automáticamente los tokens vencidos.
developer-token
Un token de desarrollador es una cadena de 22 caracteres que identifica de forma única a un desarrollador de la API de Google Ads. Un ejemplo de cadena de token de desarrollador es
ABcdeFGH93KL-NOPQ_STUv El token de desarrollador se debe incluir en la
formato de developer-token : ABcdeFGH93KL-NOPQ_STUv.
login-customer-id
Este es el ID de cliente del cliente autorizado que se usará en la solicitud.
sin guiones (-). Si accedes a la cuenta del cliente mediante un
de administrador, este encabezado es obligatorio y debe establecerse en el ID de cliente de
la cuenta de administrador.
https://googleads.googleapis.com/v17/customers/1234567890/campaignBudgets:mutate
Configurar el login-customer-id equivale a elegir una cuenta en la
IU de Google Ads después de acceder o hacer clic en tu imagen de perfil en la parte superior
bien. Si no incluyes este encabezado, se establecerá de forma predeterminada el valor operativo
cliente.
linked-customer-id
Considera una situación en la que los usuarios de la cuenta A otorgan acceso de lectura y edición
a sus entidades para la cuenta B a través de un
ThirdPartyAppAnalyticsLink
Una vez que se realiza la vinculación, un usuario de la cuenta B puede realizar llamadas a la API de la cuenta A, sujeto a los permisos que proporciona la vinculación. En este caso, el vínculo de terceros a la cuenta B determina los permisos de llamada a la API a la cuenta A, en lugar de la relación cuenta-administrador que se usa en otras llamadas a la API.
El proveedor de estadísticas de aplicaciones de terceros realiza una llamada a la API de la siguiente manera:
linked-customer-id: Es la cuenta de estadísticas de aplicaciones de terceros que sube. los datos (cuentaB).customer-id: Es la cuenta de Google Ads a la que se suben los datos (cuentaA).- Encabezados
login-customer-idyAuthorization: Una combinación de valores para identificar a un usuario que tiene acceso a la cuentaB.
Encabezados de respuesta
Los siguientes encabezados (o grpc matching-metadata) se devuelven con el cuerpo de la respuesta. Recomendamos que registres estos con fines de depuración.
request-id
El request-id es una cadena que identifica esta solicitud de forma exclusiva.