Per iniziare

Puoi utilizzare l'API SOAP di Google Ad Manager per creare app che gestiscono l'inventario, creano ordini, generano report e altro ancora.

Per aiutarti a iniziare, offriamo librerie client per Java, .NET, Python, PHP e Ruby.

Per effettuare la tua prima richiesta API:

Ottenere l'accesso a una rete Ad Manager

Se non ne hai già uno, registrati per creare un account Ad Manager. Puoi anche creare una rete di test se vuoi testare l'API in un ambiente separato. Tieni presente che non hai bisogno di un account AdSense per i test.

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 le credenziali di autenticazione

Devi autenticare tutte le richieste dell'API SOAP di Ad Manager utilizzando OAuth 2.0. I passaggi seguenti riguardano il caso d'uso dell'accesso ai tuoi dati Ad Manager. Per maggiori dettagli e altre opzioni, vedi 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, se vuoi, modifica l'ID progetto fornito. Fai clic su Crea.

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

  4. Seleziona Nuovo service account 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 Amministratore > Impostazioni globali.

  3. In Impostazioni generali > Accesso API, fai clic sul cursore per attivare l'opzione Attivato.

  4. Fai clic sul pulsante Salva nella parte inferiore della pagina.

Configurare il client

Scarica una delle librerie client di Ad Manager. Le librerie offrono funzioni e funzionalità wrapper che semplificano e velocizzano lo sviluppo di app.

Le seguenti schede forniscono guide rapide per la codifica in ciascuno dei linguaggi per i quali è disponibile una libreria client.

Java

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

  1. Configurare le 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. Specifica le dipendenze

    Modifica il file pom.xml e aggiungi quanto segue al tag dependencies. Puoi trovare il numero dell'ultima versione 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 un po' di 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.v202608.Network;
import com.google.api.ads.admanager.axis.v202608.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 informazioni sull'utilizzo più dettagliate, consulta il file README nella distribuzione della libreria client.

  1. Installa la libreria e configura le credenziali.

    Esegui questi comandi in una shell:

    python3 -m 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 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='v202608')

# 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 i seguenti 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 ed effettua una richiesta. 
    <?php
require 'vendor/autoload.php';
use Google\AdsApi\AdManager\AdManagerSession;
use Google\AdsApi\AdManager\AdManagerSessionBuilder;
use Google\AdsApi\AdManager\v202608\ApiException;
use Google\AdsApi\AdManager\v202608\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 i riferimenti alle librerie richieste al progetto

    Aggiungi una dipendenza NuGet per Google.Dfp.

  3. Configurare App.config

    Copia src\App.config nella directory del progetto e aggiungilo al progetto. Se la tua applicazione ha un proprio file App.config, puoi copiarvi i seguenti nodi:

    • configuration/AdManagerApi
    • configuration/configSections/section[name="AdManagerApi"]
    • configuration/system.net
  4. Configurare 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. Fare una chiamata alla biblioteca

    Puoi chiamare la libreria come mostrato nello snippet di codice C# seguente 

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

    Compila i campi obbligatori nel file ~/ad_manager_api.yml. Se non hai ancora un file di chiavi OAuth2, devi 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 un po' di 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, :v202608)

# 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 file README distribuito con la libreria client Ruby. Inoltre, consulta la nostra raccolta completa di esempi per Ruby.

Passaggi successivi

Una volta che hai una libreria client funzionante, 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 di assistenza.