Authentication
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Este documento descreve como fazer a autenticação na API Ad Manager. Como você
autenticação depende da interface que você usa e do ambiente em que
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 estiver usando uma biblioteca de cliente, ainda precisará criar credenciais
e usá-las para autorizar suas solicitações.
Para mais informações sobre autenticação e autorização, consulte o guia
Como usar o OAuth 2.0.
Determinar seu tipo de autenticação
| Tipo de autenticação |
Descrição |
| Conta de serviço
|
Escolha essa opção se quiser fazer a autenticação como uma conta dedicada, e não como 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 essa opção se quiser fazer a autenticação como sua própria
Conta do Google ou uma conta de serviço do seu ambiente de
desenvolvimento local. |
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 códigos em execução em um recurso de computação
do Google Cloud.
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 para a qual 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 necessário, 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 e
frameworks como PHP, Java, Python, Ruby e .NET precisam especificar
URIs de redirecionamento autorizados. 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.
Em seguida, 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 a CLI do Google Cloud e, em seguida, inicialize-a 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 definindo a variável de ambiente
GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo de chave.
Linux ou macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
Windows
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
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. O usuário da conta de serviço precisa ser adicionado a funções e equipes adequadas para a integração da API.
- Clique no botão Salvar. Uma mensagem será exibida confirmando
a adição da conta de serviço.
- Para conferir os usuários da conta de serviço, acesse a guia "Usuários" e 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 a 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.
Quando possível, o cabeçalho HTTP é preferível, porque as strings de consulta tendem a ficar
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 é associado a um ou mais escopos. Um escopo controla
conjunto de recursos e operações permitidas por um token de acesso. A API do Ad Manager
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. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-31 UTC.
[null,null,["Última atualização 2025-08-31 UTC."],[[["\u003cp\u003eGoogle Ad Manager API authentication depends on the interface and environment but always requires an access token.\u003c/p\u003e\n"],["\u003cp\u003eChoose between service account, web application, or local development authentication based on your needs.\u003c/p\u003e\n"],["\u003cp\u003eEnable the Ad Manager API in your Google API Console and create the necessary credentials for your chosen authentication type.\u003c/p\u003e\n"],["\u003cp\u003eConfigure your Ad Manager network settings and add the service account user or enable API access depending on authentication type.\u003c/p\u003e\n"],["\u003cp\u003eInclude your access token in API requests using either a query parameter or an HTTP header.\u003c/p\u003e\n"]]],["To access the Ad Manager API, you need an access token, generated using Application Default Credentials (ADC) or custom credentials. First, enable the Ad Manager API in your Google Cloud project. Then, choose an authentication type: Service Account, Web application, or Local development. Create credentials via the Google API Console, selecting the appropriate method. If not using a client library, use an OAuth2 library. Finally, include the access token in API requests, preferably in the `Authorization` HTTP header. Each access token should be associated with the `https://www.googleapis.com/auth/admanager` scope.\n"],null,["# Authentication\n\nThis document describes how to authenticate to the Ad Manager API. How you\nauthenticate depends on the interface you use and the environment where your\ncode is running, but all API requests must include an access token with the\nAd Manager API [scope](#scope).\n\nThe Ad Manager client libraries use [Application Default Credentials](//cloud.google.com/docs/authentication/application-default-credentials)\nto generate access tokens with the Ad Manager API scope. This guide shows\nhow to configure Application Default Credentials.\n\nIf you aren't using a client library, you still need to create credentials\nand use them to authorize your requests.\n\nFor more information about authentication and authorization, see the\n[Using OAuth 2.0](/identity/protocols/oauth2) guide.\n\nDetermine your authentication type\n----------------------------------\n\n| Authentication type | Description |\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Service Account | Choose this if you want to authenticate as dedicated account rather than a particular person. [Learn more](//cloud.google.com/iam/docs/service-account-overview). |\n| Web application | Choose this if you want to authenticate as any user who grants permission to your application to access their Ad Manager data. [Learn more](/identity/oauth2/web/guides/overview) |\n| Local development | Choose this if you want to authenticate as your own Google Account or a Service Account from your local development environment. |\n\nEnable the Ad Manager API\n-------------------------\n\n1. Enable the [Ad Manager API](https://console.cloud.google.com/apis/library/admanager.googleapis.com) in your\n Google API Console Cloud Project.\n\n2. If prompted, select a project, or create a new one.\n\nCreate credentials\n------------------\n\nClick the tab for your authentication type and follow the instructions to\ncreate your credentials: \n\n### Service Account\n\n### On Google Cloud\n\nTo authenticate a workload running on Google Cloud, you use the credentials of\nthe service account attached to the compute resource where your code is\nrunning.\n\nFor example, you can attach a service account to a Compute Engine virtual\nmachine (VM) instance, a Cloud Run service, or a Dataflow job. This approach\nis the preferred authentication method for code running on a Google Cloud\ncompute resource.\n\nFor information about which resources you can attach a service account to,\nand help with attaching the service account to the resource, see the\n[documentation on attaching a service account](//cloud.google.com/iam/docs/attach-service-accounts).\n\n### On-premises or on a different cloud provider\n\nThe preferred method to set up authentication from outside of Google Cloud is\nto use [workload identity federation](//cloud.google.com/iam/docs/workload-identity-federation); you create a\ncredential configuration file and set the `GOOGLE_APPLICATION_CREDENTIALS`\nenvironment variable to point to it. This approach is more secure than\ncreating a service account key.\n\nIf you are not able to configure workload identity federation, then you must\ncreate a service account and create a key for the service account:\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. On the Credentials page, select **Create credentials** , then\n select **Service Account**.\n\n3. Click the email address of the service account that you want to create\n a key for.\n\n4. Click the **Keys** tab.\n\n5. Click the **Add key** drop-down menu, then select **Create new key**.\n\n6. Select **JSON** as the **Key type** and click **Create**.\n\n7. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the path\n of the JSON file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n### Web application\n\n1. Open the [Google API Console Credentials page](https://console.cloud.google.com/apis/credentials).\n\n2. If prompted, select the project where you enabled the Ad Manager API.\n\n3. On the Credentials page, select **Create credentials** , then\n select **OAuth client ID**.\n\n4. Select the **Web application** application type.\n\n5. Fill in the form and click **Create** . Applications that use languages and\n frameworks like PHP, Java, Python, Ruby, and .NET must specify authorized\n **redirect URIs** . The redirect URIs are the endpoints to which the OAuth 2.0\n server can send responses. These endpoints must adhere to [Google's\n validation rules](/identity/protocols/oauth2/web-server#uri-validation).\n\n6. After creating your credentials, download the **client_secret.json** file. Securely store the file in a location that only your application can access.\n\nFrom here, follow the steps to [obtain OAuth 2.0 access tokens](/identity/protocols/oauth2/web-server#obtainingaccesstokens)\n\n### Local development\n\nSet up Application Default Credentials (ADC) in your local environment.\n\nInstall the Google Cloud CLI, then initialize it by running the following\ncommand: \n\n gcloud init\n\nCreate local authentication credentials for your Google Account and set\nthe project ID to a project where the Ad Manager API is enabled: \n\n gcloud auth application-default login --scopes=\"https://www.googleapis.com/auth/admanager\"\n gcloud auth application-default set-quota-project \u003cvar label=\"project id\" translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e\n\nAlternatively, authenticate as a Service Account setting the environment\nvariable `GOOGLE_APPLICATION_CREDENTIALS` to the path of your key file.\n\n#### Linux or macOS\n\n export GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\n#### Windows\n\n set GOOGLE_APPLICATION_CREDENTIALS=\u003cvar label=\"key file\" translate=\"no\"\u003eKEY_FILE_PATH\u003c/var\u003e\n\nConfigure your Ad Manager network\n---------------------------------\n\n**Tip:** If you are a third-party developer, ask your client to complete this step for you. Send them to [Add a service account user for API access](//support.google.com/admanager/answer/6078734) and provide the email address of your service account. \n\n### Service Account\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n4. Click the **Add a service account user** button.\n5. Fill in the form using the service account email. The service account user must be added to appropriate roles and teams for your API integration.\n6. Click the **Save** button. A message should appear, confirming the addition of your service account.\n7. View existing service account users by going to the Users tab and then clicking the **Service Account** filter.\n\n### Web application\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\n### Local Development\n\n1. Go to your [Ad Manager network](//admanager.google.com).\n2. Click the **Admin** tab.\n3. Ensure that **API access** is enabled.\n\nWithout a client library\n------------------------\n\nIf you are not using a client library, we still strongly recommend using\nan OAuth2 library for authentication.\n\nFor detailed instructions on obtaining access tokens, see\n[Using OAuth2 with Google APIs](/identity/protocols/oauth2).\n\n### Access tokens\n\nInclude your access token in a request to the API by including either an\n`access_token` query parameter or an `Authorization` HTTP header `Bearer` value.\nWhen possible, the HTTP header is preferable, because query strings tend to be\nvisible in server logs.\n\nFor example: \n\n GET /v1/networks/1234\n Host: admanager.googleapis.com\n Authorization: Bearer ya29.a0Ad52N3_shYLX\n\n GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg\n\n### Scope\n\nEach access token is associated with one or more scopes. A scope controls the\nset of resources and operations that an access token permits. The Ad Manager\nAPI has only one scope. Authorization should be performed at the user\nlevel within the product.\n\n| Scope | Permissions |\n|---------------------------------------------|------------------------------------------------------|\n| `https://www.googleapis.com/auth/admanager` | View and manage your campaigns on Google Ad Manager. |"]]
