La nuova API Search Ads 360 Reporting è ora disponibile. Unisciti al gruppo Google searchads-api-announcements per non perderti i prossimi miglioramenti e release.

Inizia a utilizzare l'API Search Ads 360 Reporting

Nelle sezioni seguenti viene descritto come iniziare a utilizzare l'API Search Ads 360 Reporting.

Configurare il progetto su Google Cloud

Per utilizzare l'API Search Ads 360 Reporting, devi creare un progetto per la tua applicazione su Google Cloud.

Creare un progetto Google

Un progetto Google funge da container di risorse per le risorse Google Cloud.

Vai alla console dell'API di Google.
Fai clic su Crea progetto.
Inserisci un nome o accetta il suggerimento generato.
Conferma o modifica i campi rimanenti.
Fai clic su Crea.

Creare le credenziali OAuth 2.0

L'API Search Ads 360 Reporting utilizza OAuth 2.0 per l'autenticazione e l'autorizzazione. Le credenziali OAuth identificano la tua app per Google e ti consentono di generare token OAuth per la gestione degli utenti di Search Ads 360.

Per creare una credenziale OAuth 2.0 nella console API di Google:

Vai alla pagina Client.
Fai clic su Crea credenziali > ID client OAuth.
Seleziona il tipo di applicazione.
Compila il modulo e fai clic su Crea.

Abilitare l'API Search Ads 360 Reporting

Per utilizzare l'API, devi abilitare l'API Search Ads 360 Reporting per il tuo progetto nella console dell'API di Google.

Per abilitare un'API per il tuo progetto:

Apri la libreria API nella console dell'API di Google.
Se richiesto, seleziona un progetto o creane uno nuovo. La libreria API elenca tutte le API disponibili, raggruppate per famiglia di prodotti e popolarità.
Se l'API che vuoi abilitare non è visibile nell'elenco, utilizza la ricerca per trovarla o fai clic Visualizza tutto nella famiglia di prodotti a cui appartiene.
Seleziona l'API che vuoi abilitare, quindi fai clic sul pulsante Abilita.
Se richiesto, abilita la fatturazione.
Se richiesto, leggi e accetta i Termini di servizio dell'API.

(Facoltativo) Abilitare la fatturazione per il progetto

Non è previsto alcun costo per l'utilizzo dell'API Search Ads 360 Reporting in Google Cloud. Tuttavia, esiste una quota per il numero totale di progetti Cloud senza costi per ogni account. Se hai raggiunto il limite, puoi registrarti per un nuovo account Google che includerà una quota di progetti senza costi.

Per abilitare la fatturazione per il tuo progetto:

Visita la pagina Fatturazione.
Se non hai un account di fatturazione attivo, creane uno facendo clic su Aggiungi account di fatturazione e seguendo le istruzioni.

Abilitare la schermata per il consenso del progetto

Per abilitare la schermata per il consenso del progetto:

Apri la pagina Branding nella console Google Cloud.
Se richiesto, seleziona un progetto o creane uno nuovo.
Compila il modulo e fai clic su Salva.

Creare, modificare o visualizzare gli URI di reindirizzamento

Per creare, visualizzare o modificare gli URI di reindirizzamento per una determinata credenziale OAuth 2.0:

Vai alla pagina Client.
Fai clic sul client.
Visualizza o modifica gli URI di reindirizzamento.

Se nella pagina Client non è elencato alcun client, significa che il tuo progetto non ha credenziali OAuth. Per crearne una, fai clic su Crea client.

Scaricare una libreria client

L'utilizzo di una libreria client dell'API Search Ads 360 Reporting è il modo consigliato per connettersi all'API Search Ads 360 Reporting.

Scarica la libreria client dell'API Search Ads 360 Reporting per il tuo ambiente di sviluppo. Segui le istruzioni specifiche per la lingua su come configurare il file di configurazione della libreria client. Nella maggior parte dei casi, puoi riutilizzare la configurazione esistente durante la migrazione alla libreria client dell'API Search Ads 360 Reporting.

Una modifica importante è il nuovo header login-customer-id. Per maggiori dettagli su quando devi aggiungerlo alla configurazione, consulta la sezione Header ID cliente di accesso.

Effettuare la prima chiamata

Dopo aver configurato la libreria client, puoi effettuare la prima chiamata.

Recuperare le campagne

Nel tuo IDE, esegui il seguente codice:

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());
    }
  }
}

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

Scarica get_campaigns.py

La console dovrebbe stampare un elenco delle campagne nel tuo account.

Utilizzare REST

Se decidi di non utilizzare una libreria client, devi capire come utilizzare REST.

Se hai utilizzato REST con la vecchia API Search Ads 360, le tue credenziali continueranno a funzionare con la nuova API Search Ads 360 Reporting. Trova il nuovo endpoint e altri dettagli nella sezione di riferimento REST.

Scopri di più

Scopri di più sull'API Search Ads 360 Reporting