Procurando uma API REST? A API Ad Manager (Beta) já está disponível.

O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Começar

Você pode usar a API SOAP do Google Ad Manager para criar apps que gerenciam inventário, criam pedidos, geram relatórios e muito mais.

Para ajudar você a começar, oferecemos bibliotecas de cliente para Java, .NET, Python, PHP e Ruby.

Para fazer sua primeira solicitação de API, siga estas etapas:

Se você ainda não tiver uma, crie uma conta do Ad Manager. Também é possível criar uma rede de teste se quiser testar a API em um ambiente separado. Observação: não é necessário ter uma conta do Google AdSense para fins de teste.

Anote o código da sua rede. Você pode encontrar essa informação no URL quando faz login na sua rede. Por exemplo, no URL https://admanager.google.com/1234#home, 1234 é o código de rede.

Criar credenciais de autenticação

É necessário autenticar todas as solicitações da API SOAP do Ad Manager usando o OAuth 2.0. As etapas a seguir abordam o caso de uso de acesso aos seus próprios dados do Ad Manager. Para mais detalhes e outras opções, consulte Autenticação.

Abra a página "Credenciais" do console de APIs do Google.
No menu do projeto, escolha Criar projeto, insira um nome para o projeto e, opcionalmente, edite o ID do projeto fornecido. Clique em Criar.
Na página "Credenciais", selecione Criar credenciais e depois Chave da conta de serviço.
Selecione Nova conta de serviço e JSON como o tipo de chave.
Clique em Criar para fazer o download de um arquivo com uma chave privada.

Configurar sua rede do Ad Manager

Faça login no Google Ad Manager.
Na barra lateral, clique em Administrador > Configurações globais.
Em Configurações gerais > Acesso à API, clique no controle deslizante para Ativado.
Clique no botão Salvar na parte de baixo da página.

Configurar o cliente

Faça o download de uma das bibliotecas de cliente do Ad Manager. As bibliotecas oferecem funções e recursos de wrapper que facilitam e aceleram o desenvolvimento de apps.

As guias a seguir oferecem guias de início rápido para programação em cada uma das linguagens que têm uma biblioteca de cliente.

Java

Confira um exemplo básico que mostra como usar a biblioteca de cliente Java. Para informações de uso mais detalhadas, consulte o arquivo README na distribuição da biblioteca de cliente.

Configurar suas credenciais

Execute o comando a seguir em um shell:

curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties

Abra o arquivo ~/ads.properties e preencha os seguintes campos:

[...]
api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE
api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE
api.admanager.networkCode=INSERT_NETWORK_CODE_HERE
[...]

Especificar as dependências

Edite o arquivo pom.xml e adicione o seguinte à tag dependencies. Você pode encontrar o número da versão mais recente no GitHub (em inglês).

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>ads-lib</artifactId>
  <version>RELEASE</version>
</dependency>
<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>dfp-axis</artifactId>
  <version>RELEASE</version>
</dependency>

Escreva um código e faça uma solicitação!

import com.google.api.ads.common.lib.auth.OfflineCredentials;
import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
import com.google.api.ads.admanager.axis.factory.AdManagerServices;
import com.google.api.ads.admanager.axis.v202608.Network;
import com.google.api.ads.admanager.axis.v202608.NetworkServiceInterface;
import com.google.api.ads.admanager.lib.client.AdManagerSession;
import com.google.api.client.auth.oauth2.Credential;

public class App {
  public static void main(String[] args) throws Exception {
    Credential oAuth2Credential = new OfflineCredentials.Builder()
        .forApi(Api.AD_MANAGER)
        .fromFile()
        .build()
        .generateCredential();

    // Construct an AdManagerSession.
    AdManagerSession session = new AdManagerSession.Builder()
        .fromFile()
        .withOAuth2Credential(oAuth2Credential)
        .build();

    // Construct a Google Ad Manager service factory, which can only be used once per
    // thread, but should be reused as much as possible.
    AdManagerServices adManagerServices = new AdManagerServices();

    // Retrieve the appropriate service
    NetworkServiceInterface networkService = adManagerServices.get(session,
        NetworkServiceInterface.class);

    // Make a request
    Network network = networkService.getCurrentNetwork();

    System.out.printf("Current network has network code '%s' and display" +
        " name '%s'.%n", network.getNetworkCode(), network.getDisplayName());
  }
}

