Guida introduttiva

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 pubblicato su Maven Central un repository attendibile.

La dipendenza Maven è:

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

La dipendenza di Gradle è:

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

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

Ottenere le credenziali per l'autenticazione con l'API

Per accedere all'API Google Ads sono necessarie le credenziali OAuth e uno sviluppatore dell'API Google Ads di accesso. In questa sezione viene spiegato cosa sono, come vengono utilizzati e come vengono ottenuto.

Token sviluppatore (per l'accesso all'API)

Il token sviluppatore sia collegato a un gestore. disponibile nell'interfaccia web di Google Ads.

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

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

Per concedere l'autorizzazione a utenti dell'Account Google con accesso agli account Google Ads, devi: devi fornire un set di credenziali OAuth.

Esistono due flussi OAuth generalmente utilizzati: app desktop (installata) o un'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 server di autorizzazione di Google, mentre le app web possono reindirizzare una browser di terze parti per completare l'autorizzazione e inviare le credenziali sul tuo server. La libreria supporta anche l'account di servizio meno comunemente utilizzato flusso di lavoro.

Se autorizzi utilizzando le tue credenziali (flusso di app desktop)
Fai riferimento all'app desktop OAuth il flusso di lavoro. Sono inclusi tutti i dettagli che necessaria 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 fornisce un esempio di come configurare l'autorizzazione OAuth per una terza parte arbitraria utenti.
Autorizzi l'accesso come utente del dominio Google Apps (flusso dell'account di servizio)
Fai riferimento all'account di servizio OAuth il flusso di lavoro. Questo fornisce un esempio di come Configurare l'autorizzazione OAuth per gli utenti del dominio Google Apps.

Se hai accesso all'account cliente Google Ads tramite un 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 consente di accedere a l'account di pubblicazione. Deve essere specificato se il tuo accesso al cliente un account è tramite un account amministratore. Non è necessario specificare tutti i gestori nel percorso verso l'ID cliente, solo l'ID amministratore di livello più alto che usano per le autorizzazioni di accesso. Per ulteriori dettagli, consulta i relativi documentazione.

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. Per questa guida, utilizzeremo di configurazione dei file di configurazione e di concentrarsi sui flussi desktop e web. L'utilizzo di un di configurazione del deployment è in genere un buon approccio se si dispone di un solo insieme di Credenziali (ad esempio, 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, specifica 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 impostato correttamente, eseguiremo il comando Get campaigns esempio.

Innanzitutto, vai alla directory google-ads-examples.

$ cd google-ads-examples

Questo esempio richiede un parametro --customerId in cui il valore è il tuo ID cliente dell'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 parametri. Puoi passare i parametri come argomenti (opzione consigliata) oppure modifica i valori INSERT_XXXXX_HERE nel codice sorgente. Per visualizzare una dichiarazione di utilizzo per un 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, esempi in una sottodirectory o esempi in cui la descrizione include una ricerca termine.

# 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'