Guida rapida

Questa guida rapida ti aiuta a effettuare la tua prima chiamata API all'API Google Ads.

Concetti fondamentali

  • Progetto Google Cloud:un progetto Google Cloud è la base per creare, abilitare e utilizzare tutti i servizi Google, inclusa la gestione delle API e delle credenziali API OAuth 2.0. Puoi crearne uno dalla console Google Cloud.
  • Livello di accesso API:il livello di accesso API del tuo progetto Google Cloud controlla il numero di chiamate API che puoi effettuare al giorno e gli ambienti a cui puoi effettuare chiamate API. Il livello di accesso all'API del tuo progetto è elencato nella pagina Panoramica dell'API Google Ads.
  • Account amministratore Google Ads:un account amministratore Google Ads viene utilizzato per gestire altri account Google Ads, che potrebbero essere una raccolta di account cliente Google Ads o altri account amministratore Google Ads.
  • Account cliente Google Ads:l'account Google Ads utilizzato per la pubblicazione degli annunci che vuoi targetizzare con le chiamate API.
  • ID cliente cliente:il numero a 10 cifre che identifica un account cliente Google Ads. Se hai copiato questo ID dall'interfaccia utente di Google Ads, assicurati di rimuovere i trattini.
  • OAuth 2.0:OAuth 2.0 è un protocollo standard di settore per l'autorizzazione, utilizzato da tutte le API di Google. Per generare le credenziali OAuth 2.0 per effettuare chiamate API, devi disporre di un service account e di una chiave.
  • Service account:un tipo speciale di Account Google che appartiene alla tua applicazione anziché a un singolo utente. Viene utilizzato per autenticare la tua applicazione nell'API Google Ads. Per ottenere un service account, devi disporre di un progetto Google Cloud.
  • Chiave del service account:un file JSON delle credenziali dell'app che contiene la chiave privata del service account. Viene utilizzato per generare credenziali OAuth 2.0 per autenticare un service account quando effettui una chiamata all'API Google Ads. Per ottenere una chiave del service account, devi disporre di un service account.

Prerequisiti

Per effettuare una chiamata all'API Google Ads, devi completare i seguenti passaggi.

Configurare il progetto cloud per l'accesso all'API Google Ads

Il progetto Google Cloud viene utilizzato per gestire le API di Google e le credenziali API OAuth 2.0. Puoi trovare i tuoi progetti Google Cloud esistenti o crearne uno visitando la console Google Cloud.

Inizia abilitando l'API Google Ads nel tuo progetto:

Abilitare l'API Google Ads

Poi, visita la pagina Panoramica dell'API Google Ads. La pagina mostra il tuo attuale livello di accesso all'API. Se il tuo attuale livello di accesso all'API è Test, espandi la sezione Fai l'upgrade del livello di accesso. Segui le istruzioni per richiedere il livello di accesso Explorer.

Una volta completata la richiesta, Google la esaminerà automaticamente e, nella maggior parte dei casi, eseguirà l'upgrade a Explorer. Se non ti è stato concesso l'accesso Explorer, non preoccuparti. Questa guida fornirà le istruzioni appropriate per configurare il tuo account cliente Google Ads.

Crea un account di servizio

Per effettuare chiamate API, devi disporre di un service account e di una chiave del service account. Se utilizzi già un'altra API di Google e hai creato un service account e una chiave OAuth 2.0, puoi saltare questo passaggio e riutilizzare le credenziali esistenti.

Come creare un service account e una chiave

  1. Nella console Google Cloud, vai a Menu > IAM e amministrazione > Service account.

    Vai a Service account

  2. Seleziona il service account.
  3. Fai clic su Chiavi > Aggiungi chiave > Crea nuova chiave.
  4. Seleziona JSON, quindi fai clic su Crea.

    Una nuova coppia di chiavi pubblica/privata viene generata e scaricata sul tuo computer come nuovo file. Salva il file JSON scaricato come credentials.json nella directory di lavoro. Questo file è l'unica copia di questa chiave. Non eseguire il commit di credentials.json nel controllo della versione (ad esempio, aggiungilo al file .gitignore).

  5. Fai clic su Chiudi.

