Puoi usare l'API Google Ad Manager per creare app che gestiscono l'inventario, creare ordini, estrarre report e altro ancora.
L'API Ad Manager utilizza SOAP. Per aiutarti a iniziare, offriamo ai clienti librerie per Java, .NET, Python, PHP e Ruby.
Per effettuare la prima richiesta API:
Accedere a una rete Ad Manager
Se non ne hai già uno, registrati a Ad Manager Google Cloud. Puoi anche creare un rete di test se vuoi testare l'API in una un ambiente separato. Tieni presente che non è necessario un account AdSense per il test scopi.
Prendi nota del tuo codice di rete. Puoi trovarlo nell'URL quando accedi
alla tua rete. Ad esempio, nell'URL
https://admanager.google.com/1234#home
, 1234
è il tuo codice di rete.
Crea credenziali di autenticazione
Devi autenticare tutte le richieste API di Ad Manager utilizzando OAuth 2.0. I passaggi di seguito illustrano il caso d'uso per accedere ai tuoi dati di Ad Manager. Per maggiori dettagli e altre opzioni, consulta la sezione Autenticazione.
Dal menu Progetto, scegli Crea progetto, inserisci un nome per il progetto e, facoltativamente, modificare l'ID progetto fornito. Fai clic su Crea.
Nella pagina Credenziali, seleziona Crea credenziali, quindi seleziona Chiave account di servizio:
Seleziona Nuovo servizio account. e seleziona
JSON
come tipo di chiave.Fai clic su Crea per scaricare un file contenente una chiave privata.
Configurare la rete Ad Manager
Accedi a Google Ads. Gestore.
Nella barra laterale, fai clic su Amministrazione > Impostazioni globali.
In Impostazioni generali > Accesso alle API fai clic sul cursore su Abilitato.
Fai clic sul pulsante Salva nella parte inferiore della pagina.
Configura il cliente
Scarica una delle librerie client di Ad Manager. La le librerie offrono funzioni e caratteristiche wrapper che semplificano e velocizzano sviluppare app.
Le schede riportate di seguito forniscono guide rapide per la programmazione in ciascuno dei linguaggi per cui c'è una libreria client.
Java
Ecco un esempio di base che mostra come utilizzare il client Java libreria di Google. Per informazioni più dettagliate sull'utilizzo, consulta il file README nella distribuzione della libreria client.
- Configura le credenziali
Esegui questo comando in una shell:
Apri il filecurl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties
~/ads.properties
e compila i seguenti campi:[...] api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE api.admanager.networkCode=INSERT_NETWORK_CODE_HERE [...]
-
Specifica le dipendenze
Modifica il file
pom.xml
e aggiungi quanto segue al Tagdependencies
. Puoi trovare il numero della versione più recente su GitHub.<dependency> <groupId>com.google.api-ads</groupId> <artifactId>ads-lib</artifactId> <version>RELEASE</version> </dependency> <dependency> <groupId>com.google.api-ads</groupId> <artifactId>dfp-axis</artifactId> <version>RELEASE</version> </dependency>
-
Scrivi del codice ed effettua una richiesta.
import com.google.api.ads.common.lib.auth.OfflineCredentials; import com.google.api.ads.common.lib.auth.OfflineCredentials.Api; import com.google.api.ads.admanager.axis.factory.AdManagerServices; import com.google.api.ads.admanager.axis.v202408.Network; import com.google.api.ads.admanager.axis.v202408.NetworkServiceInterface; import com.google.api.ads.admanager.lib.client.AdManagerSession; import com.google.api.client.auth.oauth2.Credential; public class App { public static void main(String[] args) throws Exception { Credential oAuth2Credential = new OfflineCredentials.Builder() .forApi(Api.AD_MANAGER) .fromFile() .build() .generateCredential(); // Construct an AdManagerSession. AdManagerSession session = new AdManagerSession.Builder() .fromFile() .withOAuth2Credential(oAuth2Credential) .build(); // Construct a Google Ad Manager service factory, which can only be used once per // thread, but should be reused as much as possible. AdManagerServices adManagerServices = new AdManagerServices(); // Retrieve the appropriate service NetworkServiceInterface networkService = adManagerServices.get(session, NetworkServiceInterface.class); // Make a request Network network = networkService.getCurrentNetwork(); System.out.printf("Current network has network code '%s' and display" + " name '%s'.%n", network.getNetworkCode(), network.getDisplayName()); } }
Python
Ecco un esempio di base che mostra come utilizzare la libreria client Python. La libreria client Python supporta Python v3.6+. Per un utilizzo più dettagliato consulta la sezione README nella distribuzione della libreria client.
- Installa la libreria e configura le tue credenziali.
Esegui questi comandi in una shell:
pip install googleads
curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \ -o ~/googleads.yaml
- Configura il tuo file
~/googleads.yaml
.Completa i seguenti campi:
ad_manager: application_name: INSERT_APPLICATION_NAME_HERE network_code: INSERT_NETWORK_CODE_HERE path_to_private_key_file: INSERT_PATH_TO_FILE_HERE
-
Esegui del codice ed effettua una richiesta.
# Import the library. from googleads import ad_manager # Initialize a client object, by default uses the credentials in ~/googleads.yaml. client = ad_manager.AdManagerClient.LoadFromStorage() # Initialize a service. network_service = client.GetService('NetworkService', version='v202408') # Make a request. current_network = network_service.getCurrentNetwork() print("Current network has network code '%s' and display name '%s'." % (current_network['networkCode'], current_network['displayName']))
PHP
Ecco un esempio base che mostra come utilizzare il parametro Libreria client PHP.
-
Installa la libreria e configura le tue credenziali.
Esegui questi comandi in una shell per installare la libreria client e scaricare adsapi_php.ini nella tua home directory:
composer require googleads/googleads-php-lib
curl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
-
Configura il file
~/adsapi_php.ini
.Completa i seguenti campi:
[AD_MANAGER] networkCode = "INSERT_NETWORK_CODE_HERE" applicationName = "INSERT_APPLICATION_NAME_HERE" [OAUTH2] jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE" scopes = "https://www.googleapis.com/auth/dfp"
-
Esegui qualche codice ed effettua una richiesta.
<?php require 'vendor/autoload.php'; use Google\AdsApi\AdManager\AdManagerSession; use Google\AdsApi\AdManager\AdManagerSessionBuilder; use Google\AdsApi\AdManager\v202408\ApiException; use Google\AdsApi\AdManager\v202408\ServiceFactory; use Google\AdsApi\Common\OAuth2TokenBuilder; // Generate a refreshable OAuth2 credential for authentication. $oAuth2Credential = (new OAuth2TokenBuilder()) ->fromFile() ->build(); // Construct an API session configured from a properties file and the OAuth2 // credentials above. $session = (new AdManagerSessionBuilder()) ->fromFile() ->withOAuth2Credential($oAuth2Credential) ->build(); // Get a service. $serviceFactory = new ServiceFactory(); $networkService = $serviceFactory->createNetworkService($session); // Make a request $network = $networkService->getCurrentNetwork(); printf( "Network with code %d and display name '%s' was found.\n", $network->getNetworkCode(), $network->getDisplayName() );
.NET
Ecco un esempio di base che mostra come utilizzare il client.NET libreria
- Creare un nuovo progetto
Apri Visual Studio e crea un nuovo progetto (applicazione console).
- Aggiungere al progetto i riferimenti alla libreria richiesti
Aggiungi una dipendenza nuget per Google.Dfp.
- Configurare App.config
Copia src\App.config nella directory del progetto e aggiungilo al progetto. Se la tua applicazione ha un proprio App.config, puoi copiare i seguenti nodi in App.config:
- configuration/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- configuration/system.net
- Credenziali di configurazione
Apri App.config e modifica le seguenti chiavi:
<add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" /> <add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" /> <add key="OAuth2Mode" value="SERVICE_ACCOUNT" /> <add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />
- Chiamare la biblioteca
Puoi chiamare la libreria come mostrato nel seguente snippet di codice C#
AdManagerUser user = new AdManagerUser(); using (InventoryService inventoryService = user.GetService<InventoryService>()) { // Create a statement to select ad units. int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT; StatementBuilder statementBuilder = new StatementBuilder().OrderBy("id ASC").Limit(pageSize); // Retrieve a small amount of ad units at a time, paging through until all // ad units have been retrieved. int totalResultSetSize = 0; do { AdUnitPage page = inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement()); // Print out some information for each ad unit. if (page.results != null) { totalResultSetSize = page.totalResultSetSize; int i = page.startIndex; foreach (AdUnit adUnit in page.results) { Console.WriteLine( "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++, adUnit.id, adUnit.name); } } statementBuilder.IncreaseOffsetBy(pageSize); } while (statementBuilder.GetOffset() < totalResultSetSize); Console.WriteLine("Number of results found: {0}", totalResultSetSize); }
Se non vuoi impostare le credenziali in App.config, consulta a questo articolo wiki per scoprire modi alternativi di usare la classe AdManagerUser. Per informazioni più dettagliate sull'uso della libreria client .NET, consulta nel file README . Se vuoi sviluppare in .NET senza la libreria client, fai riferimento alla NoClientLibrary articolo wiki.
Ruby
Ecco un esempio base che mostra come utilizzare il comando Ruby libreria client. La libreria client Ruby richiede Ruby 2.1 o versione successiva.
-
Installa la gem Ruby e recupera il file di configurazione.
Esegui questi comandi in una shell:
gem install google-dfp-api
curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
-
Configura le credenziali
Compila i campi obbligatori nel
~/ad_manager_api.yml
. Se non disponi già di un file di chiave OAuth2, devi seguire le passaggi per creare il tuo OAuth2 credenziali.:authentication: :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE :application_name: INSERT_APPLICATION_NAME_HERE :network_code: INSERT_NETWORK_CODE_HERE
-
Scrivi del codice ed effettua una richiesta.
# Import the library. require 'ad_manager_api' # Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default). ad_manager = AdManagerApi::Api.new # Get a service instance. network_service = ad_manager.service(:NetworkService, :v202408) # Make a request. network = network_service.get_current_network() puts "The current network is %s (%d)." % [network[:display_name], network[:network_code]]
I passaggi più dettagliati per iniziare sono disponibili nel README distribuito con la libreria client Ruby. Consulta anche la nostra libreria di esempio per Ruby.
Passaggi successivi
Quando una libreria client è attiva e in esecuzione, modifica gli esempi forniti in estendili in base alle tue esigenze.
Per saperne di più, consulta la documentazione di riferimento sull'API.
Se hai bisogno di aiuto, visita la nostra pagina di assistenza.