Especificações técnicas

Nesta página, você encontra as especificações técnicas da API Waze Ads Management (WAM, na sigla em inglês). Ela explica como a API usa um espaço de ID global e como fazer chamadas autenticadas pelo método v1/generateWazeAccessToken. Ela também explica o sistema de chamada de procedimento remoto (RPC) em que a API WAM se baseia.

Nome do recurso

Cada recurso é identificado exclusivamente por uma string name que o vincula a um caminho com os recursos de nível superior. Por exemplo, os nomes dos recursos da Campaign têm o seguinte formato:

accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID

O name de uma Campaign com ID 1027082 dentro de uma Account do Waze Ads com ID 108404 terá a seguinte aparência:

accounts/108404/campaigns/1027082

Os valores de ID que aparecem nos nomes dos recursos são IDs globais.

ID global

A API usa um espaço de ID global (GID, na sigla em inglês) para todos os recursos do Waze Ads, que incluem Account, Ad, Campaign, BudgetPlan, entre outros. Para criar um ID global, inclua um prefixo aos valores dos IDs regionais vistos no painel do Waze Ads.

Por exemplo, as solicitações de API para modificar recursos de uma Account norte-americana precisam ter o valor 10 de GID no prefixo. Se o ID regional da Account for 5678 (um URI como https://biz.waze.com/app/providers/5678/overview), o GID será 105678.

Região Domínio do painel Valor do GID (prefixo)
América do Norte http://biz.waze.com/ 10
Restante do mundo http://biz.world.waze.com/ 20
Israel http://biz-il.waze.com/ 30

Chamadas autenticadas

A maioria dos métodos de API exige um WAZE_ACCESS_TOKEN para autenticação. Se quiser recuperar um WAZE_ACCESS_TOKEN, chame o método generateWazeAccessToken usando um token de acesso e um de ID de usuário do OpenID Connect. O fluxo de autenticação do Google recupera os dois tokens.