Iniziare a utilizzare l'API

Questo documento spiega come iniziare a scrivere app che utilizzano l'API Google Bid Manager. L'API ti consente di gestire le query e recuperare i metadati dei report.

L'API Bid Manager v2 è l'ultima versione disponibile e consigliata.

1. Prima di iniziare

Se non hai familiarità con i concetti di Google Display & Video 360, leggi il Centro assistenza Display & Video 360 e sperimenta con l'interfaccia utente.

2. Prepararsi per l'autenticazione

Per iniziare a utilizzare l'API Bid Manager, devi prima utilizzare lo strumento di configurazione, che ti guida nella creazione di un progetto nella console API di Google e nell'attivazione dell'API.

Se non l'hai ancora fatto, crea le credenziali OAuth 2.0 facendo clic su Crea credenziali > ID client OAuth. Dopo aver creato le credenziali, puoi visualizzare l'ID client nella pagina Credenziali. Fai clic sull'ID client per visualizzare i dettagli, ad esempio client secret, URI di reindirizzamento, indirizzo delle origini JavaScript e indirizzo email.

Per ulteriori informazioni, consulta la sezione Autorizzare le richieste.

3. Chiama l'API Bid Manager

Le schede riportate di seguito forniscono guide rapide per la programmazione in varie lingue. Un codice campione simile è disponibile anche nel repository Esempi di API Bid Manager.

Java

  1. Importa le librerie necessarie.

    import static java.nio.charset.StandardCharsets.UTF_8;
    import com.google.api.client.auth.oauth2.Credential;
    import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
    import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
    import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
    import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
    import com.google.api.client.googleapis.util.Utils;
    import com.google.api.services.doubleclickbidmanager.DoubleClickBidManager;
    import com.google.api.services.doubleclickbidmanager.model.ListQueriesResponse;
    import com.google.api.services.doubleclickbidmanager.model.Query;
    import java.io.Reader;
    import java.nio.file.Files;
    import java.nio.file.Paths;
  2. Carica il file client secret e genera le credenziali di autorizzazione.

    La prima volta che esegui questo passaggio, ti viene chiesto di accettare una richiesta di autorizzazione nel browser. Prima di accettare, assicurati di aver eseguito l'accesso con un Account Google che abbia accesso a Display & Video 360. La tua app sarà autorizzata ad accedere ai dati per conto dell'account attualmente connesso.

    // Read client secrets file.
    GoogleClientSecrets clientSecrets;
    try (Reader reader = Files.newBufferedReader(Paths.get(path-to-client-secrets-file), UTF_8)) {
      clientSecrets = GoogleClientSecrets.load(Utils.getDefaultJsonFactory(), reader);
    }
    
    // Generate authorization credentials.
    // Set up the authorization code flow.
    GoogleAuthorizationCodeFlow flow =
        new GoogleAuthorizationCodeFlow.Builder(
            Utils.getDefaultTransport(),
            Utils.getDefaultJsonFactory(),
            clientSecrets,
            oauth-scopes)
        .build();
    
    Credential credential =
        new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
  3. Crea un client API autorizzato.

    // Create authorized API client.
    DoubleClickBidManager service =
        new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("bidmanager-java-installed-app-sample")
            .build();
  4. Esegui un'operazione.

    // Perform an operation.
    // Call the API, getting a list of 10 queries.
    ListQueriesResponse queriesResponse = service.queries().list().setPageSize(10).execute();
    
    // Print them out.
    System.out.println("Id\t\tName");
    if (queriesResponse.getQueries().size() > 0) {
      for (int i = 0; i < queriesResponse.getQueries().size(); i++) {
        Query currentQuery = queriesResponse.getQueries().get(i);
        System.out.printf(
            "%s\t%s%n",
            currentQuery.getQueryId(),
            currentQuery.getMetadata().getTitle());
      }
    } else {
      System.out.println("No queries exist.");
    }

Per informazioni più dettagliate sull'utilizzo dell'API Bid Manager con Java, consulta il file README negli esempi dell'API Bid Manager.

