Comienza con la API

En este documento, se explica cómo comenzar a escribir aplicaciones que utilicen la API de Google Bid Manager. La API te permite administrar Consultas y recupera Metadatos de informes.

La API de Bid Manager v2 es la versión más reciente disponible y recomendada versión.

1. Antes de comenzar

Si no conoces bien las campañas de Display y conceptos de Video 360, lee el Pantalla y Centro de ayuda de 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 usar la herramienta de configuración, que te guiará en el proceso de creación de un proyecto en la Consola de APIs de Google, la habilitación de la API y la creación de credenciales.

Si aún no lo has hecho, crea tus credenciales de OAuth 2.0 haciendo clic en Crear credenciales > ID de cliente de OAuth. Después de crear 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 del cliente, los URI de redireccionamiento, JavaScript la dirección de origen y la dirección de correo electrónico.

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

3. Llama a la API de Bid Manager

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

JavaPythonPHP

  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 pedirá que aceptes un mensaje de autorización en tu navegador. Antes de aceptar, asegúrate de acceder con una Cuenta de Google con acceso a Display & Video en 360° Tu app estará autorizada para acceder a los datos en nombre de la cuenta a la que se haya 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 la README en la Ejemplos de la API de Bid Manager.

  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 pedirá que aceptes un mensaje de autorización en tu navegador. Antes de aceptar, asegúrate de acceder con una Cuenta de Google con acceso a Display & Video en 360° Tu app estará autorizada para acceder a los datos en nombre de la cuenta a la que se haya 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 cómo usar la API de Bid Manager con Python, consulta la README en la Ejemplos de la API de Bid Manager.

En este ejemplo, se supone que ejecutas PHP con un servidor web integrado y Debe configurar sus credenciales para redireccionar a la página web correspondiente. Para Por ejemplo, este código, en un archivo index.php, se puede ejecutar con el siguiente comando: comando y credenciales configurados para redireccionar a http://localhost:8000 después autenticación:

php -S localhost:8000 -t ./

  1. Descarga e instala el cliente de PHP de la API de Google.

    El método preferido es a través de 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. Configurar el cliente, redireccionar a la URL de autenticación si es necesario y recuperar un token de acceso

    La primera vez que realices este paso, se te pedirá que aceptes una autorización en el navegador. Antes de aceptar, asegúrate de haber accedido con una Cuenta de Google que tenga acceso a Display & Video 360. Se autorizará tu app para acceder a los datos en nombre de cualquier cuenta con la que se haya 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. Crea 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 cómo usar la API de Bid Manager con PHP, consulta la README en la 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 sobre cómo usar los informes programados y seguir las prácticas recomendadas para la generación de informes.