Compartir a través de

Servicio Objetos de campaña

  • Artículo

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 de clave, etc.) y la asignación de asociados de demanda, en un único flujo de trabajo. Consulte Creación de una nueva configuración de PSP para obtener instrucciones sobre el contexto y la interfaz de usuario.

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

El nuevo servicio de objetos de campaña PSP:

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

Se trata de objetos de shell específicos de PSP que no entregan, pero que son necesarios para que la plataforma monetizar evalúe el perfil de destino. Solo la parte del perfil es relevante para el publicador para las POST//PUTPATCH llamadas a este servicio PSP.

Se recomienda administrar estas configuraciones y su destino en la interfaz de usuario de PSP, pero para publicadores grandes o aquellos con automatización, se requiere la interacción de LA API o, al menos, se prefiere.

Flujo de trabajo de alto nivel

  1. Realice una POST solicitud a https://api.appnexus.com/prebid/psp-campaign-objects con el destino deseado.
  2. Registre el lineItem.id valor.
  3. Realice una POST/PATCHPUT/solicitud a https://api.appnexus.com/prebid/config donde es de targeting_id la lineItem.id respuesta del servicio objetos de campaña PSP.

Nota:

No elimine los elementos de línea ni los perfiles asociados a las configuraciones de PSP. Esto interrumpiría las configuraciones, impediría que las solicitudes de puja se enviaran a los asociados de demanda e impediría la monetización del inventario afectado a través de PSP. La eliminación del anunciante y del pedido de inserción de PSP está bloqueada en el nivel de plataforma.

API de REST

Http (método) 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, pedido de inserción, elemento de línea, perfil).
PUT https://api.appnexus.com/prebid/psp-campaign-objects?profileId={ProfileID}& lineItemId={LineItemID}} Sobrescriba la selección de destino 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 perfil para obtener información sobre la estructura y los detalles.

Respuesta POST

Propiedad Tipo Descripción
advertiser objeto Anunciante creado automáticamente para hospedar todos los objetos PSP. Consulte la documentación del servicio de anunciantes para obtener más información. La eliminación se bloquea en el nivel de plataforma.
insertionOrder objeto Orden de inserción creado automáticamente para hospedar todos los elementos de línea de PSP. Consulte la documentación del servicio de pedido de inserción para obtener más información. La eliminación se bloquea en el nivel de plataforma.
lineItem objeto Elemento de línea creado automáticamente para llevar el perfil de destino para su evaluación. NO ELIMINE este objeto ni se interrumpirá ninguna configuración asociada. Consulte la documentación del servicio de elementos de línea para obtener más información.
profile objeto 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 ELIMINE este objeto ni se interrumpirá ninguna configuración asociada. Consulte la documentación del servicio de perfil para obtener información sobre la estructura y los detalles.

Creación de objetos

  1. Realice 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.

    3. El objeto de perfil debe contener cualquier destino deseado, tal como se documenta en el servicio de perfil.

      Nota:

      En la documenatation del servicio de perfil , algunos campos, como country_targets, incluyen un campo correspondiente _action , como country_action. El campo _action se puede establecer en incluir o excluir. Si se establece en include, el objeto o matriz correspondiente (por ejemplo, country_targets) debe rellenarse para que el destino funcione correctamente.

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

Solicitud de perfil de ejemplo

   
{
    "profile": {
        "name": "Test Profile",
        "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 psp responderá con los detalles de los objetos creados:

    1. anunciante: creado si aún no existe para PSP.
    2. insertionOrder: se ha creado si aún no existía una para PSP.
    3. profile: contiene toda la selección de destino.
    4. lineItem: incluye el id valor , que se usará como targeting_id en el servicio de configuración de PSP.

  2. Realice una POSTsolicitud , PUTo PATCH a la https://api.appnexus.com/prebid/configdocumentación.

    1. targeting_level_code debe ser 4 (elemento de línea).
    2. targeting_id es la lineItem.id respuesta del servicio de objetos de campaña PSP.
    3. targeting_metadata.priority es un entero del 1 al 20.
      1. Cada subasta usa una configuración.
      2. Si la segmentación de varias configuraciones se superpone, targeting_metadata.priority determina qué configuración se elige, siendo 20 la prioridad más alta.

Solicitud de configuración de ejemplo

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

{
    "name": "Test Configuration",
    "targeting_level_code": 4,
    "targeting_id": 26831593,
    "enabled": true,
    "media_types": {
        "types": [
            "banner",
            "video",
            "native"
        ]
    },
    "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, exigir los parámetros de configuración del asociado) creados.

PUT

Edición de objetos

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

    1. Si no se conoce el advertiser.id elemento de la llamada anterior al servicio objetos de campaña PSP no se conoce, consulte la documentación del servicio de anunciantes. Realice una solicitud GET a https://api.appnexus.com/advertiser.
    2. Realice 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 Profile responderá con el objeto de perfil completo, que contiene todos los campos de destino posibles. Aunque PATCH no se admiten las solicitudes a objetos de campaña PSP, la solicitud PUT solo necesita incluir los elementos de destino del perfil que se van a actualizar.
    4. lineItem.id Si no se conoce, consulte la documentación del servicio de elementos de línea. Realice una solicitud GET a https://api.appnexus.com/line-item.

  2. Realice 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 destino deseados, como se documenta en el servicio de perfil.

Ejemplo de llamada mediante curl

    
{
    "profile": {
        "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 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, incluya en lineItemId la cadena de consulta.

DELETE: llamada de ejemplo mediante curl

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

DELETE: respuesta

Si se ejecuta 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 objetos secundarios.