Python

  1. Importa le librerie necessarie.

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
  2. Carica il file client secret e genera le credenziali di autorizzazione.

    La prima volta che esegui questo passaggio, ti viene chiesto di accettare una richiesta di autorizzazione nel browser. Prima di accettare, assicurati di aver eseguito l'accesso con un Account Google che abbia accesso a Display & Video 360. La tua app sarà autorizzata ad accedere ai dati per conto dell'account attualmente connesso.

    # Set up a flow object to create the credentials using the
    # client secrets file and OAuth scopes.
    credentials = InstalledAppFlow.from_client_secrets_file(
        path-to-client-secrets-file, oauth-scopes).run_local_server()
  3. Crea un client API autorizzato.

    # Build the discovery document URL.
    discovery_url = f'https://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2'
    
    # Build the API service.
    service = discovery.build(
        'doubleclickbidmanager',
        'v2',
        discoveryServiceUrl=discovery_url,
        credentials=credentials)
  4. Esegui un'operazione.

    # Build and execute queries.listqueries request.
    response = service.queries().list(pageSize='10').execute()
    
    # Print queries out.
    if 'queries' in response:
      print('Id\t\tName')
      for query in response['queries']:
        print('%s\t%s' % (query['queryId'], query['metadata']['title']))
    else:
      print('No queries exist.')

Per informazioni più dettagliate sull'utilizzo dell'API Bid Manager con Python, consulta il file README negli esempi dell'API Bid Manager.

PHP

Questo esempio presuppone che tu stia eseguendo PHP con un server web incorporato e che tu abbia configurato le tue credenziali per il reindirizzamento alla pagina web pertinente. Ad esempio, questo codice, in un file index.php, può essere eseguito utilizzando il seguente comando e le credenziali configurate per reindirizzare a http://localhost:8000 dopo l'autenticazione:

php -S localhost:8000 -t ./

  1. Scarica e installa il client PHP delle API Google.

    Il metodo preferito è tramite Composer:

    composer require google/apiclient:^2.12.1

    Una volta installato, assicurati di includere il caricatore automatico

    require_once '/path/to/your-project/vendor/autoload.php';

  2. Crea un oggetto Google_Client.

    $client = new Google_Client();
  3. Configura il client, reindirizza all'URL di autenticazione se necessario e recupera un token di accesso.

    La prima volta che esegui questo passaggio, ti viene chiesto di accettare una richiesta di autorizzazione nel browser. Prima di accettare, assicurati di aver eseguito l'accesso con un Account Google che abbia accesso a Display & Video 360. La tua app sarà autorizzata ad accedere ai dati per conto dell'account attualmente connesso.

    // Set up the client.
    $client->setApplicationName('DBM API PHP Samples');
    $client->addScope(oauth-scope);
    $client->setAccessType('offline');
    $client->setAuthConfigFile(path-to-client-secrets-file);
    
    // If the code is passed, authenticate. If not, redirect to authentication page.
    if (isset($_GET['code'])) {
      $client->authenticate($_GET['code']);
    } else {
      $authUrl = $client->createAuthUrl();
      header('Location: ' . $authUrl);
    }
    
    // Exchange authorization code for an access token.
    $accessToken = $client->getAccessToken();
    $client->setAccessToken($accessToken);
  4. Crea un client per il servizio API Display & Video 360.

    $service = new Google_Service_DoubleClickBidManager($client);
  5. Esegui un'operazione.

    // Configure params for the Queries.listqueries request.
    $optParams = array('pageSize' => 10);
    
    // Execute the request.
    $result = $service->queries->listQueries($optParams);
    
    // Print the retrieved queries.
    if (!empty($result->getQueries())) {
      print('<pre><p>Id Name</p>');
      foreach ($result->getQueries() as $query) {
        printf('<p>%s %s</p>', $query->queryId, $query->metadata->title);
      }
      print('</pre>');
    } else {
      print '<p>No queries exist.</p>';
    }

Per informazioni più dettagliate sull'utilizzo dell'API Bid Manager con PHP, consulta il file README negli esempi dell'API Bid Manager.

4. Passaggi successivi

Ora che hai una libreria client funzionante, esplora la documentazione di riferimento e inizia a sviluppare l'implementazione.

Sono disponibili anche altre guide su come utilizzare i report pianificati e come seguire le best practice per i report.