As seções a seguir descrevem como começar a usar o Search Ads 360 API Reporting.
Configurar seu projeto no Google Cloud
Para usar a API Search Ads 360 Reporting, você precisa criar um projeto para sua no Google Cloud.
Criar um projeto do Google
Um projeto do Google serve como um contêiner de recursos para seus recursos do Google Cloud.
- Go to the Google API Console.
- Clique em Criar projeto .
- Digite um nome ou aceite a sugestão gerada.
- Confirme ou edite os campos restantes.
- Clique em Create .
Criar credenciais do OAuth2
A API Search Ads 360 Reporting usa o OAuth 2.0 para autenticação e autorização. As credenciais OAuth identificam seu app para o Google e permitem que você gerar tokens OAuth para gerenciar usuários do Search Ads 360.
Para criar uma credencial do OAuth 2.0 no Google API Console , faça o seguinte:
- Go to the Credentials page.
- Clique em Criar credenciais> ID do cliente OAuth
- Selecione seu tipo de aplicativo.
- Preencha o formulário e clique em Criar .
Ativar a API Search Ads 360 Reporting
Para usar a API, você precisa ativar a API Search Ads 360 Reporting para sua projeto no Console de APIs do Google.
Para habilitar uma API para o seu projeto:
- Open the API Library no Google API Console .
- If prompted, select a project, or create a new one. O API Library lista todas as APIs disponíveis, agrupadas por família de produtos e popularidade.
- Se a API que você deseja ativar não estiver visível na lista, use a pesquisa para encontrá-la ou clique em Ver tudo na família de produtos à qual pertence.
- Selecione a API que você deseja ativar e clique no botão Ativar .
- If prompted, enable billing.
- If prompted, read and accept the API's Terms of Service.
Se quiser, ative o faturamento do seu projeto
O uso da API Search Ads 360 Reporting no Google Cloud não é cobrado. No entanto, há uma cota para o número total de projetos do Cloud sem custo financeiro para cada do Compute Engine. Se você tiver atingido o limite, poderá se inscrever em uma nova que incluirá uma cota sem custo financeiro de projeto.
Para ativar o faturamento do seu projeto:
- Visite o Billing page .
- Se você não possui uma conta de cobrança ativa, crie uma clicando em Adicionar conta de cobrança e siga as instruções.
Ativar a tela de consentimento do seu projeto
Para ativar a tela de consentimento do seu projeto:
- Abra o Consent Screen page no Google API Console .
- If prompted, select a project, or create a new one.
- Preencha o formulário e clique em Salvar .
Criar, editar ou visualizar URIs de redirecionamento
Para criar, exibir ou editar os URIs de redirecionamento para uma determinada credencial do OAuth 2.0, faça o seguinte:
- Go to the Credentials page.
- Na seção IDs do cliente OAuth 2.0 da página, clique em uma credencial.
- Exibir ou editar os URIs de redirecionamento.
Se não houver uma seção IDs de cliente OAuth 2.0 na página Credenciais, seu projeto não terá credenciais OAuth. Para criar uma, clique em Criar credenciais .
Fazer o download de uma biblioteca de cliente
Usar uma biblioteca de cliente da API Search Ads 360 Reporting é a forma recomendada de conectar à API Search Ads 360 Reporting.
Faça o download da biblioteca de cliente da API Search Ads 360 Reporting para seu desenvolvimento de nuvem. 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
Cabeçalho do ID de cliente de login de
detalhes sobre quando é preciso adicionar isso à configuração.
Faça sua primeira ligação
Depois de configurar sua biblioteca cliente, você pode fazer sua primeira a chamada.
Acessar campanhas
No seu ambiente de desenvolvimento integrado, execute este 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());
}
}
}
Faça o download do GetCampaigns.java
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()
Fazer o download de get_campaigns.py
O console 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 antiga do Search Ads 360, suas credenciais ainda serão funcionam 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: