Guias de uso
Documentação GlobalDeveloper HubSuporteStatus da API

Faça sua primeira chamada

Suggest Edits

Faça sua primeira chamada para a Amazon Ads API

Você pode usar a Ads API para gerenciar campanhas, extrair dados de relatórios e muito mais. Este tutorial ajuda você a entender como listar todas as suas campanhas ativas de anúncios patrocinados (Produtos Patrocinados, Marcas Patrocinadas e Exibição Patrocinada) usando o endpoint GET relevante de campanhas .

Antes de você começar

📘

Nota

Este tutorial pressupõe que você já concluiu os processos de integração e introdução à Ads API.

Para concluir este tutorial, certifique-se de ter:

Request

Prefixos de URL

O prefixo que você deve usar ao chamar a Ads API é baseado na geografia do profile usado na requisição.

URLRegião e marketplaces
[https://advertising-api.amazon.com]América do Norte (NA). Abrange os marketplaces dos EUA, CA, MX e BR
[https://advertising-api-eu.amazon.com]Europa (UE). Abrange os marketplaces do Reino Unido, FR, IT, ES, DE, NL, AE, PL e TR
[https://advertising-api-fe.amazon.com]Extremo Oriente (FE). Abrange os marketplaces JP, AU e SG.

Headers

A maioria das chamadas para a Amazon Ads API requer headers comuns:

HeaderObrigatório?Descrição
Amazon-Advertising-API-ClientIdSimO client ID relacionado a um aplicativo do Login with Amazon.
AuthorizationSimUm token de acesso à API válido no formato Bearer access_token. Um token de acesso é válido apenas por uma hora.
Amazon-Advertising-API-ScopeSimprofile ID do Amazon Ads.
AcceptNãoO header de aceitação é usado para especificar a versão. Se nenhum header Accept for especificado, o padrão será application/json.

Requisições de amostra

Se estiver copiando as amostras, certifique-se de inserir seu próprio client ID, access token, e profile ID.

Produtos Patrocinados

Referência completa: POST sp/campaigns/list

cURL

Este exemplo mostra uma solicitação de campanha de produtos patrocinados de lista usando o prefixo de URL da América do 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
  1. Certifique-se de ter a collection do Postman da API do Amazon Ads e os arquivos de environment importados para o Postman. Se você ainda não concluiu a configuração do Postman, consulte nosso tutorial do Postman .
  2. No Postman, navegue até a collection Amazon Ads API .
  3. Vá para a pasta First call e abra o endpoint POSTList SB campaigns .
  4. Na guia Headers , verifique se as variáveis ​​de ambiente estão sendo preenchidas corretamente.
  5. Envie sua requisição.

Marcas Patrocinadas

Referência completa: POST sb/beta/campaigns/list

cURL

Este exemplo mostra uma requisição de campanha de Marcas patrocinadas de lista usando o prefixo de URL da América do 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
  1. Certifique-se de ter a collection do Postman da API do Amazon Ads e os arquivos de environment importados para o Postman. Se você ainda não concluiu a configuração do Postman, consulte nosso tutorial do Postman .
  2. No Postman, navegue até a collection Amazon Ads API .
  3. Vá para a pasta First call e abra o endpoint POSTList SB campaigns .
  4. Na guia Headers , verifique se as variáveis ​​de ambiente estão sendo preenchidas corretamente.
  5. Envie sua requisição.

Exibição patrocinada

Referência completa: GET sd/campaigns

cURL

Este exemplo mostra uma requisição de campanha GET Sponsored Display usando o prefixo de URL da América do 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
  1. Certifique-se de ter a collection do Postman da API do Amazon Ads e os arquivos de environment importados para o Postman. Se você ainda não concluiu a configuração do Postman, consulte nosso tutorial do Postman .
  2. No Postman, navegue até a collection Amazon Ads API .
  3. Vá para a pasta First call e abra o endpoint GETList SD campaigns .
  4. Na guia Headers , verifique se as variáveis ​​de ambiente estão sendo preenchidas corretamente.
  5. Envie sua requisição.

Resposta

Uma resposta bem-sucedida para qualquer um dos endpoints de campanhas GET retorna um código 200 de resposta. O body da resposta contém um array JSON de objetos de campanha.

Amostra

A amostra de resposta a seguir contém uma campanha de Sponsored Display.

[
    {
        "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"
    }
]

Recebendo uma resposta vazia

Se você ainda não tiver nenhuma campanha de um determinado tipo de anúncio criada, receberá uma resposta 200 que contém um array JSON vazio ( []). Para verificar se você tem campanhas ativas, faça login no advertising console.

📘

Dica

Se você é novo no Amazon Ads e não tem nenhuma campanha, tente criar uma conta de teste . Depois de ter uma conta de teste, você pode praticar a criação de campanhas sem afetar seus gastos.

Próximos passos

Agora que você entende a estrutura básica de requisição e resposta da API do Amazon Ads, pode começar a trabalhar no caso de uso que atende às suas necessidades.

Para anunciantes com campanhas ativas

Para anunciantes novos no Amazon Ads

Updated over 1 year ago