Flujos de trabajo de API

En esta guía, se describen los flujos de trabajo comunes de la API para crear, cancelar, recuperar, actualizar y negociar acuerdos con la API de Deal Sync.

Cómo crear un acuerdo

  1. Para verificar si ya se creó un producto, llama a LIST products con el externalDealId filtro. Ten en cuenta que se admiten tanto externalDealId en camelCase como external_deal_id en snake_case en la cadena de filtro. external_deal_id debe ser único en todos los productos.

    GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products?filter=externalDealId="{external_deal_id}"

  2. Crear Pedido. DV360 genera el nombre del pedido, y te recomendamos que almacenes este ID en tu sistema para recuperarlo en el futuro.

  3. Crear producto en pedido. DV360 genera el nombre del producto, y te recomendamos que almacenes este ID en tu sistema para recuperarlo en el futuro.

Como alternativa, puedes llamar a LIST con external_deal_id. El nombre del recurso contiene el ID del pedido y el ID del producto, por lo que puedes identificar el pedido superior.

Cómo cancelar un acuerdo

  1. Actualiza el estado del pedido a CANCELED. La cancelación solo se admite si aún no se aceptó el pedido. Canceled es un estado terminal; un pedido no se puede reactivar una vez que se cancela. Si el pedido contenía algún producto, no se puede volver a usar su external_deal_id.

Cómo obtener detalles de un acuerdo

  1. Obtén detalles de un pedido. El estado se actualiza una vez que el usuario acepta, archiva o cancela el pedido.
  2. Obtén detalles de un producto.

Cómo obtener una lista de acuerdos

  1. Haz una lista de los pedidos con un filtro de estado para obtener todos los pedidos aceptados o pendientes de aceptación de los pedidos.
  2. Haz una lista de los productos con el filtro external_deal_id.
  3. HAZ UNA LISTA de todos los productos dentro de un pedido.

Cómo actualizar un acuerdo

  1. Actualiza el pedido para obtener la información de contacto del publicador.
    1. name no se puede actualizar (no se puede configurar en updateMask). El estado solo se puede establecer en CANCELED con la API.
    2. partner_id no se puede actualizar.
  2. Actualiza el producto para obtener una actualización específica de los términos del acuerdo.
    1. name, externalDealId, transactionType, pricingType, y updateTime no se pueden actualizar.
    2. La actualización de displayName no requiere que el usuario vuelva a aceptar.
    3. La actualización de rateDetails o creativeConfig cambia el estado del pedido superior a PENDING_ACCEPTANCE. Se les pedirá a los anunciantes de DV360 que acepten las nuevas condiciones en la página Negociaciones, independientemente de si ya se aceptó el pedido anterior.

Cómo verificar si el usuario aceptó el acuerdo

  1. Obtén el pedido si conoces el nombre del pedido correspondiente. Verifica el campo status.
  2. Si no se hizo un seguimiento del nombre del pedido, haz una lista de los productos con el filtro external_deal_id, identifica el nombre del pedido a partir del nombre del producto, y, luego, llama a Get Order. Verifica el campo status.

Cómo verificar si el usuario configuró el acuerdo (solo para Programática garantizada)

  1. Obtén la fuente de inventario. El nombre del recurso es exchanges/{exchangeId}/inventorysources/{external_deal_id}. Verifica el estado del comprador Status.
    1. Acuerdos de reservación:
      1. BUYER_STATUS_ACTIVE: Se aceptó y configuró el acuerdo. El acuerdo comenzará a generar inversión cuando DV360 reciba solicitudes de oferta que coincidan con las condiciones del acuerdo. Se genera automáticamente una línea de pedido durante la configuración del acuerdo. Consulta Configuración del acuerdo para obtener más detalles.
      2. BUYER_STATUS_PENDING: Se aceptó el pedido, pero aún no se configuró el acuerdo. No se genera inversión en este estado.
      3. BUYER_STATUS_PAUSED: El anunciante pausó el acuerdo. No se genera inversión en este estado.
    2. Acuerdos que no son de reservación:
      1. BUYER_STATUS_ACTIVE: Se aceptó el acuerdo. El acuerdo comenzará a generar inversión cuando DV360 reciba solicitudes de oferta coincidentes, una línea de pedido activa segmenta el acuerdo y las solicitudes de oferta coincidan con los criterios de segmentación de la línea de pedido. Consulta Líneas de pedido para obtener más detalles. (Nota: No hay una API de vendedor para consultar si las líneas de pedido segmentan un acuerdo).
      2. BUYER_STATUS_PENDING: No se aplica a los acuerdos que no son de reservación.
      3. BUYER_STATUS_PAUSED: El anunciante pausó explícitamente el acuerdo. No se genera inversión en este estado.

Cómo pausar y reanudar un acuerdo después de la aceptación

  1. Actualiza el estado del vendedor de la fuente de inventario.
    1. Pausar o reanudar no detiene la publicación del acuerdo. Si un vendedor pausa un acuerdo, se muestra un mensaje informativo a los anunciantes en la IU de DV360 para ayudar a solucionar problemas con los acuerdos que no generan inversión.

Renegociación (actualización de un acuerdo después de la aceptación)

La renegociación se refiere a las actualizaciones que se realizan en un acuerdo después de que el comprador lo acepta. Esto permite que los exchanges y los compradores ajusten las condiciones de los acuerdos existentes. Por ejemplo, un exchange puede descubrir que la hora de finalización de la publicación de un acuerdo aceptado es incorrecta. El exchange puede usar Product Patch para enviar actualizaciones a los compradores de DV360 antes de que comience a publicarse el acuerdo.

Cambios permitidos y no permitidos

Consulta los artículos del Centro de ayuda de Display &Video 360 para obtener un desglose completo de las negociaciones y las reglas de renegociación de acuerdos:

Anterior
Estructura de entidades
Siguiente
Proceso beta