Ver no GitHub

Python

Confira um exemplo básico que mostra como usar a biblioteca de cliente Python. A biblioteca de cliente do Python é compatível com Python v3.6 ou mais recente. Para mais informações sobre o uso, consulte o arquivo README na distribuição da biblioteca de cliente.

Instale a biblioteca e configure suas credenciais.

Execute os comandos a seguir em um shell:

python3 -m pip install googleads
curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \
     -o ~/googleads.yaml

Configure seu arquivo ~/googleads.yaml.

Preencha os campos a seguir:

ad_manager:
  application_name: INSERT_APPLICATION_NAME_HERE
  network_code: INSERT_NETWORK_CODE_HERE
  path_to_private_key_file: INSERT_PATH_TO_FILE_HERE

Execute um código e faça uma solicitação.

# Import the library.
from googleads import ad_manager

# Initialize a client object, by default uses the credentials in ~/googleads.yaml.
client = ad_manager.AdManagerClient.LoadFromStorage()

# Initialize a service.
network_service = client.GetService('NetworkService', version='v202608')

# Make a request.
current_network = network_service.getCurrentNetwork()

print("Current network has network code '%s' and display name '%s'." %
        (current_network['networkCode'], current_network['displayName']))

Ver no GitHub

PHP

Confira um exemplo básico que mostra como usar a biblioteca de cliente PHP.

Instale a biblioteca e configure suas credenciais.
Execute os comandos a seguir em um shell para instalar a biblioteca de cliente e baixar o arquivo adsapi_php.ini no seu diretório principal:
```
composer require googleads/googleads-php-lib
curl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
```

Configure o arquivo ~/adsapi_php.ini.

Preencha os campos a seguir:

[AD_MANAGER]
networkCode = "INSERT_NETWORK_CODE_HERE"
applicationName = "INSERT_APPLICATION_NAME_HERE"

[OAUTH2]
jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE"
scopes = "https://www.googleapis.com/auth/dfp"

Execute um código e faça um pedido!

Este exemplo de código precisa ser executado na linha de comando, não em um navegador. O arquivo que contém esse código precisa estar na raiz do diretório do projeto, onde composer require foi executado.

<?php
require 'vendor/autoload.php';
use Google\AdsApi\AdManager\AdManagerSession;
use Google\AdsApi\AdManager\AdManagerSessionBuilder;
use Google\AdsApi\AdManager\v202608\ApiException;
use Google\AdsApi\AdManager\v202608\ServiceFactory;
use Google\AdsApi\Common\OAuth2TokenBuilder;

// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();
// Construct an API session configured from a properties file and the OAuth2
// credentials above.
$session = (new AdManagerSessionBuilder())
    ->fromFile()
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

// Get a service.
$serviceFactory = new ServiceFactory();
$networkService = $serviceFactory->createNetworkService($session);

// Make a request
$network = $networkService->getCurrentNetwork();
printf(
    "Network with code %d and display name '%s' was found.\n",
    $network->getNetworkCode(),
    $network->getDisplayName()
);

Ver no GitHub

.NET

Confira um exemplo básico que mostra como usar a biblioteca de cliente do .NET.

Criar um novo projeto
Abra o Visual Studio e crie um projeto (aplicativo de console).
Adicionar referências de biblioteca necessárias ao projeto
Adicione uma dependência do NuGet para Google.Dfp.
Configurar o App.config
Copie src\App.config para o diretório do projeto e adicione-o ao projeto. Se o aplicativo tiver o próprio App.config, copie os seguintes nós para ele:
- configuration/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- configuration/system.net

