Servicio de objetos de campaña

La interfaz de usuario de Prebid Server Premium (PSP) permite la creación de configuraciones, incluida la segmentación (ubicación geográfica, dispositivo, valor clave, etc.) y el mapeo de socios de demanda, en un único flujo de trabajo. Consulte Creación de una nueva configuración de PSP para obtener orientación sobre el contexto y la interfaz de usuario.

La creación de estas configuraciones a través de la API requiere que el servicio de objetos de campaña de PSP, que se detalla a continuación, establezca la segmentación deseada. La respuesta de este servicio incluye a lineItem.id que, a continuación, se establece como en el targeting_idservicio de configuración.

El nuevo servicio de objetos de campaña de PSP:

  • Crea un anunciante (si no existe un anunciante de PSP).
  • Crea una orden de inserción (si no existe una orden de inserción de PSP).
  • Para cada llamada, crea un nuevo par de perfil y línea de pedido.

Estos son objetos de shell específicos de PSP que no cumplen, pero son necesarios para que la plataforma Monetize evalúe el perfil de segmentación. Solo la parte del perfil es relevante para el editor para cualquier POST/PUT llamada a este servicio PSP.

Se recomienda administrar estas configuraciones y su destino en la interfaz de usuario de PSP, pero para los editores grandes o aquellos con automatización, la interacción de la API es necesaria o al menos preferida.

Flujo de trabajo de alto nivel

  1. Realiza una POST solicitud con https://api.appnexus.com/prebid/psp-campaign-objects la segmentación deseada.
  2. Registre el lineItem.id valor.
  3. Haga una POST/PUT solicitud a https://api.appnexus.com/prebid/config donde se encuentra el lineItem.idtargeting_id de la respuesta de servicio de los objetos de campaña de PSP.

Nota:

No elimine las líneas de pedido ni los perfiles asociados a las configuraciones de PSP. Eso rompería las configuraciones, evitaría que las solicitudes de oferta se envíen a los socios de demanda y evitaría la monetización del inventario afectado a través de PSP. El anunciante de PSP y la eliminación de la orden de inserción se bloquean a nivel de plataforma.

API de REST

Método HTTP Endpoint Description
POST https://api.appnexus.com/prebid/psp-campaign-objects Cree la segmentación de PSP y todos los objetos de requisitos previos (anunciante, orden de inserción, línea de pedido, perfil).
PUT https://api.appnexus.com/prebid/psp-campaign-objects?profileId={ProfileID}& lineItemId={LineItemID}} Sobrescribir la segmentación de PSP.

POST

POST: Parámetros

Propiedad Tipo Descripción
profile objeto Determina qué solicitudes de puja del publicador iniciarán la configuración de PSP. Consulte la documentación del servicio de perfiles para obtener información sobre la estructura y los detalles.
profile.name string Descripción orientada al usuario de la segmentación incluida en este perfil. Se diferencia de otros conjuntos de selección de destino utilizados en las configuraciones de PSP.
profile.ad_type_targets matriz de objetos REQUERIDO para cada POST y PUT a este servicio. Matriz de objetos, incluidos los identificadores que representan cada tipo de medio que la configuración de PSP enviará a los socios de demanda. Vea la estructura en el ejemplo POST a continuación.
1 = banner
2 = vídeo
3 = nativo

POST Response

Propiedad Tipo Descripción
advertiser objeto El anunciante creado automáticamente para alojar todos los objetos de PSP. Consulte la documentación del servicio de anunciantes para obtener más información. El borrado se bloquea a nivel de plataforma.
insertionOrder objeto La orden de inserción creada automáticamente debe alojar todas las líneas de pedido de PSP. Consulta la documentación del servicio de la orden de inserción para obtener más información. El borrado se bloquea a nivel de plataforma.
lineItem objeto El elemento de línea creado automáticamente para llevar el perfil de segmentación para su evaluación. NO ELIMINAR Este objeto o cualquier configuración asociada se romperá. Consulte la documentación del servicio de la línea de pedido para obtener más información.
profile objeto El perfil creado en función de la entrada de la llamada POST inicial. Determina qué solicitudes de puja del publicador iniciarán la configuración de PSP. NO ELIMINAR Este objeto o cualquier configuración asociada se romperá. Consulte la documentación del servicio de perfiles para obtener información sobre la estructura y los detalles.

Creación de objetos

  1. Haga una POST solicitud a https://api.appnexus.com/prebid/psp-campaign-objects.

    1. Incluir un objeto de perfil de nivel superior.

    2. El objeto de perfil debe incluir una name cadena, una ad_type_targets matriz de objetos.

    3. El objeto de perfil debe contener cualquier segmentación deseada según se documente en el servicio de perfiles.

      Nota:

      En la documentación del servicio de perfiles , ciertos campos, como country_targets, incluyen un campo correspondiente _action , como country_action. El campo _action se puede establecer para incluir o excluir. Si se establece para incluir, se debe rellenar el objeto o la matriz correspondiente (por ejemplo, country_targets) para que la segmentación funcione correctamente.

    4. Los valores que se deben rellenar en el perfil se pueden encontrar en los servicios de solo lectura, como el servicio de país. Estos están vinculados en la documentación del servicio de perfiles.

