3. Recupere e use um profile ID

Introdução: visão geral | 1. Criar concessão de autorização | 2. Gerar token de acesso | 3. Recupere profiles

Etapa 3: recuperar um profile ID

Conforme descrito na visão geral "Primeiros passos" , há duas credenciais de autorização essenciais para chamar a API do Amazon Ads:

• O client ID de um aplicativo cliente do Login with Amazon (LwA) aprovado para acesso à API.
• Um access token que representa permissão para esse cliente acessar recursos em nome de uma conta de usuário da Amazon que gerencia contas do Amazon Ads.

Além disso, quase todas as solicitações à API exigem um profile ID que represente a conta de publicidade do usuário em um marketplace específico . Depois de gerar um token de acesso , siga as etapas abaixo para recuperar um profile ID para uso em solicitações à API.

• Para revisar as etapas até agora, consulte a visão geral "Primeiros passos" .
• Para obter informações conceituais sobre profiles na Amazon Ads API, consulte Profiles .

Acesse o recurso Profiles

Para recuperar uma lista de profiles disponíveis, faça uma solicitação GET ao endpoint /v2/profiles em uma região onde a conta do usuário gerencia contas de publicidade.

• Para obter uma lista de hosts regionais, consulte API Endpoints .
• Para especificações técnicas, consulte a especificação Profiles OpenAPI .

Para uma conta de usuário que gerencia uma conta de publicidade no marketplace MX, por exemplo, a solicitação deve ser direcionada ao host da América do Norte:

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

A solicitação tem dois headers obrigatórios:

• Amazon-Advertising-API-ClientId: O identificador do cliente do aplicativo cliente LwA.
• Authorization: a string Beareranexada ao token de acesso.

Para uma chamada para o host norte-americano usando cURL, substitua seus valores na seguinte solicitação:

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

Resposta dos Profiles

A resposta a uma chamada bem-sucedida neste terminal inclui uma lista de profiles associados à conta do usuário na região do host da API.

Por exemplo, a resposta do host norte-americano para uma conta de usuário que gerencia exatamente uma conta de publicidade (no marketplace MX) seria semelhante ao seguinte:

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

📘

Você vê vários profiles?

Cada profile representa uma conta de publicidade em um marketplace diferente. Observe o valor countryCode para determinar o marketplace para um determinado profile.

📘

Não vê nenhum profile?

Um array vazio ( [ ]) no corpo da resposta indica que a autorização foi bem-sucedida, mas a conta do usuário não tem permissões de visualização e edição para nenhuma conta de publicidade nessa região. Consulte API Endpoints para obter informações sobre a região.

Você pode usar parâmetros opcionais em sua solicitação para exibir profiles para os quais você tem permissão somente para visualização. Saiba mais sobre permissões ou consulte os parâmetros accessLevel e apiProgram na especificação de Profiles .

Você também pode usar seu cliente LwA aprovado para gerar contas de teste para a API, mesmo que não tenha acesso a contas de publicidade em nenhuma região. Saiba mais sobre contas de teste.

📘

Usando uma conta de administrador?

Se a conta de usuário que autoriza a solicitação for uma conta de administrador, a resposta incluirá todas as contas na região atual para as quais a conta de administrador tem acesso Editor . Para contas com apenas acesso de Viewer , use o endpoint GET /managerAccounts para recuperar IDs de profile. Saiba mais sobre contas de administrador.

Passe o profile ID nas solicitações subsequentes

Além do endpoint /v2/profiles, as solicitações para a API do Amazon Ads podem acessar recursos para apenas um profile. O profile selecionado é determinado pelo profile ID passado como header Amazon-Advertising-API-Scope.

Para solicitações subsequentes à API, você passará seu client ID, seu token de acesso e um profile ID como valores para três headers obrigatórios:

• Amazon-Advertising-API-ClientID: Seu ID de cliente.
• Authorization: a string Beareranexada ao token de acesso.
• Amazon-Advertising-API-Scope: o ID do profile de uma conta de publicidade em um marketplace específico.

📘

Nota

Os tokens de acesso expiram após 60 minutos e uma solicitação usando um token de acesso expirado receberá uma resposta Unauthorized. Para gerar um novo token quando necessário, consulte Gerando um token de acesso usando um token de atualização .

Próximos passos

Para começar a usar suas credenciais, consulte Fazendo sua primeira chamada .

📘

Suporte técnico

Se você tiver dificuldade para se conectar à API do Amazon Ads, visite nossa página de suporte técnico para obter informações sobre assistência.