En las siguientes secciones, se describe cómo comenzar a usar la API de Search Ads 360 Reporting.
Configura tu proyecto en Google Cloud
Para usar la API de Informes de Search Ads 360, debes crear un proyecto para tu aplicación en Google Cloud.
Crea un proyecto de Google
Un proyecto de Google funciona como un contenedor de recursos para tus recursos de Google Cloud.
- Go to the Google API Console.
- Haz clic en Crear proyecto.
- Ingresa un nombre o acepta la sugerencia generada.
- Confirma o edita los campos restantes.
- Haz clic en Crear.
Crea credenciales de OAuth2
La API de Search Ads 360 Reporting usa OAuth 2.0 para la autenticación y la autorización. Las credenciales de OAuth identifican tu aplicación ante Google y te permiten generar tokens de OAuth para administrar usuarios de Search Ads 360.
Para crear una credencial de OAuth 2.0 en Google API Console, haz lo siguiente:
- Go to the Clients page.
- Haz clic en Crear credenciales > ID de cliente de OAuth.
- Selecciona el tipo de solicitud.
- Completa el formulario y haz clic en Crear.
Habilita la API de Search Ads 360 Reporting
Para usar la API, debes habilitar la API de Search Ads 360 Reporting para tu proyecto en la Consola de APIs de Google.
Para habilitar una API en tu proyecto, sigue estos pasos:
- Open the API Library en el Google API Console.
- If prompted, select a project, or create a new one. La API Library enumera todas las APIs disponibles, agrupadas por familia de productos y popularidad.
- Si la API que quieres habilitar no está en la lista, usa la búsqueda para encontrarla o haz clic en Ver todo en la familia de productos a la que pertenece.
- Selecciona la API que deseas habilitar y, luego, haz clic en el botón Habilitar.
- If prompted, enable billing.
- If prompted, read and accept the API's Terms of Service.
Opcionalmente, habilita la facturación para tu proyecto
No se aplican cargos por usar la API de Search Ads 360 Reporting en Google Cloud. Sin embargo, existe una cuota para la cantidad total de proyectos de Cloud gratuitos por cuenta. Si alcanzaste el límite, puedes registrarte para obtener una nueva Cuenta de Google que incluya una cuota de proyectos gratuita.
Para habilitar la facturación de tu proyecto, haz lo siguiente:
- Visita Billing page.
- Si no tienes una cuenta de facturación activa, crea una. Para ello, haz clic en Agregar cuenta de facturación y sigue las instrucciones.
Habilita la pantalla de consentimiento de tu proyecto
Para habilitar la pantalla de consentimiento de tu proyecto, haz lo siguiente:
- Abre el archivo Branding page en el Google Cloud Console.
- If prompted, select a project, or create a new one.
- Completa el formulario y haz clic en Guardar.
Cómo crear, editar o ver URIs de redireccionamiento
Para crear, ver o editar los URIs de redireccionamiento de una credencial de OAuth 2.0 determinada, haz lo siguiente:
- Go to the Clients page.
- Haz clic en el cliente.
- Consulta o edita los URIs de redireccionamiento.
Si no hay ningún cliente en la página Clientes, tu proyecto no tiene credenciales de OAuth. Para crear uno, haz clic en Crear cliente.
Descarga una biblioteca cliente
Se recomienda usar una biblioteca cliente de la API de Search Ads 360 Reporting para conectarse a la API de Search Ads 360 Reporting.
Descarga la biblioteca cliente de la API de Search Ads 360 Reporting para tu entorno de desarrollo. Sigue las instrucciones específicas del lenguaje sobre cómo configurar el archivo de configuración de tu biblioteca cliente. En la mayoría de los casos, puedes reutilizar tu configuración existente cuando migres a la nueva biblioteca cliente de la API de Search Ads 360 Reporting.
Un cambio importante es el nuevo encabezado login-customer-id
. Consulta Encabezado del ID de cliente de acceso para obtener detalles sobre cuándo debes agregar esto a tu configuración.
Realiza tu primera llamada
Una vez que hayas configurado tu biblioteca cliente, podrás realizar tu primera llamada.
Obtener campañas
En tu IDE, ejecuta el siguiente 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()
La consola debería imprimir una lista de las campañas de tu cuenta.
Usa REST
Si decides no usar una biblioteca cliente, deberás comprender cómo usar REST.
Si usaste REST con la API anterior de Search Ads 360, tus credenciales seguirán funcionando con la nueva API de Search Ads 360 Reporting. Encuentra el nuevo extremo y otros detalles en la sección de referencia de REST.
Más información
Obtén más información sobre la API de Search Ads 360 Reporting
Consultas:
Conceptos: