Comienza con la API

En este documento, se explica cómo comenzar a escribir apps que usen la API de Google Bid Manager. La API te permite administrar las consultas y recuperar los metadatos de los informes.

La API de Bid Manager v2 es la última versión disponible y recomendada.

1. Antes de comenzar

Si no conoces los conceptos de Google Display & Video 360, consulta el Centro de ayuda de Display & Video 360 y experimenta con la IU.

2. Prepárate para la autenticación

Para comenzar a usar la API de Bid Manager, primero debes utilizar la herramienta de configuración, que te guiará para crear un proyecto en la Consola de API de Google, habilitar la API y crear credenciales.

Si aún no lo hiciste, haz clic en Crear credenciales > ID de cliente de OAuth para crear tus credenciales de OAuth 2.0. Una vez que hayas creado las credenciales, podrás ver tu ID de cliente en la página Credenciales. Haz clic en el ID de cliente para obtener detalles, como el secreto de cliente, los URI de redireccionamiento, la dirección de origen de JavaScript y la dirección de correo electrónico.

Para obtener más información, consulta Autoriza solicitudes.

3. Llamar a la API de Bid Manager

En las siguientes pestañas, se proporcionan guías de inicio rápido para programar en varios lenguajes. También puedes encontrar código de muestra similar en el repositorio de ejemplos de la API de Bid Manager.

Java

  1. Importa las bibliotecas necesarias.

    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. Carga el archivo de secretos del cliente y genera credenciales de autorización.

    La primera vez que realices este paso, se te solicitará que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Display & Video 360. Tu app estará autorizada para acceder a los datos en nombre de la cuenta a la que hayas accedido.

    // 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 cliente de API autorizado.

    // Create authorized API client.
    DoubleClickBidManager service =
        new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("bidmanager-java-installed-app-sample")
            .build();
    
  4. Realiza una operación.

    // 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.");
    }
    

Para obtener información más detallada sobre cómo usar la API de Bid Manager con Java, consulta el archivo README en los ejemplos de la API de Bid Manager.

Python

  1. Importa las bibliotecas necesarias.

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. Carga el archivo de secretos del cliente y genera credenciales de autorización.

    La primera vez que realices este paso, se te solicitará que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Display & Video 360. Tu app estará autorizada para acceder a los datos en nombre de la cuenta a la que hayas accedido.

    # 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 cliente de API autorizado.

    # 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. Realiza una operación.

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

Para obtener información más detallada sobre el uso de la API de Bid Manager con Python, consulta el archivo README en los ejemplos de la API de Bid Manager.

PHP

En esta muestra, se supone que ejecutas PHP con un servidor web integrado y que configuraste tus credenciales para redireccionar a los usuarios a la página web relevante. Por ejemplo, este código, en un archivo index.php, se puede ejecutar mediante el siguiente comando y las credenciales configuradas para redireccionar a http://localhost:8000 después de la autenticación:

php -S localhost:8000 -t ./

  1. Descarga y, luego, instala el cliente PHP de la API de Google.

    El método preferido es Composer:

    composer require google/apiclient:^2.12.1
    

    Una vez instalado, asegúrate de incluir el cargador automático

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

  2. Crea un objeto Google_Client.

    $client = new Google_Client();
    
  3. Configura el cliente, redirecciona a la URL de autenticación si es necesario y recupera un token de acceso.

    La primera vez que realices este paso, se te solicitará que aceptes una solicitud de autorización en tu navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Display & Video 360. Tu app estará autorizada para acceder a los datos en nombre de la cuenta a la que hayas accedido.

    // 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. Crear un cliente para el servicio de la API de Display & Video 360

    $service = new Google_Service_DoubleClickBidManager($client);
    
  5. Realiza una operación.

    // 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>';
    }
    

Para obtener información más detallada sobre el uso de la API de Bid Manager con PHP, consulta el archivo README en los ejemplos de la API de Bid Manager.

4. Próximos pasos

Ahora que tienes una biblioteca cliente en funcionamiento, explora la documentación de referencia y comienza a compilar tu implementación.

También hay guías adicionales disponibles para usar informes programados y seguir las prácticas recomendadas para la generación de informes.