Guía práctica

En esta página, se proporciona información para realizar tareas comunes con la API.

Crea usuarios

UserService permite que un usuario con derechos de administrador cree un usuario directamente en su red. Cualquier desarrollador puede hacerlo sin que el usuario nuevo se registre primero. Por ejemplo, si pruebas la API por primera vez, en lugar de realizar todas las llamadas a la API como administrador (la opción predeterminada para tu dirección de correo electrónico), es posible que desees crear algunos usuarios con funciones como vendedor, coordinador de publicidad o anunciante para probar flujos de trabajo reales.

  1. Crea algunas direcciones de Gmail nuevas, como my.name.dfp.salesperson@gmail.com. De manera alternativa, registra una dirección existente que no sea de Gmail como una cuenta de Google nueva.
  2. Llama a createUsers con esa dirección nueva y el Role que elegiste.
  3. Puedes autenticarte como ese usuario nuevo usando OAuth 2.0 para generar tu token de acceso.

Cómo obtener la unidad de anuncios raíz

Las AdUnit superiores a las que puedes agregar nodos secundarios y la profundidad permitida de tu jerarquía dependen de tu tipo de cuenta (Pequeña empresa o Premium). La AdUnit superior que admite la modificación de sus nodos secundarios se denomina AdUnit raíz eficaz.

Para recuperar la raíz efectiva, llama a NetworkService.getCurrentNetwork() y examina el campo effectiveRootAdUnitId en el objeto Network que se muestra.

Nota: Los diferentes tipos de cuenta admiten distintos patrones de jerarquía.

Cómo consultar un objeto

Debes buscar objetos según los criterios de búsqueda con el método getObjectsByStatement() expuesto por muchos servicios, en el que Objeto es un tipo de objeto específico. Este método toma una consulta de PQL, que es similar a una consulta de SQL, ya que te permite especificar campos para buscar (donde los nombres de los campos se asignan a las propiedades del objeto), ordenar, limitar y desplazar los resultados de la búsqueda. Consulta la guía de PQL para obtener más información sobre PQL y también para conocer los campos de objetos según los que puedes filtrar.

Cómo crear un pedido

Para crear un pedido, simplemente crea un objeto Order y configura los ID de anunciante, vendedor y coordinador de anuncios para los usuarios correspondientes, asigna un nombre único y llama a createOrders(). El resultado incluirá el Order recién creado o un error.

Ejemplo

Consulta un ejemplo de código Java para crear un pedido.

Cómo crear una línea de pedido

Para crear una línea de pedido nueva, sigue estos pasos:

  1. Crea un objeto Order nuevo o usa uno existente.
  2. Crea un nuevo objeto LineItem y configura el tipo de rotación, el array de tamaños de creatividad, las fechas de inicio y finalización, y otras propiedades.
  3. Crea un nuevo objeto InventoryTargeting y especifica a qué objetos Placement o AdUnit deseas segmentar o excluir.
  4. Une tu objeto InventoryTargeting dentro de un nuevo objeto Targeting y asígnalo a la propiedad de segmentación de LineItem.
  5. Llama al método de servicio de línea de pedido createLineItems() con tu nuevo objeto y examina el resultado para ver si se creó.

Ejemplo

Consulte un ejemplo de código Java para crear una línea de pedido.

Cómo crear una creatividad

Los diferentes tipos de creatividades admiten diferentes componentes: por ejemplo, una creatividad de imagen admite un solo archivo de origen para la imagen; una creatividad Flash admite dos archivos de elementos subyacentes: un archivo Flash y un archivo de imagen de copia de seguridad en caso de que no se pueda publicar el archivo Flash. En el caso de las creatividades alojadas en sitios de terceros, solo subirá un fragmento HTML que haga referencia al archivo que se encuentra en el servidor de terceros. Consulta tu subclase Creative específica a fin de saber qué elementos deberás subir para crear la creatividad.

Ejemplo

Consulte un ejemplo de código Java para crear una creatividad de imagen.

Cómo modificar un objeto existente

Para modificar un objeto existente, llama a getObjectsByStatement() para consultarlo, actualiza los valores en los objetos que se muestran y, luego, llama a updateObjects().

Nota: Los objetos actualizados reemplazarán por completo los objetos existentes, por lo que si dejas de establecer un valor de propiedad en el objeto que envías, el objeto guardado obtendrá el valor predeterminado para esa propiedad, no el valor anterior.

Cómo cambiar el estado de un objeto

Para cambiar el estado del objeto, se llama al método performObjectAction() que expone tu servicio. Este método tiene dos parámetros:

  • Una instancia del objeto de acción que describe lo que quieres hacer. Por ejemplo, el servicio de pedidos expone varias acciones, incluidas ApproveOrders, PauseOrders y ArchiveOrders. Todos los objetos de acción derivan de una clase de acción base adecuada para tu servicio.
  • Una consulta de PQL que describe qué objetos se deben cambiar. Puedes cambiar el estado de uno o más objetos a la vez si especificas una declaración de PQL adecuada.

Cómo generar etiquetas de anuncios

No puedes generar etiquetas de anuncios con la API. En su lugar, debes usar el sitio web de Google Ad Manager. Consulta la sección del Centro de ayuda sobre el etiquetado para obtener más información.

Más ejemplos

Puedes encontrar muchos más ejemplos en el código de muestra de nuestra biblioteca cliente, en varios lenguajes de programación diferentes. Consulta la página Bibliotecas cliente y código de ejemplo para obtener un vínculo a ejemplos en tu lenguaje de programación.