Segundo plano

Antes de comenzar

  1. Pídele a tu representante de cuenta que configure los permisos adecuados para las cuentas a las que accederá tu aplicación.
  2. Si no conoces los conceptos de Authorized Buyers, visita el Centro de ayuda de Authorized Buyers y experimenta con la interfaz de usuario. Si se espera que tu aplicación realice ofertas en tiempo real, lee la documentación sobre el protocolo de RTB.
  3. Visita la Consola de APIs para configurar un proyecto nuevo. Accede a tu Cuenta de Google de desarrollador o crea una. Luego, se te pedirá que crees un proyecto y apruebes algunas Condiciones del Servicio.

Cuentas principales y secundarias

Si trabajas dentro de la estructura de una cuenta que contiene cuentas principales y secundarias, tal vez puedas trabajar con mayor eficacia si entiendes cómo interactúan. A continuación, se incluye un breve resumen:

Cuentas secundarias

Un usuario con credenciales que otorgan acceso a una cuenta secundaria solo puede ver y modificar los recursos asociados con su cuenta. Las cuentas secundarias no pueden ver ni modificar recursos que pertenecen a otras cuentas secundarias o superiores.

Cuentas principales

Un usuario con credenciales que otorgan acceso a una cuenta principal puede ver y modificar los recursos de la cuenta principal, además de todas las cuentas secundarias asociadas. Para las operaciones que enumeran todos los recursos de un determinado recurso, este usuario recibirá una respuesta que incluye los datos de su cuenta y de todas sus cuentas secundarias. Ten en cuenta que, en el caso de otros tipos de solicitudes dirigidas a recursos para licencias secundarias, una cuenta superior deberá especificar un parámetro de ruta de acceso accountId para la cuenta secundaria en lugar de su propio accountId.

El modelo de datos de la API de REST

Un recurso es una entidad de datos individual con un identificador único. El recurso Cuentas representa una entrada de cuenta de Authorized Buyers y es la clase de datos raíz de la API de Ad Exchange Buyer. Los métodos de la API operan en recursos de cuentas individuales y en colecciones de recursos de Cuentas.

Un recurso de cuentas incluye lo siguiente: un ID de cuenta, información que se usa en la coincidencia de cookies, ubicaciones de ofertantes, la URL a la que se envían las solicitudes de oferta y una solicitud para especificar la cantidad máxima de consultas por segundo que envía Ad Exchange.

Además del recurso y la colección de cuentas, la API de comprador de Ad Exchange define las siguientes estructuras de datos:

Ubicación del ofertante

Las ubicaciones del ofertante son estructuras que se muestran con los recursos de cuentas para proporcionar la URL a la que Ad Exchange debe enviar solicitudes de ofertas y la cantidad máxima de consultas por segundo que debe enviar Ad Exchange. Este es un ejemplo de la ubicación de un ofertante, expresada en JSON:

"bidderLocation": [
    {
      "url": "http://bid.url.com/bidder",
      "maximumQps": 1500
    }
  ],

Ítems

Los elementos proporcionan una lista de cuentas. Este es un ejemplo de elementos, expresados en JSON:

{
  "kind": "adexchangebuyer#accountsList",
  "items": [
    accounts Resource
  ]
}

Operaciones admitidas

Puedes invocar tres métodos diferentes en las colecciones y los recursos de la API de Ad Exchange Buyer, como se indica en la siguiente tabla. Todas las operaciones requieren autorización.

Operación Descripción Asignaciones HTTP de REST
list Enumera todas las cuentas a las que puede acceder el usuario autenticado actualmente. GET en un URI de colección.
get Obtiene un recurso de cuentas específico. GET en un URI de recurso.
actualizar Actualiza un recurso de cuentas específico. PUT en un URI de recurso, en el que pasas los datos del recurso actualizado.

Estilo de llamada

REST es un estilo de arquitectura de software que proporciona un enfoque conveniente y coherente para solicitar y modificar datos.

El término REST es el acrónimo en inglés de "Transferencia de estado representacional". En el contexto de las API de Google, se refiere al uso de verbos HTTP para recuperar y modificar representaciones de los datos que almacena Google.

En un sistema RESTful, los recursos se almacenan en un almacén de datos; un cliente envía una solicitud para que el servidor ejecute una acción en particular (como crear, recuperar, actualizar o borrar un recurso) y el servidor ejecuta la acción y envía una respuesta que, por lo general, es una representación del recurso especificado.

En las APIs de RESTful de Google, el cliente especifica una acción con un verbo HTTP como POST, GET, PUT o DELETE. Especifica un recurso mediante un URI único a nivel global con la siguiente forma:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Dado que todos los recursos de API tienen URI únicos accesibles a través de HTTP, REST permite el almacenamiento de datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.

Puedes encontrar las definiciones de métodos en la documentación de estándares del HTTP 1.1, los que incluyen especificaciones para GET, POST, PUT y DELETE.

REST en la API de Ad Exchange Buyer

Las operaciones admitidas se asignan directamente a los verbos HTTP de REST, como se describe en las operaciones de la API.

El formato específico para los URI de API es el siguiente:

https://www.googleapis.com/adexchangebuyer/v1.4/resourceID?parameters

En el ejemplo anterior, resourceID es el identificador de un recurso de cuentas y parameters son todos los parámetros que se aplicarán a la consulta. Consulta los parámetros de consulta estándar y la documentación de referencia para obtener más detalles.

El formato de las extensiones de ruta resourceID te permite identificar el recurso en el que estás trabajando actualmente, por ejemplo:

https://www.googleapis.com/adexchangebuyer/v1.4/accounts
https://www.googleapis.com/adexchangebuyer/v1.4/accounts/id

El conjunto completo de los URI que se usan para cada operación compatible en la API se resume en la documentación de referencia.

A continuación, se muestra un ejemplo de cómo funciona en la API de Ad Exchange Buyer.

Obtén la lista de cuentas del usuario autenticado:

GET https://www.googleapis.com/adexchangebuyer/v1.4/accounts

Formato de los datos

JSON

JSON (JavaScript Object Notation) es un formato de datos común y, también, independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.