Essa API está na versão Beta. A documentação da API SOAP do Ad Manager está disponível aqui.

Esta página foi traduzida pela API Cloud Translation.

Autenticação

Este documento descreve como se autenticar na API Ad Manager. Como você autenticação depende da interface usada e do ambiente está em execução, mas todas as solicitações da API devem incluir um token de acesso com a Escopo da API Ad Manager.

As bibliotecas de cliente do Ad Manager usam o Application Default Credentials para gerar tokens de acesso com o escopo da API Ad Manager. Este guia mostra como configurar o Application Default Credentials.

Se você não usa uma biblioteca de cliente, ainda é necessário criar credenciais e use-as para autorizar suas solicitações.

Para mais informações sobre autenticação e autorização, consulte a Guia Como usar o OAuth 2.0.

Determinar o tipo de autenticação

Tipo de autenticação	Descrição
Conta de serviço	Escolha esta opção se quiser autenticar como dedicado em vez de uma pessoa específica. Saiba mais.
Aplicativo da Web	Escolha esta opção se quiser fazer a autenticação como qualquer usuário que concede permissão a seu aplicativo para acessar os dados do Ad Manager. Saiba mais.
Desenvolvimento local	Escolha esta opção se quiser fazer a autenticação como sua própria uma Conta do Google ou uma conta de serviço do seu local ambiente de desenvolvimento de software.

Ativar a API Ad Manager

Ative a API Ad Manager na sua ao projeto do Cloud do Console de APIs do Google.
Se for solicitado, selecione um projeto ou crie um novo.

Criar credenciais

Clique na guia do seu tipo de autenticação e siga as instruções para crie suas credenciais:

Conta de serviço

No Google Cloud

Para autenticar uma carga de trabalho em execução no Google Cloud, use as credenciais de a conta de serviço anexada ao recurso de computação em que o código está em execução.

Por exemplo, é possível anexar uma conta de serviço a uma VM de máquina virtual (VM), um serviço do Cloud Run ou um job do Dataflow. Essa abordagem é o método de autenticação preferencial para o código executado em um ambiente Compute Engine.

Para informações sobre a quais recursos é possível anexar uma conta de serviço, e ajuda para anexar a conta de serviço ao recurso, consulte documentação sobre como anexar uma conta de serviço.

No local ou em outro provedor de nuvem

O método recomendado para configurar a autenticação de fora do Google Cloud é Usar a federação de identidade da carga de trabalho você cria uma de configuração de credenciais e defina GOOGLE_APPLICATION_CREDENTIALS variável de ambiente para apontar para ele. Essa abordagem é mais segura do que criar uma chave de conta de serviço.

Se não for possível configurar a federação de identidade da carga de trabalho, você precisará crie uma conta de serviço e uma chave para ela:

Abra a página de credenciais do Console de APIs do Google.
Na página "Credenciais", selecione Criar credenciais e, em seguida, Selecione Conta de serviço.
Clique no endereço de e-mail da conta de serviço que você quer criar. uma chave.
Clique na guia Chaves.
Clique no menu suspenso Adicionar chave e selecione Criar nova chave.
Selecione JSON como o Tipo de chave e clique em Criar.
Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo JSON.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Aplicativo da Web

Abra a página de credenciais do Console de APIs do Google.
Se solicitado, selecione o projeto em que você ativou a API Ad Manager.
Na página "Credenciais", selecione Criar credenciais e, em seguida, Selecione o ID do cliente OAuth.
Selecione o tipo de aplicativo Aplicativo da Web.
Preencha o formulário e clique em Criar. Os aplicativos que usam linguagens frameworks como PHP, Java, Python, Ruby e .NET precisam especificar URIs de redirecionamento. Os URIs de redirecionamento são os pontos de extremidade aos quais o OAuth 2.0 o servidor de e-mail pode enviar respostas. Esses endpoints devem aderir à regras de validação.
Depois de criar suas credenciais, faça o download do arquivo client_secret.json. Armazene com segurança o arquivo em um local que somente seu aplicativo possa acessar.

A partir daqui, siga as etapas para receber tokens de acesso do OAuth 2.0.

Desenvolvimento local

Configure o Application Default Credentials (ADC) no seu ambiente local.

Instale e inicialize a CLI do Google Cloud executando o seguinte: comando:

gcloud init

Crie credenciais de autenticação local para sua Conta do Google e defina o ID do projeto para um projeto em que a API Ad Manager esteja ativada:

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

Como alternativa, faça a autenticação como uma conta de serviço configurando o ambiente variável GOOGLE_APPLICATION_CREDENTIALS ao caminho do arquivo de chave.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Configurar a rede do Ad Manager

Conta de serviço

Acesse sua rede do Ad Manager.
Clique na guia Administrador.
Verifique se o acesso à API está ativado.
Clique no botão Adicionar um usuário da conta de serviço.
Preencha o formulário usando o e-mail da conta de serviço. A o usuário da conta de serviço precisa ser adicionado às funções e equipes apropriadas para sua integração de API.
Clique no botão Salvar. Uma mensagem será exibida confirmando a adição da conta de serviço.
Para visualizar os usuários da conta de serviço, acesse a guia "Usuários" e, em seguida, clique no filtro Conta de serviço.

Aplicativo da Web

Acesse sua rede do Ad Manager.
Clique na guia Administrador.
Verifique se o acesso à API está ativado.

Desenvolvimento local

Acesse sua rede do Ad Manager.
Clique na guia Administrador.
Verifique se o acesso à API está ativado.

Sem uma biblioteca de cliente

Mesmo que você não use uma biblioteca de cliente, é altamente recomendável usar uma biblioteca OAuth2 para autenticação.

Para obter instruções detalhadas sobre como obter tokens de acesso, consulte Como usar o OAuth2 com as APIs do Google.

Tokens de acesso

Para incluir seu token de acesso em uma solicitação à API, inclua um Parâmetro de consulta access_token ou um valor Bearer do cabeçalho HTTP Authorization. Recomendamos usar o cabeçalho HTTP quando possível, porque as strings de consulta tendem a ser visíveis nos registros do servidor.

Exemplo:

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX

GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

Escopo

Cada token de acesso está associado a um ou mais escopos. Um escopo controla conjunto de recursos e operações permitidas por um token de acesso. O Ad Manager A API REST tem apenas um escopo. A autorização deve ser realizada na no produto.

Escopo	Permissões
`https://www.googleapis.com/auth/admanager`	Visualize e gerencie suas campanhas no Google Ad Manager.