Configurar credenciais

Abra App.config e edite as seguintes chaves:

<add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" />
<add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" />
<add key="OAuth2Mode" value="SERVICE_ACCOUNT" />
<add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />

Fazer uma ligação para a biblioteca

Você pode chamar a biblioteca conforme mostrado no seguinte snippet de código em C#:

Ver no GitHub

AdManagerUser user = new AdManagerUser();
      using (InventoryService inventoryService = user.GetService<InventoryService>())
            {
                // Create a statement to select ad units.
                int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT;
                StatementBuilder statementBuilder =
                    new StatementBuilder().OrderBy("id ASC").Limit(pageSize);

                // Retrieve a small amount of ad units at a time, paging through until all
                // ad units have been retrieved.
                int totalResultSetSize = 0;
                do
                {
                    AdUnitPage page =
                        inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement());

                    // Print out some information for each ad unit.
                    if (page.results != null)
                    {
                        totalResultSetSize = page.totalResultSetSize;
                        int i = page.startIndex;
                        foreach (AdUnit adUnit in page.results)
                        {
                            Console.WriteLine(
                                "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++,
                                adUnit.id, adUnit.name);
                        }
                    }

                    statementBuilder.IncreaseOffsetBy(pageSize);
                } while (statementBuilder.GetOffset() < totalResultSetSize);

                Console.WriteLine("Number of results found: {0}", totalResultSetSize);
            }

Se você não quiser definir suas credenciais no App.config, consulte este artigo da wiki para conhecer outras maneiras de usar a classe AdManagerUser. Para mais informações sobre como usar a biblioteca de cliente .NET, consulte o README . Se você quiser desenvolver em .NET sem a biblioteca de cliente, consulte o artigo da wiki NoClientLibrary.

Ruby

Confira um exemplo básico que mostra como usar a biblioteca de cliente Ruby. A biblioteca de cliente do Ruby requer o Ruby 2.1 ou posterior.

Instale a gem do Ruby e receba o arquivo de configuração.
Execute os comandos a seguir em um shell:
```
gem install google-dfp-api
curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
```
Se você encontrar um erro como "cannot load such file -- mkmf (LoadError)" durante a instalação das gems, talvez seja necessário instalar outras bibliotecas de desenvolvimento do Ruby, como ruby-dev, ruby-devel, xcode-select etc., para seu ambiente específico.
Configurar suas credenciais
Preencha os campos obrigatórios no arquivo ~/ad_manager_api.yml. Se você ainda não tiver um arquivo de chave do OAuth2, siga as etapas para criar suas credenciais do OAuth2.
```
:authentication:
  :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
  :application_name: INSERT_APPLICATION_NAME_HERE
  :network_code: INSERT_NETWORK_CODE_HERE
```

Escreva um código e faça uma solicitação!

# Import the library.
require 'ad_manager_api'

# Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default).
ad_manager = AdManagerApi::Api.new

# Get a service instance.
network_service = ad_manager.service(:NetworkService, :v202608)

# Make a request.
network = network_service.get_current_network()

puts "The current network is %s (%d)." %
        [network[:display_name], network[:network_code]]

Ver no GitHub

Etapas mais detalhadas para começar podem ser encontradas no arquivo README distribuído com a biblioteca de cliente Ruby. Confira também nossa biblioteca de exemplos completa para Ruby.

Próximas etapas

Quando você tiver uma biblioteca de cliente em funcionamento, modifique os exemplos fornecidos para estendê-los de acordo com suas necessidades.

Consulte a documentação de referência para saber mais sobre a API.

Se precisar de ajuda, acesse nossa página de suporte.

Começar Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Acessar uma rede do Ad Manager

Criar credenciais de autenticação

Configurar sua rede do Ad Manager

Configurar o cliente

Java

Python

PHP

.NET

Ruby

Próximas etapas

Começar