Iniziare

Ti consigliamo di utilizzare la libreria client con Apache Maven (o Gradle).

Crea un nuovo progetto Maven/Gradle

Crea un nuovo progetto Maven/Gradle nell'IDE di tua scelta. I nostri artefatti sono pubblicati nel repository centrale Maven.

La dipendenza Maven è:

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

La dipendenza di Gradle è:

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

Puoi anche creare dal codice sorgente. Ai fini di questa guida, si presume che tu abbia una configurazione di progetto con le dipendenze obbligatorie disponibili.

Ottenere le credenziali per l'autenticazione con l'API

L'accesso all'API Google Ads richiede credenziali OAuth e un token sviluppatore dell'API Google Ads. In questa sezione viene spiegato cosa sono, come vengono utilizzati e come vengono ottenuti.

Token sviluppatore (per l'accesso all'API)

Il token sviluppatore è collegato a un account amministratore e disponibile nell'interfaccia web di Google Ads.

Sebbene il token sviluppatore sia collegato a un account amministratore, non consente l'accesso a quell'account. Il token sviluppatore concede invece l'accesso all'API in generale e l'accesso a livello di account è configurato tramite OAuth.

Credenziali OAuth (per l'accesso agli account Google Ads)

Per autorizzare come utenti di Account Google l'accesso agli account Google Ads, devi fornire un set di credenziali OAuth.

Esistono due flussi OAuth generalmente utilizzati: app desktop (installata) o app web. La differenza principale tra i due è che le app desktop devono aprire il browser di sistema e fornire un URI di reindirizzamento locale per gestire le risposte dal server di autorizzazione di Google, mentre le app web possono reindirizzare un browser di terze parti arbitrario per completare l'autorizzazione e inviare le credenziali al server. La libreria supporta anche il flusso degli account di servizio meno di uso comune.

Se autorizzi utilizzando le tue credenziali (flusso di app desktop)
Fai riferimento al flusso delle app desktop OAuth. inclusi tutti i dettagli necessari per l'autorizzazione con le tue credenziali.
Se autorizzi l'accesso come utente Google di terze parti (flusso web)
Fai riferimento al flusso di app web OAuth. Questo mostra un esempio di come configurare l'autorizzazione OAuth per utenti di terze parti arbitrari.
Autorizzi l'accesso come utente del dominio Google Apps (flusso dell'account di servizio)
Fai riferimento al flusso per gli account di servizio OAuth. Questo fornisce un esempio di come configurare l'autorizzazione OAuth per gli utenti del dominio Google Apps.

Se l'accesso all'account cliente Google Ads avviene tramite un account amministratore Google Ads, devi specificare anche un ID cliente di accesso, come descritto di seguito.

ID cliente di accesso (per accedere agli account Google Ads tramite un account amministratore)

(Facoltativo) Specifica l'ID cliente di un account amministratore che concede l'accesso all'account di pubblicazione. Deve essere specificato se l'accesso all'account cliente avviene tramite un account amministratore. Non è necessario specificare tutti gli account amministratore nel percorso dell'ID cliente, ma solo l'ID amministratore di livello più alto utilizzato per le autorizzazioni di accesso. Per ulteriori dettagli, consulta la documentazione correlata.

Configura la libreria client con le tue credenziali

Puoi configurare la libreria client con un file di configurazione, variabili di ambiente o in modo programmatico. In questa guida, utilizzeremo l'approccio basato sui file di configurazione e ci concentreremo sui flussi desktop e web. L'utilizzo di un file di configurazione è in genere un buon approccio se disponi di un solo set di credenziali (ad esempio, se gestisci gli account sotto un unico gestore).

Crea un file ~/ads.properties con i seguenti contenuti:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE

Sostituisci i segnaposto con le credenziali ottenute nel passaggio precedente.

Inoltre, se il token di aggiornamento è per un account amministratore, devi specificare l'ID cliente di questo account come cliente di accesso:

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

Convalida le credenziali

Per assicurarci che tutto sia configurato correttamente, eseguiremo l'esempio GetCampagne.

Innanzitutto, vai alla directory google-ads-examples.

$ cd google-ads-examples

Questo esempio richiede un parametro --customerId in cui il valore corrisponde all'ID cliente del tuo account Google Ads senza trattini.

Per eseguire l'esecuzione con Gradle:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"

Esplora altri esempi

Il pacchetto examples in google-ads-examples contiene diversi esempi utili. La maggior parte degli esempi richiede dei parametri. Puoi passare i parametri come argomenti (opzione consigliata) o modificare i valori INSERT_XXXXX_HERE nel codice sorgente. Per visualizzare un'istruzione di utilizzo ad esempio, passa --help come unico argomento.

Con Gradle:

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

Puoi anche utilizzare l'attività listExamples in Gradle per elencare tutti gli esempi, gli esempi in una sottodirectory o gli esempi in cui la descrizione include un termine di ricerca.

# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'