Flujos de trabajo de API

Cómo crear un acuerdo

1. Consulta si ya se creó un producto con el filtro external_deal_id de los productos de LIST. El valor de 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. Create Order. El nombre lo genera DV3, y te recomendamos que almacenes este ID en algún lugar de tu sistema para recuperarlo en el futuro.

3. Crea un producto en el pedido. DV3 genera el nombre del producto, y te recomendamos que almacenes este ID en algún lugar de tu sistema para recuperarlo en el futuro.

   Como alternativa, siempre puedes usar LIST con external_deal_id. El campo name contiene el ID del pedido y el ID del producto, por lo que puedes identificar fácilmente el elemento principal de esta manera.

Cómo cancelar una oferta

1. Actualiza el estado del pedido a Cancelado Solo admite la cancelación si no se aceptó el pedido. Cancelado es un estado final. No se puede reactivar el pedido una vez que se cancela.

Obtén detalles de un acuerdo

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

Obtén una lista de ofertas

1. LIST pedidos con un filtro de estado para obtener todos los pedidos aceptados o pendientes de aceptación.
2. LIST productos con el filtro external_deal_id.
3. LIST todos los productos dentro de un pedido.

Actualiza un acuerdo

1. Actualiza el pedido de información de contacto del publicador.
   1. name, no permite la actualización(no se puede establecer en field_mask). El estado solo se puede establecer como Cancelado a través de la API.
   2. partner_id no permite actualizaciones.
2. Actualiza el producto para una actualización específica de las condiciones del acuerdo.
   1. No se pueden actualizar los campos name, externalDealId, transactionType, pricingType ni updateTime.
   2. La actualización de displayName no requiere la aceptación del usuario.
   3. Si se actualiza rateDetails, creativeConfig cambiará el estado del pedido principal a Pendiente de aceptación. Se les pedirá a los anunciantes de DV3 que acepten la nueva condición en la página de negociación, independientemente de si se aceptó o no el pedido anterior.

Consulta si el usuario aceptó la oferta

1. Get Order si conoces el ID de pedido correspondiente. Verifica el campo de estado.
2. Si no se hizo un seguimiento del ID del pedido: List Products with external_deal_id filter, figure out order name from product name y, luego, Get Order. Verifica el campo de estado.

Comprueba si el usuario configuró(solo para PG) el acuerdo.

1. Obtén la fuente del inventario. El nombre es "exchanges/{exchangeId}/inventorysources/{external_deal_id}". Consulta Buyer Status.
   1. Ofertas de reservación
      1. BUYER_STATUS_ACTIVE significa que se aceptó y configuró un acuerdo. Se espera que el acuerdo tenga inversión en este estado cuando DV3 reciba una solicitud de oferta que coincida con las condiciones del acuerdo. Se genera automáticamente una línea de pedido durante el paso Configuración del acuerdo. Consulta Configuración de la oferta para obtener más detalles.
      2. BUYER_STATUS_PENDINGsignifica que se aceptó el pedido, pero aún no se configuró el acuerdo. En este estado, no se generarán gastos.
      3. BUYER_STATUS_PAUSEDsignifica que los anunciantes pausaron explícitamente el acuerdo. En este estado, no se generarán gastos.
   2. Acuerdos sin reservación
      1. BUYER_STATUS_ACTIVE significa que se aceptó un acuerdo. Se espera que la oferta tenga inversión en este estado cuando DV3 reciba una solicitud de oferta que coincida con las condiciones de la oferta Y haya una línea de pedido activa segmentada para esta oferta Y la solicitud de oferta coincida con los criterios de segmentación de la línea de pedido. Consulta línea de pedido para obtener más detalles.** NO hay una API de Seller para consultar si las líneas de pedido segmentaron un acuerdo. **
      2. BUYER_STATUS_PENDINGno aplicable.
      3. BUYER_STATUS_PAUSEDsignifica que los anunciantes pausaron explícitamente el acuerdo. En este estado, no se generarán gastos.

Cómo pausar o reanudar un acuerdo después de aceptarlo

1. Actualiza la Fuente de inventario del Estado del vendedor.
   1. Pausar o reanudar no afecta la publicación de acuerdos. Cuando el vendedor pausa un acuerdo, solo se muestra un mensaje de cadena a los anunciantes a modo de FYI. Esto ayuda al anunciante a solucionar problemas relacionados con un acuerdo que no genera inversión.

Renegociación (actualiza el acuerdo después de aceptarlo)

La renegociación se refiere a las actualizaciones que se realizan en un acuerdo después de que el comprador lo acepta. Esto puede ser muy útil tanto para los intercambios como para los compradores para enviar los cambios nuevos a los acuerdos aceptados. Por ejemplo, el intercambio puede detectar que la hora de finalización de un acuerdo aceptado no es correcta y puede usar el producto Update de DV3 para enviar actualizaciones a los compradores de DV3 si el acuerdo aún no comenzó.

Qué cambios se permiten y cuáles no

Permitimos cambios en todos los campos, excepto en algunos campos críticos para la publicación, como startTime, endTime, rateDetails, creativeConfig, etcétera. Tenemos validaciones en torno a estos campos críticos para la publicación. En general, se permiten las actualizaciones de estos campos, excepto creativeConfig, si la hora de inicio del acuerdo es al menos 1 día después en el futuro. Solo se permiten actualizaciones incrementales para las ofertas en curso cuya hora de inicio ya pasó, pero la hora de finalización es futura. No se permiten cambios en los acuerdos completados, cuya hora de finalización ya pasó. Por ejemplo, no se permite actualizar el rateDetails de un acuerdo que se completó hace un año. En estos casos, el producto Update de la versión 3 de la API de DV arrojará un error de validación.