Paso 3: Recuperar una profile ID

Como se describe en la descripción general de "Introducción" , existen dos credenciales de autorización esenciales para llamar a la API de Amazon Ads:

• El ID de cliente de una aplicación cliente de Login with Amazon (LwA) que está aprobada para el acceso a la API.
• Un token de acceso que representa el permiso para que ese cliente acceda a los recursos en nombre de una cuenta de usuario de Amazon que administra cuentas de Amazon Ads.

Además, casi todas las solicitudes a la API requieren una profile ID que represente la cuenta publicitaria del usuario en un marketplace específico . Una vez que haya generado un token de acceso , siga los pasos a continuación para recuperar una identificación de perfil para usar en solicitudes a la API.

• Para revisar los pasos hasta el momento, consulte la descripción general de "Introducción" .
• Para obtener información conceptual sobre los perfiles en la API de Amazon Ads, consulte Perfiles .

Acceder al recurso Profiles

Para recuperar una lista de Profiles disponibles, realice una solicitud GET al endpoint /v2/profiles en una región donde la cuenta de usuario administra cuentas publicitarias.

• Para obtener una lista de hosts regionales, consulte API Endpoints. .
• Para conocer las especificaciones técnicas, consulte la especificación Profiles OpenAPI .

Para una cuenta de usuario que administra una cuenta de publicidad en el marketplace MX, por ejemplo, la solicitud debe dirigirse al host de América del Norte:

https://advertising-api.amazon.com/v2/profiles

La solicitud tiene dos headers obligatorios:

• Amazon-Advertising-API-ClientId: El identificador de cliente de la aplicación de cliente LwA.
• Authorization: La string Bearerantepuesta al token de acceso.

Para una llamada al host norteamericano usando cURL, sustituya sus valores en la siguiente solicitud:

curl  \
    -H "Amazon-Advertising-API-ClientId: YOUR_CLIENT_ID"\
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    https://advertising-api.amazon.com/v2/profiles

Respuesta de Profiles

La respuesta a una llamada exitosa en este endpoint incluye una lista de profiles asociados con la cuenta de usuario en la región del host de la API.

Por ejemplo, la respuesta del host norteamericano para una cuenta de usuario que administra exactamente una cuenta de publicidad (en el marketplace MX) sería similar a la siguiente:

[
  {
    "profileId": 888888888,
    "countryCode": "MX",
    "currencyCode": "MXN",
    "timezone": "America/Los_Angeles",
    "accountInfo": {
      "marketplaceStringId": "A1AM78C64UM0Y8",
      "id": "ENTITY2Ihjasdjkeru",
      "type": "vendor",
      "name": "Name of the Account",
      "validPaymentMethod": false
    }
  }
]

📘

¿Ves varios perfiles?

Cada perfil representa una cuenta publicitaria en un mercado diferente. Tenga en cuenta el countryCodevalor para determinar el mercado para un perfil determinado.

📘

¿No ves ningún perfil?

Un array vacío ( [ ]) en el body de la respuesta indica que la autorización se realizó correctamente, pero la cuenta de usuario no tiene permisos de visualización y edición(View and Edit) para ninguna cuenta publicitaria en esta región. Consulte API Endpoints para obtener información sobre la región.

Puede usar parámetros opcionales en su solicitud para mostrar perfiles para los que tiene permiso de solo lectura. Obtenga más información sobre los permisos o consulte los parámetros accessLevely apiProgramen la especificación de Perfiles .

También puede usar su cliente LwA aprobado para generar cuentas de prueba para la API, incluso si no tiene acceso a cuentas publicitarias en ninguna región. Obtenga más información sobre las cuentas de prueba.

📘

¿Usas una cuenta de administrador?

Si la cuenta de usuario que autoriza la solicitud es una cuenta de administrador, la respuesta incluirá todas las cuentas de la región actual para las que la cuenta de administrador tiene acceso de Editor . Para las cuentas con acceso de solo Viewer , use el endpoint GET /managerAccounts para recuperar las profile IDs. Obtenga más información sobre las cuentas de administrador.

Pasar el profile ID en solicitudes posteriores

Además del endpoint /v2/profiles, las solicitudes a la API de Amazon Ads pueden acceder a los recursos de un solo perfil. El perfil seleccionado está determinado por el profile ID pasado como header Amazon-Advertising-API-Scope.

Para solicitudes posteriores a la API, pasará su ID de cliente, su token de acceso y una profile ID como valores para tres headers obligatorios:

• Amazon-Advertising-API-ClientID: Su ID de cliente.
• Authorization: La string Bearerantepuesta al token de acceso.
• Amazon-Advertising-API-Scope: el profile ID de una cuenta de publicidad en un marketplace específico.

📘

Nota

Los tokens de acceso caducan después de 60 minutos y una solicitud que utilice un token de acceso caducado recibirá una respuesta Unauthorized. Para generar un nuevo token cuando sea necesario, consulte Generación de un token de acceso mediante un token de actualización .

Próximos pasos

Para comenzar a usar sus credenciales, consulte Realización de su primera llamada .

📘

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 sobre asistencia.