Comienza a usar la API de informes de Search Ads 360

En las siguientes secciones, se describe cómo comenzar a usar la API de informes de Search Ads 360.

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 sirve como un contenedor de recursos para tus recursos de Google Cloud.

1. Go to the Google API Console.
2. Haz clic en Crear proyecto .
3. Ingrese un nombre o acepte la sugerencia generada.
4. Confirme o edite los campos restantes.
5. Haz clic en Crear .

Crear credenciales de OAuth2

La API de informes de Search Ads 360 usa OAuth 2.0 para la autenticación y la autorización. Las credenciales de OAuth identifican tu app ante Google y te permiten generar tokens de OAuth para administrar usuarios de Search Ads 360.

Para crear una credencial OAuth 2.0 en Google API Console , haga lo siguiente:

1. Go to the Credentials page.
2. Haga clic en Crear credenciales> ID de cliente OAuth
3. Seleccione su tipo de aplicación.
4. Rellene el formulario y haga clic en Crear .

Advertencia: Cualquier app de Google Cloud que se use para obtener credenciales para el permiso de informes de Search Ads 360 necesita la verificación de OAuth de Google. La verificación evita que se muestre una pantalla de la IU sin verificar a los usuarios cuando acceden.

Habilita la API de informes de Search Ads 360

Si deseas usar la API, debes habilitar la API de Search Ads 360 Reporting para tu proyecto en la Consola de API de Google.

Para habilitar una API para su proyecto:

1. Open the API Library en Google API Console .
2. If prompted, select a project, or create a new one. El API Library enumera todas las API disponibles, agrupadas por familia de productos y popularidad.
3. Si la API que desea habilitar no está visible en la lista, use la búsqueda para encontrarla o haga clic en Ver todo en la familia de productos a la que pertenece.
4. Seleccione la API que desea habilitar, luego haga clic en el botón Habilitar .
5. If prompted, enable billing.
6. If prompted, read and accept the API's Terms of Service.

Habilita la facturación para tu proyecto de manera opcional

No se aplican cargos por usar la API de informes de Search Ads 360 en Google Cloud. Sin embargo, existe una cuota para la cantidad total de proyectos gratuitos de Cloud de cada cuenta. Si alcanzaste el límite, puedes registrarte para obtener una Cuenta de Google nueva que incluirá una cuota de proyectos gratuitos.

Nota: Si ya tienes habilitada la facturación (por ejemplo, para Google Cloud), debes seleccionar una cuenta de facturación para el proyecto.

Para habilitar la facturación de su proyecto:

1. Visite el Billing page .
2. Si no tiene una cuenta de facturación activa, cree una haciendo clic en Agregar cuenta de facturación y siguiendo las instrucciones.

Habilita la pantalla de consentimiento de tu proyecto

Para habilitar la pantalla de consentimiento de su proyecto:

1. Abra el Consent Screen page en el Google API Console .
2. If prompted, select a project, or create a new one.
3. Rellene el formulario y haga clic en Guardar .

Cómo crear, editar o ver los URI de redireccionamiento

Para crear, ver o editar los URI de redireccionamiento para una credencial de OAuth 2.0 dada, haga lo siguiente:

1. Go to the Credentials page.
2. En la sección de ID de cliente OAuth 2.0 de la página, haga clic en una credencial.
3. Ver o editar los URI de redireccionamiento.

Si no hay una sección de ID de cliente OAuth 2.0 en la página Credenciales, entonces su proyecto no tiene credenciales OAuth. Para crear uno, haga clic en Crear credenciales .

Descarga una biblioteca cliente

Se recomienda usar una biblioteca cliente de la API de informes de Search Ads 360 para conectarse a la API de informes de Search Ads 360.

Descarga la biblioteca cliente de la API de Search Ads 360 Reporting para tu entorno de desarrollo. Sigue las instrucciones específicas del lenguaje para configurar el archivo de configuración de tu biblioteca cliente. En la mayoría de los casos, puedes volver a usar la 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 el encabezado de ID de cliente de acceso para obtener detalles sobre cuándo debes agregarlo a tu configuración.

Realiza tu primera llamada

Una vez que hayas configurado la biblioteca cliente, puedes 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());
    }
  }
}

Descargar 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()

Descargar get_campaigns.py

La consola debería imprimir una lista de las campañas en tu cuenta.

Usa REST

Si decides no usar una biblioteca cliente, debes comprender cómo usar REST.

Si usabas REST con la API de Search Ads 360 anterior, tus credenciales seguirán funcionando con la API de informes de la nueva experiencia de Search Ads 360. Busca el extremo nuevo y otros detalles en la sección de referencia de REST.

Más información

Más información sobre la API de informes de Search Ads 360

• Consultas:

  • Lenguaje de consulta de Search Ads 360
  • Cómo crear informes de búsqueda
  • Recupera metadatos

• Conceptos:

  • Estructura de la API de informes de Search Ads 360
  • Estructura de llamadas a la API de informes de Search Ads 360
  • Control de versiones en la API de informes de Search Ads 360
  • Bibliotecas cliente de la API de informes de Search Ads 360