Inizia identificando l'account Google Ads per cui stai effettuando chiamate API. Il tipo di account a cui puoi effettuare chiamate API dipende dal livello di accesso API del tuo progetto Google Cloud. Controlla la pagina Panoramica dell'API Google Ads per scoprire il tuo livello di accesso all'API.

Livelli di accesso Explorer, Basic e Standard

Puoi effettuare chiamate al tuo account di produzione Google Ads. Tuttavia, se necessario, puoi creare un account di test Google Ads seguendo le istruzioni nella scheda Accesso di test.

Controlla l'accesso

Il tuo progetto Google Cloud non può essere utilizzato per effettuare chiamate API a un account di produzione Google Ads. Puoi effettuare chiamate API solo su account di test Google Ads.

Come creare un account di prova Google Ads

Le seguenti istruzioni creano un account amministratore di test Google Ads e un account inserzionista di test Google Ads al suo interno.

  1. Fai clic sul pulsante blu per creare un account amministratore di test Google Ads. Se richiesto, accedi con un Account Google non collegato al tuo account Google Ads Production Manager. Se non ne hai uno, utilizza il pulsante Crea account in quella pagina per creare un nuovo Account Google.

    Creare un account amministratore test Google Ads

  2. Nell'account amministratore Google Ads Test Manager, crea un account cliente di test Google Ads: fai clic su Account > > Crea nuovo account e compila il modulo. Tutti gli account Google Ads che crei dall'account amministratore di test Google Ads sono automaticamente account di test Google Ads.
  3. (Facoltativo) Crea alcune campagne nell'account cliente di test Google Ads dalla pagina Google Ads.

Per effettuare una chiamata API a un cliente Google Ads, devi concedere l'accesso e le autorizzazioni appropriate al tuo service account per l'account cliente Google Ads. Per farlo, devi disporre dell'accesso amministrativo all'account cliente.

Come concedere l'accesso all'account di servizio al tuo account Google Ads

  1. Per iniziare, accedi al tuo account Google Ads come amministratore.
  2. Vai ad Amministratore > Accesso e sicurezza.
  3. Fai clic sul pulsante nella scheda Utenti.
    Pagina Accesso e sicurezza di Google Ads in cui è visualizzato il pulsante Aggiungi utente
  4. Digita l'indirizzo email del service account nella casella di input Email. Seleziona il livello di accesso all'account appropriato e fai clic sul pulsante Aggiungi account. Tieni presente che il livello di accesso Email non è supportato per i service account.
    Finestra di dialogo per aggiungere l'email di un service account e selezionare un livello di accesso
  5. Al service account viene concesso l'accesso.
    Pagina Accesso e sicurezza che mostra il service account con accesso
  6. [Facoltativo] Non puoi concedere l'accesso amministratore a un service account durante la configurazione iniziale. Se le tue chiamate API richiedono l'accesso amministrativo, puoi eseguire l'upgrade dell'accesso nel seguente modo.
    1. Fai clic sulla freccia del menu a discesa accanto al livello di accesso del service account nella colonna Livello di accesso.
    2. Seleziona Amministratore dall'elenco a discesa.

Scarica strumenti e librerie client

Puoi scegliere di scaricare una libreria client o un client HTTP a seconda di come vuoi effettuare le chiamate API.

Utilizza una libreria client

Scarica e installa una libreria client a tua scelta.

Utilizzare il client HTTP (REST)

curl

Scarica e installa curl, lo strumento a riga di comando per trasferire i dati tramite un URL.

Interfaccia a riga di comando Google Cloud

Segui la guida all'installazione di Google Cloud CLI per installare gcloud CLI.

È stato verificato che le istruzioni per il resto di questa guida funzionano con la seguente versione dello strumento gcloud e potrebbero non funzionare con le versioni precedenti a causa di differenze nel comportamento dell'applicazione o nelle opzioni della riga di comando.

:~$ gcloud version
Google Cloud SDK 492.0.0
alpha 2024.09.06
beta 2024.09.06
bq 2.1.8
bundled-python3-unix 3.11.9
core 2024.09.06
enterprise-certificate-proxy 0.3.2
gcloud-crc32c 1.0.0
gsutil 5.30

Esegui una chiamata API

Seleziona il client che preferisci per istruzioni su come effettuare una chiamata API:

Java

Gli artefatti della libreria client vengono pubblicati nel repository Maven Central.

