Este guia exige várias configurações de pré-requisito que foram definidas na etapas anteriores. Comece com Introdução, se ainda não fez isso.
Este guia também usa tokens de atualização, um fluxo de trabalho em que um usuário com acesso à conta do Google Ads podem autorizar seu aplicativo, em uma configuração única, a fazer chamadas de API off-line para a conta sem qualquer intervenção do usuário. É possível usar tokens de atualização para criar fluxos de trabalho off-line, como cron jobs ou pipelines de dados, e fluxos de trabalho interativos, como apps da Web ou para dispositivos móveis.
Buscar um token de atualização
A API do Google Ads usa OAuth 2.0 como mecanismo de autorização. Por padrão, o OAuth A autenticação 2.0 emite um token de acesso que expira após um tempo de resposta. Para renovar o token de acesso automaticamente, emita uma atualização token.
Gere o token de atualização executando o Ferramenta oauth2l:
oauth2l fetch --credentials credentials.json --scope adwords \ --output_format refresh_token
O arquivo
credentials.json
é de uma origem anterior etapa.O comando
oauth2l
abre uma janela de login da Conta do Google em um novo navegador. e guia você pelas etapas de autenticação do OAuth 2.0.Faça login com o endereço de e-mail da etapa em que identificou seu ID de cliente de login.
Caso seu app não tenha sido verificado, uma tela de aviso será exibida. Nesses casos, clique no link Mostrar avançados e clique em a opção Acessar PROJECT_NAME (não verificado).
Depois de verificar os escopos, conceda a permissão clicando no Botão Continuar.
Uma solicitação será exibida no navegador com o seguinte texto:
Authorization code granted. Please close this tab.
O comando
oauth2l
gera o seguinte snippet JSON:{ "client_id": "******.apps.googleusercontent.com", "client_secret": "******", "token_uri": "https://oauth2.googleapis.com/token", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "refresh_token": "******", "type": "authorized_user" }
Fazer uma chamada de API
Selecione seu cliente preferido para conferir instruções sobre como fazer uma chamada de API:
Java
Os artefatos da biblioteca de cliente são publicados no Maven central repositório. Adicionar a biblioteca de cliente como uma dependência para o projeto, da seguinte maneira:
A dependência do Maven é:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>33.0.0</version>
</dependency>
A dependência do Gradle é:
implementation 'com.google.api-ads:google-ads:33.0.0'
Crie um arquivo ~/ads.properties
com o seguinte conteúdo.
api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Crie um objeto GoogleAdsClient
desta forma:
GoogleAdsClient googleAdsClient = null;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
fnfe);
System.exit(1);
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
System.exit(1);
}
Em seguida, gere um relatório de campanha usando a
GoogleAdsService.SearchStream
para recuperar as campanhas na sua conta. Este guia não aborda os
detalhes dos relatórios.
private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
// Constructs the SearchGoogleAdsStreamRequest.
SearchGoogleAdsStreamRequest request =
SearchGoogleAdsStreamRequest.newBuilder()
.setCustomerId(Long.toString(customerId))
.setQuery(query)
.build();
// Creates and issues a search Google Ads stream request that will retrieve all campaigns.
ServerStream<SearchGoogleAdsStreamResponse> stream =
googleAdsServiceClient.searchStreamCallable().call(request);
// Iterates through and prints all of the results in the stream response.
for (SearchGoogleAdsStreamResponse response : stream) {
for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
System.out.printf(
"Campaign with ID %d and name '%s' was found.%n",
googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
}
}
}
}
C#
Os pacotes da biblioteca de cliente estão publicados no site Nuget.org
repositório. Comece adicionando um
referência de nuget ao pacote Google.Ads.GoogleAds
.
dotnet add package Google.Ads.GoogleAds --version 18.1.0
Crie um objeto GoogleAdsConfig
com as configurações relevantes e use-o para
crie um objeto GoogleAdsClient
.
GoogleAdsConfig config = new GoogleAdsConfig()
{
DeveloperToken = "******",
OAuth2Mode = "APPLICATION",
OAuth2ClientId = "******.apps.googleusercontent.com",
OAuth2ClientSecret = "******",
OAuth2RefreshToken = "******",
LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);
Em seguida, gere um relatório de campanha usando a
GoogleAdsService.SearchStream
para recuperar as campanhas na sua conta. Este guia não aborda os
detalhes dos relatórios.
public void Run(GoogleAdsClient client, long customerId)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V17.GoogleAdsService);
// Create a query that will retrieve all campaigns.
string query = @"SELECT
campaign.id,
campaign.name,
campaign.network_settings.target_content_network
FROM campaign
ORDER BY campaign.id";
try
{
// Issue a search request.
googleAdsService.SearchStream(customerId.ToString(), query,
delegate (SearchGoogleAdsStreamResponse resp)
{
foreach (GoogleAdsRow googleAdsRow in resp.Results)
{
Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
}
}
);
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
PHP
Os pacotes da biblioteca de cliente são publicados no Packagist
repositório. Mudar para
no diretório raiz do seu projeto e execute o seguinte comando para instalar
a biblioteca e todas as dependências dela no diretório vendor/
do
diretório raiz do projeto.
composer require googleads/google-ads-php:22.0.0
Faça uma cópia
google_ads_php.ini
do repositório do GitHub e modificá-lo para incluir suas credenciais.
[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"
Crie uma instância do objeto GoogleAdsClient
.
$oAuth2Credential = (new OAuth2TokenBuilder())
->fromFile('/path/to/google_ads_php.ini')
->build();
$googleAdsClient = (new GoogleAdsClientBuilder())
->fromFile('/path/to/google_ads_php.ini')
->withOAuth2Credential($oAuth2Credential)
->build();
Em seguida, gere um relatório de campanha usando a
GoogleAdsService.SearchStream
para recuperar as campanhas na sua conta. Este guia não aborda os
detalhes dos relatórios.
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves all campaigns.
$query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
// Issues a search stream request.
/** @var GoogleAdsServerStreamDecorator $stream */
$stream = $googleAdsServiceClient->searchStream(
SearchGoogleAdsStreamRequest::build($customerId, $query)
);
// Iterates over all rows in all messages and prints the requested field values for
// the campaign in each row.
foreach ($stream->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
printf(
"Campaign with ID %d and name '%s' was found.%s",
$googleAdsRow->getCampaign()->getId(),
$googleAdsRow->getCampaign()->getName(),
PHP_EOL
);
}
}
Python
A biblioteca de cliente é distribuída no PyPI
pode ser instalado usando o comando pip
;
da seguinte forma:
python -m pip install google-ads==21.3.0
Faça uma cópia do google-ads.yaml
.
do repositório do GitHub e modificá-lo para incluir suas credenciais.
client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE
Crie uma instância de GoogleAdsClient
chamando o
GoogleAdsClient.load_from_storage
. Passe o caminho para seu
google-ads.yaml
como uma string para o método ao chamá-lo:
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")
Em seguida, gere um relatório de campanha usando a
GoogleAdsService.SearchStream
para recuperar as campanhas na sua conta. Este guia não aborda os
detalhes dos relatórios.
def main(client, customer_id):
ga_service = client.get_service("GoogleAdsService")
query = """
SELECT
campaign.id,
campaign.name
FROM campaign
ORDER BY campaign.id"""
# Issues a search request using streaming.
stream = ga_service.search_stream(customer_id=customer_id, query=query)
for batch in stream:
for row in batch.results:
print(
f"Campaign with ID {row.campaign.id} and name "
f'"{row.campaign.name}" was found.'
)
Ruby
As gems do Ruby para a biblioteca do cliente são publicadas na gem do Rubygems site de hospedagem. A forma recomendada para instalar é usando o bundler. Adicione uma linha ao seu Gemfile:
gem 'google-ads-googleads', '~> 30.0.0'
Depois, execute:
bundle install
Faça uma cópia
google_ads_config.rb
do repositório do GitHub e modificá-lo para incluir suas credenciais.
Google::Ads::GoogleAds::Config.new do |c|
c.client_id = 'INSERT_CLIENT_ID_HERE'
c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end
Crie uma instância GoogleAdsClient
transmitindo o caminho para o local em que ela está
.
client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')
Em seguida, gere um relatório de campanha usando a
GoogleAdsService.SearchStream
para recuperar as campanhas na sua conta. Este guia não aborda os
detalhes dos relatórios.
def get_campaigns(customer_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
responses = client.service.google_ads.search_stream(
customer_id: customer_id,
query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
)
responses.each do |response|
response.results.each do |row|
puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
end
end
end
Perl
A biblioteca é distribuída
CPAN. Comece clonando
google-ads-perl
no diretório de sua escolha.
git clone https://github.com/googleads/google-ads-perl.git
Mude para o diretório google-ads-perl
e execute o seguinte comando em
o prompt de comando para instalar todas as dependências necessárias para usar a biblioteca.
cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps
Faça uma cópia
googleads.properties
do repositório do GitHub e modificá-lo para incluir suas credenciais.
clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Crie uma instância Client
transmitindo o caminho para onde você mantém esse arquivo.
my $properties_file = "/path/to/googleads.properties";
my $api_client = Google::Ads::GoogleAds::Client->new({
properties_file => $properties_file
});
Em seguida, gere um relatório de campanha usando a
GoogleAdsService.SearchStream
para recuperar as campanhas na sua conta. Este guia não aborda os
detalhes dos relatórios.
sub get_campaigns {
my ($api_client, $customer_id) = @_;
# Create a search Google Ads stream request that will retrieve all campaigns.
my $search_stream_request =
Google::Ads::GoogleAds::V17::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
->new({
customerId => $customer_id,
query =>
"SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
});
# Get the GoogleAdsService.
my $google_ads_service = $api_client->GoogleAdsService();
my $search_stream_handler =
Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
service => $google_ads_service,
request => $search_stream_request
});
# Issue a search request and process the stream response to print the requested
# field values for the campaign in each row.
$search_stream_handler->process_contents(
sub {
my $google_ads_row = shift;
printf "Campaign with ID %d and name '%s' was found.\n",
$google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
});
return 1;
}
REST
Comece usando um cliente HTTP para buscar um token de acesso do OAuth 2.0. Este guia
usa o comando curl
.
curl \
--data "grant_type=refresh_token" \
--data "client_id=CLIENT_ID" \
--data "client_secret=CLIENT_SECRET" \
--data "refresh_token=REFRESH_TOKEN" \
https://www.googleapis.com/oauth2/v3/token
Em seguida, gere um relatório de campanha usando a
GoogleAdsService.SearchStream
para recuperar as campanhas na sua conta. Este guia não aborda os
detalhes dos relatórios.
curl -i -X POST https://googleads.googleapis.com/v17/customers/CUSTOMER_ID/googleAds:searchStream \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "developer-token: DEVELOPER_TOKEN" \
-H "login-customer-id: LOGIN_CUSTOMER_ID" \
--data-binary "@query.json"
O conteúdo de query.json
é o seguinte:
{
"query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}