Inizia a utilizzare l'API Search Ads 360 Reporting

Le sezioni seguenti descrivono 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 contenitore di risorse per le tue risorse Google Cloud.

Creare le credenziali OAuth2

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 gestire gli utenti di Search Ads 360.

Avviso: qualsiasi app Google Cloud utilizzata per ottenere le credenziali per l'ambito dei report di Search Ads 360 deve essere verificata tramite OAuth di Google. La verifica evita che la schermata dell'interfaccia utente non verificata venga mostrata agli utenti al momento dell'accesso.

Attivare l'API Search Ads 360 Reporting

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

Se vuoi, abilita la fatturazione per il tuo progetto

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

Nota: se hai già attivato la fatturazione (ad esempio per Google Cloud), devi selezionare un account di fatturazione per il tuo progetto.

Attivare la schermata per il consenso del progetto

Creare, modificare o visualizzare gli URI di reindirizzamento

Scaricare una libreria client

L'utilizzo di una libreria client dell'API Search Ads 360 Reporting è il metodo consigliato per collegarsi 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 nuova libreria client dell'API Search Ads 360 Reporting.

Una modifica importante è la nuova intestazione login-customer-id. Consulta la sezione Intestazione ID cliente di accesso per informazioni dettagliate su quando devi aggiungerlo alla configurazione.

Effettua la tua prima chiamata

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

Recupera campagne

Nell'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 utilizzavi REST con la precedente 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

• Query:

  • Lingua di query di Search Ads 360
  • Creare report sulle ricerche
  • Recupero dei metadati

• Concetti:

  • Struttura dell'API Search Ads 360 Reporting
  • Struttura delle chiamate all'API Search Ads 360 Reporting
  • Controllo delle versioni nell'API Search Ads 360 Reporting
  • Librerie client per l'API Search Ads 360 Reporting