Per gestire le versioni delle dipendenze ed evitare conflitti, consulta la guida alla distinta materiali (BOM) dell'API Google Ads.

Se non utilizzi la distinta base, aggiungi la libreria client direttamente al tuo progetto utilizzando uno dei seguenti strumenti di build:

Maven: aggiungi la seguente dipendenza al file pom.xml:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>46.1.0</version>
</dependency>

Gradle: aggiungi la seguente dipendenza al file build.gradle:

implementation 'com.google.api-ads:google-ads:46.1.0'

Crea un file ads.properties nella tua home directory (~/ads.properties su Linux e macOS o %USERPROFILE%\ads.properties su Windows) con il seguente contenuto:

api.googleads.serviceAccountSecretsPath=JSON_KEY_FILE_PATH
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Prima di eseguire richieste API, crea un'istanza GoogleAdsClient. Per impostazione predefinita, fromPropertiesFile() carica le credenziali dal file ads.properties che si trova nella tua home directory:

GoogleAdsClient googleAdsClient;
try {
  googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (IOException e) {
  System.err.printf("Failed to create GoogleAdsClient: %s%n", e);
  throw new RuntimeException("Initialization failed", e);
}

Successivamente, esegui un report sulla campagna utilizzando GoogleAdsService.SearchStream per trasmettere in streaming in modo efficiente set di risultati di grandi dimensioni e recuperare le campagne nel tuo account:

    private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}

C#

I pacchetti della libreria client vengono pubblicati nel repository NuGet.org. Inizia aggiungendo un riferimento al pacchetto NuGet al pacchetto Google.Ads.GoogleAds:

dotnet add package Google.Ads.GoogleAds --version 27.4.0

Per effettuare chiamate API, crea un oggetto GoogleAdsConfig dalle impostazioni di configurazione (ad esempio appsettings.json, variabili di ambiente o impostazioni personalizzate) e passalo per inizializzare un'istanza GoogleAdsClient:

GoogleAdsConfig config = new GoogleAdsConfig()
{
    OAuth2Mode = OAuth2Flow.SERVICE_ACCOUNT,
    OAuth2SecretsJsonPath = "JSON_KEY_FILE_PATH",
    LoginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
};
GoogleAdsClient client = new GoogleAdsClient(config);

Successivamente, esegui un report sulle campagne utilizzando il metodo GoogleAdsService.SearchStream per recuperare le campagne nel tuo account. Questa guida non copre i dettagli dei report.

    public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V25.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}

PHP

I pacchetti della libreria client vengono pubblicati nel repository Packagist. Assicurati di avere una versione di PHP compatibile e Composer installato, poi passa alla directory principale del progetto ed esegui il comando seguente per installare la libreria e le relative dipendenze nella directory vendor/ del progetto:

composer require googleads/google-ads-php:35.1.0

Crea una copia del file google_ads_php.ini dal repository GitHub, salvala nella home directory o nella directory root del progetto e modificala in modo da includere le tue credenziali:

[GOOGLE_ADS]
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"

[OAUTH2]
jsonKeyFilePath = "JSON_KEY_FILE_PATH"
scopes = "https://www.googleapis.com/auth/adwords"

Crea un'istanza GoogleAdsClient utilizzando il file di configurazione google_ads_php.ini:

use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V25\GoogleAdsClientBuilder;

$oauth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oauth2Credential)
    ->build();

Successivamente, genera un report sulle campagne utilizzando il metodo GoogleAdsService.SearchStream per recuperare le campagne nel tuo account:

    public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}

Python

La libreria client dell'API Google Ads per Python viene distribuita su PyPI. Assicurati di aver installato una versione di Python supportata, quindi installa la libreria utilizzando pip:

python -m pip install google-ads==33.0.0

Per autenticare le chiamate API, configura un file google-ads.yaml:

  1. Scarica una copia del file di esempio google-ads.yaml dal repository GitHub.
  2. Salva il file nella tua directory home (~/google-ads.yaml) o in un percorso personalizzato.
  3. Apri google-ads.yaml e aggiornalo in modo da includere le tue credenziali:

    login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE
    json_key_file_path: JSON_KEY_FILE_PATH
    

    Configura la registrazione prima di inizializzare il client in modo che la libreria acquisisca eventuali avvisi di inizializzazione o configurazione. L'esempio seguente configura il logger della libreria per generare log INFO nell'output standard (stdout):

