As seções a seguir descrevem como começar a usar a API Search Ads 360 Reporting.
Configurar seu projeto no Google Cloud
Para usar a API Search Ads 360 Reporting, é necessário criar um projeto para seu aplicativo no Google Cloud.
Criar um projeto do Google
Um projeto do Google serve como um contêiner de recursos para os recursos do Google Cloud.
- Acesse o Console de APIs do Google.
- Clique em Criar projeto.
- Insira um nome ou aceite a sugestão gerada.
- Confirme ou edite os campos restantes.
- Clique em Criar.
Criar credenciais do OAuth 2.0
A API Search Ads 360 Reporting usa o OAuth 2.0 para autenticação e autorização. As credenciais do OAuth identificam seu app para o Google e permitem gerar tokens do OAuth para gerenciar usuários do Search Ads 360.
Para criar uma credencial do OAuth 2.0 no Console de APIs do Google, faça o seguinte:
- Acesse a página Clientes.
- Clique em Criar credenciais > ID do cliente OAuth.
- Selecione o tipo de aplicativo.
- Preencha o formulário e clique em Criar.
Ativar a API Search Ads 360 Reporting
Para usar a API, é necessário ativar a API Search Ads 360 Reporting para seu projeto no Console de APIs do Google.
Para ativar uma API para um projeto, faça o seguinte:
- Abra a biblioteca de APIs no Console de APIs do Google.
- Se for solicitado, selecione um projeto ou crie um novo. A biblioteca de APIs lista todas as APIs disponíveis, agrupadas por família de produtos e popularidade.
- Se a API que você quer ativar não estiver visível na lista, use a pesquisa para encontrá-la ou clique em Ver tudo na família de produtos a que ela pertence.
- Selecione aquela que você quer habilitar e clique no botão Ativar.
- Se necessário, ative o faturamento.
- Se for solicitado, leia e aceite os Termos de Serviço da API.
Ativar o faturamento do projeto (opcional)
Não há cobrança pelo uso da API Search Ads 360 Reporting no Google Cloud. No entanto, há uma cota para o número total de projetos sem custo financeiro do Cloud para cada conta. Se você atingiu o limite, inscreva-se em uma nova Conta do Google que inclua uma cota de projeto sem custo financeiro.
Para ativar o faturamento no seu projeto:
- Visite a Página de faturamento.
- Se você não tiver uma conta de faturamento ativa, crie uma clicando em Adicionar conta de faturamento e seguindo as instruções.
Ativar a tela de consentimento do projeto
Para ativar a tela de consentimento do projeto:
- Abra a página de branding no Console do Google Cloud.
- Se for solicitado, selecione um projeto ou crie um novo.
- Preencha o formulário e clique em Salvar.
Criar, editar ou visualizar URIs de redirecionamento
Para criar, visualizar ou editar os URIs de redirecionamento de uma determinada credencial do OAuth 2.0, faça o seguinte:
- Acesse a página Clientes.
- Clique no cliente.
- Visualize ou edite os URIs de redirecionamento.
Se não houver um cliente listado na página "Clientes", seu projeto não terá credenciais do OAuth. Para criar uma, clique em Criar cliente.
Fazer o download de uma biblioteca de cliente
Usar uma biblioteca de cliente da API Search Ads 360 Reporting é a maneira recomendada de se conectar à API Search Ads 360 Reporting.
Faça o download da biblioteca de cliente da API Search Ads 360 Reporting para seu ambiente de desenvolvimento. Siga as instruções específicas da linguagem sobre como configurar o arquivo de configuração da biblioteca de cliente. Na maioria dos casos, é possível reutilizar a configuração atual ao migrar para a nova biblioteca de cliente da API Search Ads 360 Reporting.
Uma mudança importante é o novo cabeçalho login-customer-id. Consulte o
cabeçalho do ID do cliente de login para
saber quando é necessário adicionar isso à configuração.
Fazer sua primeira chamada
Depois de configurar a biblioteca de cliente, você pode fazer sua primeira chamada.
Acessar campanhas
No seu ambiente de desenvolvimento integrado, execute o seguinte código:
Java
// Copyright 2022 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package sample; import com.beust.jcommander.Parameter; import com.google.ads.searchads360.v0.lib.SearchAds360Client; import com.google.ads.searchads360.v0.services.SearchAds360Row; import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient; import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse; import com.google.ads.searchads360.v0.services.SearchSearchAds360Request; /** Get campaign details. */ public class GetCampaigns { private static final int PAGE_SIZE = 200; private static class GetCampaignsParams extends CodeSampleParams { @Parameter(names = "--customerId", required = true) private String customerId; @Parameter(names = "--loginCustomerId") private String loginCustomerId; } public static void main(String[] args) { GetCampaignsParams params = new GetCampaignsParams(); if (!params.parseArguments(args)) { // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId // here (10 digits, no dashes). If neither are set, customerId will be used as // loginCustomerId. // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE"); } final String loginCustomerId = params.loginCustomerId; final String customerId = params.customerId; try { // Creates a SearchAds360Client with the specified loginCustomerId. If there's // no loginCustomerId, customerId will be used instead. final SearchAds360Client searchAds360Client = SearchAds360Client.newBuilder() .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId) .fromPropertiesFile() .build(); // Creates the Search Ads 360 Service client. SearchAds360ServiceClient client = searchAds360Client.create(); new GetCampaigns().runExample(client, customerId); } catch (Exception exception) { System.err.printf("Failed with exception: %s%n", exception); exception.printStackTrace(); System.exit(1); } } private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) { // Creates a query that retrieves all campaigns under the customerId. String query = """ SELECT campaign.name, campaign.id, campaign.status FROM campaign """; SearchSearchAds360Request request = SearchSearchAds360Request.newBuilder() .setCustomerId(customerId) .setQuery(query) .setPageSize(PAGE_SIZE) .build(); // Issues a search request. final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request); for (SearchAds360Row element : searchPagedResponse.iterateAll()) { System.out.printf( "Campaign found with name '%s', ID %d, and status: %s.%n", element.getCampaign().getName(), element.getCampaign().getId(), element.getCampaign().getStatus()); } } }
Python
#!/usr/bin/env python # Copyright 2022 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Retrieves campaigns for a customer using a pagination search request.""" import argparse import traceback from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360Request from util_searchads360 import SearchAds360Client _DEFAULT_PAGE_SIZE = 10000 def main(client, customer_id, page_size) -> None: search_ads_360_service = client.get_service() query = """ SELECT campaign.name, campaign.id, campaign.status FROM campaign""" request = SearchSearchAds360Request() request.customer_id = customer_id request.query = query request.page_size = page_size # Issues a search request. results = search_ads_360_service.search(request=request) for row in results: campaign = row.campaign print( f'campaign "{campaign.name}" has id {campaign.id} and status {campaign.status.name}' ) if __name__ == "__main__": # SearchAds360Client will read the search-ads-360.yaml configuration file in # the home directory if none is specified. search_ads_360_client = SearchAds360Client.load_from_file() parser = argparse.ArgumentParser( description=("Retrieves campaigns for a customer.")) # Arguments to provide to run the example. parser.add_argument( "-c", "--customer_id", type=str, required=True, help="The Search Ads 360 customer ID (10 digits, no dashes).", ) parser.add_argument( "-l", "--login_customer_id", type=str, required=False, help="The Search Ads 360 login customer ID (10 digits, no dashes).", ) args = parser.parse_args() search_ads_360_client.set_ids(args.customer_id, args.login_customer_id) try: main(search_ads_360_client, args.customer_id, _DEFAULT_PAGE_SIZE) except Exception: # pylint: disable=broad-except traceback.print_exc()
O console vai imprimir uma lista das campanhas na sua conta.
Usar REST
Se você decidir não usar uma biblioteca de cliente, precisará entender como usar REST.
Se você usou REST com a API Search Ads 360 antiga, suas credenciais ainda vão funcionar com a nova API Search Ads 360 Reporting. Encontre o novo endpoint e outros detalhes na seção de referência REST.
Saiba mais
Saiba mais sobre a API Search Ads 360 Reporting
Consultas:
Conceitos: