1. Crear una concesión de autorización
Empezando: descripción general | 1. Crear concesión de autorización | 2. Generar token de acceso | 3. Recuperar perfiles
Paso 1: Cree una concesión de autorización
Como se describe en la descripción general de "Introducción" , una aplicación de cliente aprobada puede realizar llamadas a la API de Amazon Ads en nombre de una cuenta de usuario de Amazon con acceso a cuentas de Amazon Ads.
La relación entre la aplicación cliente y la cuenta de usuario es administrada por Login with Amazon (LwA). La cuenta de usuario debe otorgar autorización explícita a la aplicación del cliente a través del LwA's Authorization Code Grant process para generar un código de autorización como se describe a continuación.
- Para obtener más información sobre la autorización en la API de Amazon Ads, consulte Descripción general de la autorización .
Existen dos escenarios para solicitar y otorgar autorización para acceder a los datos publicitarios y servicios asociados a una cuenta de usuario:
- Anunciante directo(Direct Advertiser) : desea utilizar la API para acceder a los datos y servicios publicitarios asociados con su propia cuenta de Amazon.
- Socio(Partner) : Un tercero quiere autorizarte a acceder a los datos publicitarios y servicios asociados a su cuenta de Amazon.
Para cualquier escenario, creará una URL de autorización.
Crear una URL de autorización
Para recuperar un código de autorización, cree una URL de autorización que permita que una cuenta de usuario otorgue autorización a su aplicación cliente. Este proceso implica tres pasos:
- Permitir una URL de retorno
- Determine el prefijo de URL para su región
- Determinar los valores para los parámetros de consulta requeridos
Permitir una URL de retorno
Inicie sesión en la consola de desarrollador de Amazon utilizando su cuenta de desarrollador de Amazon y seleccione Login with Amazon en el menú superior.
Elija el perfil de seguridad que usó para solicitar el acceso a la API, mueva el mouse al ícono de "engranaje" debajo de Manage en el lado derecho de la pantalla y seleccione Web Settings en el menú.
En el panel Configuración web, haga clic en Edit . Agregue una dirección válida en el campo Allowed Return URLs y haga clic en Save .
¿Qué es una URL de retorno permitida?
Cualquier URL que agregue a la lista "URL de retorno permitidas" se puede usar como parámetro
redirect_uri
en "Determinar los valores para los parámetros de consulta requeridos" a continuación. Después de que un anunciante otorga autorización a su cliente LwA, el anunciante será redirigido a la URL especificada, con el código de autorización adjunto como parámetro de consulta. Cualquiera de estos enfoques puede resultar mejor para su caso de uso:
- Socios(Partners) que buscan autorización de terceros eventualmente deseen crear una URL de retorno personalizada o usar LwA junto con su propia aplicación. Para obtener más información sobre este método, consulte la documentación de Iniciar sesión con Amazon.
- Anunciantes directos(Direct Advertisers) pueden usar cualquier URL válida,
https://amazon.com
por ejemplo, y luego recuperar manualmente el código de autorización como se describe a continuación.El resto de este tutorial sigue el segundo método.
Determine el prefijo de URL para su región
Login with Amazon implementa un prefijo de URL de autorización diferente para cada región. Seleccione la URL para su región de la siguiente tabla.
Región | prefijo de URL |
---|---|
América del Norte (NA) | https://www.amazon.com/ap/oa |
Europa (UE) | https://eu.account.amazon.com/ap/oa |
Lejano Oriente (FE) | https://apac.account.amazon.com/ap/oa |
Nota
Se puede usar un código de autorización obtenido de cualquiera de estas URL para acceder a la API de publicidad en cualquier región.
Importante
Si esta concesión de autorización es para la Data Provider API , recuerde que creó una cuenta DSP separada para cada región. Debe repetir este proceso tres veces, una vez para cada una de las regiones descritas anteriormente.
Determinar los valores para los parámetros de consulta requeridos
La URL de autorización tiene los siguientes parámetros de consulta:
Parámetro | Descripción |
---|---|
client_id | El client_id asociado con su aplicación de cliente Login with Amazon. Para obtener información sobre cómo ubicar su client_id, consulte Crear un inicio de sesión con la aplicación de Amazon . |
scope | El ámbito de permiso de OAuth 2.0 utilizado para limitar el acceso de la aplicación a la cuenta de un anunciante. Para las API de DSP, Sponsored Brands, Sponsored Display, Sponsored Products y Amazon Attribution, configure scope en advertising::campaign_management . Para la Data Provider API, establezca scope en advertising::audiences . |
response_type | El tipo de respuesta. Establecido siempre en code . |
redirect_uri | El valor del campo Allowed Return URLs de su perfil de seguridad Login with Amazon, como se establece anteriormente. |
Nota
Para obtener información sobre parámetros opcionales, consulte Concesiones de autorización .
Para generar un código de autorización en la región de América del Norte (NA), reemplace YOUR_LWA_CLIENT_ID
y YOUR_RETURN_URL
en la siguiente URL con sus valores:
https://www.amazon.com/ap/oa?client_id=YOUR_LWA_CLIENT_ID&scope=advertising::campaign_management&response_type=code&redirect_uri=YOUR_RETURN_URL
Nota
Es posible que los clientes de LwA que fueron aprobados para acceder a la API antes de octubre de 2020 deban configurar
scope
paracpc_advertising:campaign_management
.
Para otorgar acceso a sus propios datos de Amazon Ads
Para obtener instrucciones sobre cómo obtener acceso a los datos de un tercero, consulte "Para obtener acceso a los datos de Amazon Ads de un tercero" a continuación .
Si está otorgando permiso para acceder a sus propios datos y servicios publicitarios, siga estos pasos:
- Pegue la URL de autorización determinada anteriormente en la barra de direcciones de su navegador. Navegue a la URL.
- Inicie sesión con una cuenta de usuario de Amazon con acceso a las cuentas de Amazon Ads que desea administrar a través de la API. Es posible que esta cuenta no sea la misma que la cuenta de desarrollador de Amazon que utilizó para crear el cliente LwA.
- Será redirigido a un formulario de consentimiento que enumera los datos y servicios específicos incluidos en la concesión de la autorización. Para otorgar acceso, seleccione Allow .
- Se le redirigirá al
redirect_uri
que especificó anteriormente, con los parámetros de consulta adjuntos a la URL. Copie la dirección de la barra de direcciones de su navegador y anote el valor del parámetrocode
(xxxx
en el ejemplo a continuación):
https://www.amazon.com/?code=xxxxxxxxxxxxxxxxxxx&scope=advertising%3A%3Acampaign_management
Para continuar, consulte "Pasos siguientes" a continuación .
Para obtener acceso a los datos de Amazon Ads de un tercero
Si está solicitando que un tercero le dé acceso a sus datos publicitarios y servicios, siga estos pasos:
- Envíe la URL de autorización determinada anteriormente al tercero, con instrucciones para pegar la URL en la barra de direcciones de su navegador y navegar hasta la URL.
- Indique al tercero que inicie sesión con la cuenta de usuario de Amazon que tiene acceso a las cuentas de Amazon Ads para las que desea otorgar autorización.
- El tercero será redirigido a un formulario de consentimiento que enumera los datos y servicios específicos incluidos en la concesión de la autorización. Indique al tercero que seleccione Allow si acepta compartir estos datos y servicios con usted.
- Serán redirigidos al
redirect_uri
que especificó anteriormente, con parámetros de consulta adjuntos a la URL. Indique al tercero que le envíe esta URL.
Tenga en cuenta el valor del parámetro code
( xxxx
en el ejemplo a continuación):
https://www.amazon.com/?code=xxxxxxxxxxxxxxxxxxx&scope=advertising%3A%3Acampaign_management
Próximos pasos
El parámetro code
en la URL de redireccionamiento es un authorization code , que ahora puede usar en el siguiente paso del proceso de incorporación: Recuperar tokens de acceso y actualización .
Importante
Los códigos de autorización caducan después de 5 minutos. Se puede generar un nuevo código repitiendo los pasos anteriores.
Apoyo técnico
Si tiene dificultades para conectarse a la API de Amazon Ads, visite nuestra página de Soporte técnico para obtener información.
Updated over 1 year ago