import logging
import sys

logger = logging.getLogger("google.ads.googleads.client")
logger.setLevel(logging.INFO)
logger.addHandler(logging.StreamHandler(sys.stdout))

Crea un'istanza GoogleAdsClient chiamando il metodo GoogleAdsClient.load_from_storage e passando il percorso al file google-ads.yaml:

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

Se ometti l'argomento path, load_from_storage() cerca il file di configurazione nella tua home directory (~/google-ads.yaml) per impostazione predefinita.

Successivamente, genera un report sulle campagne utilizzando il metodo GoogleAdsService.SearchStream per recuperare le campagne nel tuo account:

    def main(client: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

    query: str = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )

Ruby

Le gemme Ruby per la libreria client sono pubblicate su RubyGems. Assicurati di aver installato una versione di Ruby supportata e utilizza Bundler per installare la libreria:

  1. Aggiungi la gemma al file Gemfile dell'applicazione:

    gem 'google-ads-googleads', '~> 45.1.0'
    
  2. Installa il gem eseguendo:

    bundle install

Per configurare le credenziali:

  1. Copia il file di esempio google_ads_config.rb dal repository GitHub.
  2. Salva il file nella directory root del progetto o nella directory home (~).
  3. Apri google_ads_config.rb e sostituisci i valori segnaposto con le tue credenziali dell'API Google Ads:

    Google::Ads::GoogleAds::Config.new do |c|
      c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
      c.keyfile = 'JSON_KEY_FILE_PATH'
    end
    

    Crea un'istanza GoogleAdsClient passando il percorso del file di configurazione (google_ads_config.rb):

client = Google::Ads::GoogleAds::GoogleAdsClient.new(
  'path/to/google_ads_config.rb'
)

Successivamente, genera un report sulle campagne utilizzando il metodo GoogleAdsService.SearchStream per recuperare le campagne nel tuo account:

    def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end

Perl

La libreria client Perl è distribuita su CPAN e richiede Perl 5.28 o versioni successive e il gestore di pacchetti cpan o cpanm.

  1. Clona il repository google-ads-perl nella directory che preferisci:

    git clone https://github.com/googleads/google-ads-perl.git
  2. Passa alla directory google-ads-perl ed esegui i seguenti comandi per installare le dipendenze richieste e creare la libreria:

    cd google-ads-perl
    cpan install Module::Build
    perl Build.PL
    perl Build installdeps
    perl Build
    perl Build install

Per configurare le credenziali:

  1. Copia il file di configurazione di esempio googleads.properties dal repository GitHub alla tua home directory (~/googleads.properties):

    cp googleads.properties ~/googleads.properties
  2. Modifica ~/googleads.properties per includere le tue credenziali:

    jsonKeyFilePath=JSON_KEY_FILE_PATH
    loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
    

    Crea un'istanza Client passando il percorso al file googleads.properties configurato (ad esempio ~/googleads.properties):

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => "/path/to/googleads.properties"
});

Successivamente, genera un report sulle campagne utilizzando il metodo GoogleAdsService.SearchStream per recuperare le campagne nel tuo account:

    sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V25::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}

Quando viene eseguito, lo script trasmette in streaming le righe corrispondenti e stampa l'ID e il nome di ogni campagna nel tuo account.

curl

Inizia impostando il service account come credenziali attive in gcloud CLI.

gcloud auth login --cred-file=JSON_KEY_FILE_PATH

Successivamente, recupera un token di accesso OAuth 2.0 per l'API Google Ads.

gcloud auth \
  print-access-token \
  --scopes='https://www.googleapis.com/auth/adwords'

Crea un file denominato query.json contenente la richiesta Google Ads Query Language (GAQL):

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}

Genera un report sulle campagne utilizzando il metodo GoogleAdsService.SearchStream per recuperare le campagne nel tuo account:

curl -i -X POST \
  https://googleads.googleapis.com/v25/customers/CUSTOMER_ID/googleAds:searchStream \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "login-customer-id: LOGIN_CUSTOMER_ID" \
  --data-binary "@query.json"

Se riscontri errori durante la prima chiamata, consulta Gestire gli errori API per indicazioni sulla risoluzione dei problemi.