Haz tu primera llamada
Haz tu primera llamada a la Amazon Ads API
Puede usar la Ads API para administrar campañas, extraer datos de reportes y más. Este tutorial lo ayuda a comprender cómo enumerar todas sus campañas activas de anuncios patrocinados (productos patrocinados, marcas patrocinadas y exhibición patrocinada) utilizando el endpoint GET de las campañas relevantes.
Antes de empezar
Nota
Este tutorial asume que ya completó los procesos de Inducción y de Empezar para la Ads API.
Para completar este tutorial, asegúrese de tener:
- Acceso a la Ads API
- Un client ID de la aplicación de Login with Amazon
- Un token de acceso válido
- Un profile ID para una cuenta de Amazon Ads
Pedido
prefijos de URL
El prefijo que debe usar al llamar a la Ads API se basa en la geografía del profile utilizado en la solicitud.
URL | Región y marketplaces |
---|---|
https://publicidad-api.amazon.com | América del Norte (NA). Cubre los marketplaces de US, CA, MX y BR |
https://publicidad-api-eu.amazon.com | Europa (UE). Cubre los marketplaces del Reino Unido, FR, IT, ES, DE, NL, AE, PL y TR |
https://publicidad-api-fe.amazon.com | Lejano Oriente (FE). Cubre los marketplaces de JP, AU y SG. |
Headers
La mayoría de las llamadas a la Amazon Ads API requieren Headers comunes:
Header | ¿Requerido? | Descripción |
---|---|---|
Amazon-Advertising-API-ClientId | Sí | El ID de cliente relacionado con una aplicación de Login with Amazon. |
Authorization | Sí | Un token de acceso a la API válido con el formato Bearer access_token . Un token de acceso solo es válido durante una hora. |
Amazon-Advertising-API-Scope | Sí | profile ID de Amazon Ads. |
Accept | No | El Header de aceptación se utiliza para especificar la versión. Si no Accept se especifica ningún Header, el valor predeterminado es application/json . |
Solicitudes de muestra
Si está copiando las muestras, asegúrese de ingresar su propio client ID, access token, y profile ID.
Productos patrocinados
Referencia completa: POST sp/campaigns/list
cURL
Este ejemplo muestra una lista de solicitudes de campañas de Sponsored Products con el prefijo de URL de América del Norte.
curl --location --request POST 'https://advertising-api.amazon.com/sp/campaigns/list' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxxxxxx' \
--header 'Accept: application/vnd.spCampaign.v3+json' \
--header 'Content-Type: application/vnd.spCampaign.v3+json' \
Postman
- Asegúrese de tener la colección de Amazon Ads API Postman y los archivos de entorno importados a Postman. Si no ha completado la configuración de Postman, consulte nuestro tutorial de Postman .
- Desde Postman, navegue hasta la colección de la Amazon Ads API .
- Vaya a la carpeta First call y abra el endpoint
POST
List SB campaigns . - En la pestaña Headers , asegúrese de que sus variables de entorno se completen correctamente.
- Envía tu solicitud.
Marcas patrocinadas
Referencia completa: POST sb/beta/campaigns/list
cURL
Este ejemplo muestra una lista de solicitudes de campañas de Sponsored Brands con el prefijo de URL de América del Norte.
curl --location --request GET 'https://advertising-api.amazon.com/sb/beta/campaigns/list' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxxxxxx' \
--header 'Accept: application/vnd.sbcampaignresource.v4+json'
--header 'Content-Type: application/vnd.sbcampaignresource.v4+json'
Postman
- Asegúrese de tener la colección de Amazon Ads API Postman y los archivos de entorno importados a Postman. Si no ha completado la configuración de Postman, consulte nuestro tutorial de Postman .
- Desde Postman, navegue hasta la colección de la Amazon Ads API .
- Vaya a la carpeta First call y abra el endpoint
POST
List SB campaigns . - En la pestaña Headers , asegúrese de que sus variables de entorno se completen correctamente.
- Envía tu solicitud.
Exhibición patrocinada
Referencia completa: GET sd/campaigns
cURL
Este ejemplo muestra una solicitud de OBTENER campañas de Display patrocinado con el prefijo de URL de América del Norte.
curl --location --request GET 'https://advertising-api.amazon.com/sd/campaigns' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
--header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxxxxxx' \
Postman
- Asegúrese de tener la colección de Amazon Ads API Postman y los archivos de entorno importados a Postman. Si no ha completado la configuración de Postman, consulte nuestro tutorial de Postman .
- Desde Postman, navegue hasta la colección de la Amazon Ads API .
- Vaya a la carpeta First call y abra el punto de conexión
GET
List SD campaigns . - En la pestaña Headers , asegúrese de que sus variables de entorno se completen correctamente.
- Envía tu solicitud.
Respuesta
Una respuesta exitosa a cualquiera de los extremos de las campañas GET devuelve un 200
código de respuesta. El cuerpo de la respuesta contiene una matriz JSON de objetos de campaña.
Muestra
La siguiente respuesta de muestra contiene una campaña de Display patrocinado.
[
{
"campaignId": 127519806194475,
"name": "SdTestCampaign-26/01/2022 15:37:31",
"tactic": "T00020",
"startDate": "20220126",
"state": "enabled",
"costType": "cpc",
"budget": 100,
"budgetType": "daily",
"deliveryProfile": "as_soon_as_possible"
}
]
Recibir una respuesta vacía
Si aún no ha creado ninguna campaña de un determinado tipo de anuncio, recibirá una respuesta 200
que contiene un array JSON vacía ( []
). Para comprobar si tienes campañas activas, inicia sesión en la advertising console.
Consejo
Si es nuevo en Amazon Ads y no tiene ninguna campaña, intente crear una cuenta de prueba . Una vez que tenga una cuenta de prueba, puede practicar la creación de campañas sin afectar su gasto.
Próximos pasos
Ahora que comprende la estructura básica de solicitud y respuesta de la Amazon Ads API, puede comenzar a trabajar en el caso de uso que se adapte a sus necesidades.
Para anunciantes con campañas activas
- Solicitar un sponsored ads report
- Solicitar un sponsored ads snapshot
- Crear campañas manuales de Sponsored Products
Para anunciantes nuevos en Amazon Ads
Updated over 1 year ago