Ejemplo de solicitud de perfil

   
{
    "profile": {
        "name": "Test Profile",
        "ad_type_targets": [
            {
                "id": 1
            },
            {
                "id": 2
            }
        ],
        "country_action": "include",
        "country_targets": [
            {
                "id": 233,
                "name": "United States",
                "code": "US",
                "active": true
            },
            {
                "id": 41,
                "name": "Canada",
                "code": "CA",
                "active": true
            },
            {
                "id": 80,
                "name": "United Kingdom",
                "code": "UK",
                "active": true
            }
        ]
    }
}

  1. El servicio de objetos de campaña de PSP responderá con los detalles de los objetos creados:

    1. anunciante: creado si aún no existía uno para PSP.
    2. insertionOrder: Creado si aún no existía uno para PSP.
    3. perfil: contiene toda la segmentación.
    4. lineItem: Incluye el id valor que se utilizará como targeting_id en el servicio de configuración de PSP.

  2. Realizar una POST o PUT solicitar documentaciónhttps://api.appnexus.com/prebid/config.

    1. targeting_id es la lineItem.id de la respuesta de servicio de los objetos de la campaña de PSP.
    2. targeting_metadata.priority es un entero del 1 al 20.
      1. Cada subasta utiliza una configuración.
      2. Si la selección de destino de varias configuraciones se superpone, determina la targeting_metadata.priority configuración que se elige, siendo 20 la prioridad más alta.

Ejemplo de solicitud de configuración

Anexe el id. de configuración como último componente de la dirección URL.

{
    "name": "Test Configuration",
    "targeting_id": 26831593,
    "enabled": true,
    "targeting_metadata": {
        "priority": 18
    },
    "demand_partner_config_params": [
        {
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            }
        }
    ]
}
  1. El servicio de configuración responderá confirmando los detalles de los objetos (configuración y, opcionalmente, parámetros de configuración de los partners de demanda) creados.

PUT

Editar objetos

  1. Recupera los detalles del perfil creado anteriormente por el servicio de objetos de campaña de PSP. Consulte la documentación del servicio de perfiles:

    1. Si no se conoce el advertiser.id servicio de la llamada anterior a los objetos de campaña del PSP, consulte la documentación del servicio del anunciante. Haga una solicitud GET a https://api.appnexus.com/advertiser.
    2. Realizar una GET solicitud para https://api.appnexus.com/profile?advertiser_id=ADVERTISERID recuperar todos los perfiles del anunciante, o https://api.appnexus.com/profile?code=PROFILEID& advertiser_code=ADVERTISERID para recuperar un perfil específico.
    3. El servicio de perfiles responderá con el objeto de perfil completo, que contiene todos los campos de segmentación posibles. Aunque PATCH no se admiten las solicitudes a objetos de campaña de PSP, la solicitud PUT solo necesita incluir los elementos de segmentación del perfil que se van a actualizar.
    4. Si no lineItem.id se conoce, consulte la documentación del servicio de línea de pedido. Haga una solicitud GET a https://api.appnexus.com/line-item.

  2. Haga una PUT solicitud a https://api.appnexus.com/prebid/psp-campaign-objects?profileId=PROFILEID& lineItemId=LINEITEMID

    1. Incluir un objeto de perfil de nivel superior.
    2. El objeto de perfil debe contener los cambios de orientación deseados según se documenta en el servicio de perfiles.

Ejemplo de llamada con curl

    
{
    "profile": {
        "ad_type_targets": [
            {
                "id": 1
            }
        ],
        "country_action": "include",
        "country_targets": [
            {
                "id": 233,
                "name": "United States",
                "code": "US",
                "active": true
            },
            {
                "id": 41,
                "name": "Canada",
                "code": "CA",
                "active": true
            },
            {
                "id": 80,
                "name": "United Kingdom",
                "code": "UK",
                "active": true
            },
            {
                "id": 34,
                "name": "Brazil",
                "code": "BR",
                "active": true
            }
        ]
    }
}
  1. El servicio de objetos de campaña de PSP responderá con los detalles de los objetos actualizados.

DELETE

Para eliminar un elemento de línea creado por el punto de conexión de objetos de campaña, inclúyalo lineItemId en la cadena de consulta.

ELIMINAR: Ejemplo de llamada con curl

curl -X DELETE https://api.appnexus.com/prebid/psp-campaign-objects?lineItemId=12345

ELIMINAR: Respuesta

Si se realiza correctamente, el elemento de línea indicado se devolverá como un objeto JSON con la propiedad eliminada establecida en true. Ya no estará disponible en el sistema. También se eliminarán todos los subobjetos.

  • Last updated on