Inizia

Puoi usare l'API Google Ad Manager per creare app per gestire l'inventario, creare ordini, generare report e altro ancora.

L'API Ad Manager utilizza SOAP. Per aiutarti a iniziare, offriamo librerie client per Java, .NET, Python, PHP e Ruby.

Per effettuare la tua prima richiesta API, segui questi passaggi:

Accedere a una rete Ad Manager

Se non ne hai ancora uno, crea un account Ad Manager. Puoi anche creare una rete di test se vuoi testare l'API in un ambiente separato. Tieni presente che non è necessario un account AdSense per scopi di test.

Prendi nota del codice di rete. Puoi trovarlo nell'URL quando accedi alla 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 riportati di seguito riguardano il caso d'uso dell'accesso ai tuoi dati di Ad Manager. Per ulteriori dettagli e altre opzioni, consulta Autenticazione.

  1. Apri la pagina Credenziali della console API di Google

  2. Dal menu del progetto, scegli Crea progetto, inserisci un nome per il progetto e, facoltativamente, modifica l'ID progetto fornito. Fai clic su Crea.

  3. Nella pagina Credenziali, seleziona Crea credenziali, quindi seleziona Chiave account di servizio.

  4. Seleziona Nuovo account di servizio e seleziona JSON come tipo di chiave.

  5. Fai clic su Crea per scaricare un file contenente una chiave privata.

Configurare la rete Ad Manager

  1. Accedi a Google Ad Manager.

  2. Nella barra laterale, fai clic su Amministrazione > Impostazioni globali.

  3. In Impostazioni generali > Accesso API, fai clic sul dispositivo di scorrimento fino a Abilitato.

  4. Fai clic sul pulsante Salva in fondo alla pagina.

Configura il client

Scarica una delle librerie client di Ad Manager. Le librerie offrono funzioni e funzionalità wrapper che rendono più semplice e veloce lo sviluppo delle app.

Le schede seguenti forniscono guide rapide per la programmazione in ciascuno dei linguaggi per cui è disponibile una libreria client.

Java

Ecco un esempio di base che mostra come utilizzare la libreria client di Java. Per informazioni più dettagliate sull'utilizzo, consulta il file README nella distribuzione delle librerie client.

  1. Configura le tue credenziali

    Esegui questo comando in una shell:

    curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties
    Apri il file ~/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
    [...]
  2. Specificare le dipendenze

    Modifica il file pom.xml e aggiungi quanto segue al tag dependencies. 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>

  3. Scrivi del codice e fai 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.v202402.Network;
    import com.google.api.ads.admanager.axis.v202402.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 base che mostra come utilizzare la libreria client Python. La libreria client Python supporta Python 3.6 e versioni successive. Per informazioni più dettagliate sull'utilizzo, consulta il file README nella distribuzione della libreria client.

  1. 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
    
  2. Configura il file ~/googleads.yaml.

    Compila 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
    
  3. Esegui del codice e fai 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='v202402')
    
    # 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 di base che mostra come utilizzare la libreria client PHP.

  1. Installa la libreria e configura le tue credenziali.

    Esegui questi comandi in una shell per installare la libreria client e scaricare il file 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
  2. Configura il file ~/adsapi_php.ini.

    Compila 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"
    
  3. Esegui del codice e fai una richiesta.
    <?php
    require 'vendor/autoload.php';
    use Google\AdsApi\AdManager\AdManagerSession;
    use Google\AdsApi\AdManager\AdManagerSessionBuilder;
    use Google\AdsApi\AdManager\v202402\ApiException;
    use Google\AdsApi\AdManager\v202402\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 la libreria client.NET

  1. Creare un nuovo progetto

    Apri Visual Studio e crea un nuovo progetto (applicazione console).

  2. Aggiungere al progetto i riferimenti alle librerie richiesti

    Aggiungi una dipendenza completa per Google.Dfp.

  3. Configura il file App.config

    Copia src\App.config nella directory del progetto e aggiungilo al progetto. Se l'applicazione ha il proprio App.config, puoi copiare i seguenti nodi in App.config:

    • configurazione/APIAdManager
    • configuration/configSections/section[name="AdManagerApi"]
    • configurazione/system.net
  4. Configura le credenziali

    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" />
    

  5. Chiamare la raccolta

    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 questo articolo wiki per altri modi di utilizzare la classe AdManagerUser. Per informazioni più dettagliate sull'utilizzo della libreria client .NET, consulta il README . Se vuoi sviluppare in .NET senza la libreria client, consulta l'articolo wiki NoClientLibrary.

Ruby

Ecco un esempio di base che mostra come utilizzare la libreria client Ruby. La libreria client Ruby richiede Ruby 2.1 o versioni successive.

  1. Installa la gemma Ruby e ottieni 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
    
  2. Configura le tue credenziali

    Compila i campi obbligatori nel file ~/ad_manager_api.yml. Se non disponi già di un file delle chiavi OAuth2, dovrai seguire i passaggi per creare le credenziali OAuth2.

    :authentication:
      :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
      :application_name: INSERT_APPLICATION_NAME_HERE
      :network_code: INSERT_NETWORK_CODE_HERE
    
  3. Scrivi del codice e fai 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, :v202402)
    
    # Make a request.
    network = network_service.get_current_network()
    
    puts "The current network is %s (%d)." %
            [network[:display_name], network[:network_code]]
    

Puoi trovare una procedura più dettagliata per iniziare nel file README distribuito con la libreria client Ruby. Consulta anche la nostra libreria di esempio completa per Ruby.

Passaggi successivi

Quando hai una libreria client attiva e in esecuzione, modifica gli esempi forniti per estenderli in base alle tue esigenze.

Sfoglia la documentazione di riferimento per scoprire di più sull'API.

Se hai bisogno di aiuto, visita la nostra pagina dell'assistenza.