Servicio de configuración

Una vez que el inventario se ha integrado con Prebid Server Premium (PSP), se ha revisado la configuración entre socios y se han habilitado los socios de demanda , el inventario debe asignarse a los socios de demanda a través de las configuraciones de PSP. Estas asignaciones permiten a PSP enviar solicitudes de oferta con los parámetros de los socios de demanda para que los socios puedan identificar el inventario y representarlo mejor ante sus compradores, lo que aumenta el rendimiento y respeta la configuración del editor, como los pisos y la calidad de los anuncios.

Cada configuración se dirige a una parte del inventario del editor en Monetize mediante una o más dimensiones, como ubicación, grupo con ubicación, editor, geografía, tipo de inventario o clave-valor.
Cada configuración incluye uno o varios partners de demanda que el editor desea pujar por el inventario
Cada socio de demanda especifica los parámetros requeridos y opcionales que desea recibir en su adaptador Prebid Server Go de código abierto, que se muestran en PSP. Estos permiten al socio hacer coincidir la solicitud de oferta con los objetos de su plataforma
Los publicadores rellenan los parámetros del partner de demanda con valores asignados a objetos de la plataforma de cada partner, normalmente otra plataforma del lado de la oferta (SSP)

Requisitos de los partners de demanda

Todos los partners de demanda que el editor desee ofertar por el inventario definido en una configuración de PSP deben agregarse a la misma configuración. Antes de crear el primer conjunto de configuraciones, revise los requisitos con cada uno de los socios de demanda de PSP planificados para determinar una estrategia de asignación. Algunos socios extraen información dinámicamente de la solicitud de oferta (tamaño del anuncio, ubicación geográfica, idioma, etc.), mientras que otros pueden requerir asignaciones de parámetros independientes y, a su vez, configuraciones de PSP. Si un socio de demanda requiere una asignación muy granular a objetos en su plataforma, eso determinará cómo se asignan otros socios y cuántas configuraciones se requieren. Cuanto mejor pueda identificar el inventario un socio de demanda (ya sea a través de la solicitud de oferta o parámetros estáticos de Prebid), más información podrá proporcionar a sus compradores, lo que aumentará los ingresos de los editores.

Los parámetros del partner de demanda se pueden encontrar:

En el servicio de configuración de PSP, como se detalla a continuación, o dentro de la propia interfaz de usuario .
En el sitio de Prebid , donde se proporcionan detalles y contexto completos.
En el servicio de esquema de partner de demanda de PSP.

La documentación siguiente describe cómo crear y administrar configuraciones a través de la API. Las configuraciones también se pueden administrar a través de la interfaz de usuario.

API de REST

Método HTTP	Endpoint	Description
`GET`	https://api.appnexus.com/prebid/config	Devolver todas las configuraciones de Prebid.
`GET`	https://api.appnexus.com/prebid/config/{prebidSettingsId}	Devuelva configuraciones específicas de Prebid.
`POST`	https://api.appnexus.com/prebid/config	Agregar una nueva configuración de Prebid.
`PUT`	https://api.appnexus.com/prebid/config/{prebidSettingsId}	Actualizar una configuración de Prebid existente.
`PATCH`	https://api.appnexus.com/prebid/config/{prebidSettingsId}	Actualizar una parte de las configuraciones de Prebid existentes.
`DELETE`	https://api.appnexus.com/prebid/config/{prebidSettingsId}	Eliminar una configuración de Prebid existente.

GET

Devuelve todas las configuraciones de Prebid para el miembro del autor de la llamada. Los resultados se devuelven como JSON.

Parameters

Propiedad	Ámbito	Tipo	Descripción
`status_filter`	string	Opcional	Filtre los resultados en función de si una configuración está habilitada o deshabilitada. Pase el `status_filter` argumento en la consulta y establezca el valor en habilitado o deshabilitado.

Llamada de ejemplo con curl con argumentos de filtro de estado

curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/config?status_filter=enabled

Ejemplo de llamada que usa curl para devolver una configuración específica

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

curl --header "Content-Type: application/json"https://api.appnexus.com/prebid/config/{prebidSettingsId}

Respuestas

Una respuesta correcta devolverá un JSON que contiene la configuración entre socios del miembro y todas sus configuraciones de PSP. Incluir un específico prebidSettingsId en la cadena de consulta dará como resultado una respuesta que contenga solo esa configuración.

Propiedad	Tipo	Descripción
`bidder_timeout_ms`	integer	Esto se define en el servicio de configuración entre asociados.
`configs`	matriz	Contenedor con los objetos de configuración para el miembro o un objeto de configuración específico. Para los elementos contenidos en un objeto de configuración, consulte la tabla de propiedades de configuración a continuación.
`deleted`	integer	Indica si se ha eliminado el objeto. Los valores permitidos son: `0` = activo, `1` = eliminado
`demand_partner_settings`	matriz	Las propiedades del asociado de demanda. Para los elementos contenidos en el `demand_partner_settings` objeto, consulte la tabla de configuración de los partners de demanda a continuación.
`id`	integer	- Cuando la solicitud no especifica un `prebidSettingsId`, el primer identificador de la respuesta representa el identificador único de configuración entre socios del miembro. El objeto configs incluye los valores de identificador de cada configuración. - Cuando la solicitud especifique un `prebidSettingsId`, ese será el identificador único en la respuesta. Este identificador se conoce como prebid_settings_id en otros puntos de conexión de esta API.
`last_modified`	string	La fecha de modificación más reciente del objeto de configuración.
`last_modified_by`	string	El usuario que realizó la última modificación en el objeto de configuración.
`member_id`	integer	El identificador del miembro asociado a las configuraciones.
`price_granularity`	objeto	Define los cubos de precios de CPM en los que se agruparán las pujas de los partners de demanda en el servidor de anuncios. Consulte la tabla de granularidad de precios a continuación. El objeto se administra mediante el servicio de configuración entre asociados.
`total_configs`	integer	Número de configuraciones devueltas.

Configuración de los partners de demanda

Propiedad	Tipo	Descripción
`bid_cpm_adjustment`	float	Un valor multiplicador aplicado al precio de puja del CPM del asociado de demanda para ajustar cómo compiten las pujas en la subasta. Consulte el Servicio de partners de demanda para obtener más información.
`enabled`	integer	Indica si el asociado de demanda se ha habilitado o deshabilitado. Los valores permitidos son: `1`= habilitada, `0`= deshabilitado
`id`	integer	El id. de la configuración del asociado de demanda.
`name`	string	El nombre del asociado de demanda. Consulte el Servicio de partners de demanda para obtener más información.

Propiedades de configuración

Propiedad	Tipo	Descripción
`deleted`	integer	Indica que el objeto de configuración no está disponible para su uso, pero sus datos siguen siendo visibles. Los valores permitidos son: `0` = activo, `1` = eliminado
`demand_partner_config_params`	matriz	Un contenedor con los parámetros del adaptador del asociado de demanda y los valores que recibirán en las solicitudes de oferta de PSP. Para ver los elementos contenidos en el `demand_partner_config_params` objeto, consulte la tabla de propiedades de configuración del asociado de demanda a continuación.
`enabled`	integer	Indica si la configuración está habilitada o deshabilitada. Los valores permitidos son: `1`= habilitada, `0`= deshabilitado
`id`	integer	Este identificador se conoce como `prebid_settings_id` en otros puntos de conexión de la API.
`last_modified`	string	La fecha de modificación más reciente de la configuración. Con formato de fecha y hora.
`last_modified_by`	string	El usuario que realizó la última modificación en el objeto de configuración.
`member_id`	integer	El identificador del miembro asociado a las configuraciones.
`name`	string	El nombre de la configuración.
`targeting_level_code`	integer	El tipo de objeto asociado a la configuración: - `4` Perfil de línea de pedido/segmentación
`targeting_id`	integer	El identificador del objeto al que está asociada la configuración (por ejemplo, una línea de pedido). Las solicitudes se envían a los socios de demanda cuando la solicitud de oferta coincide con la segmentación de la línea de pedido o el perfil. La línea de pedido debe ser un subtipo "psp", creado por el servicio de objetos de campaña de PSP, que crea y vincula automáticamente la línea de pedido al perfil.
`targeting_metadata`	objeto	Incluye modificadores para el objeto de destino. Para obtener más información sobre los elementos contenidos en el `targeting_metadata` objeto, consulte la tabla Propiedades de metadatos de destino . El `targeting_metadata.priority` campo es obligatorio.
`psp_profile`	objeto	El `profile` objeto define los atributos de segmentación de inventario usados para hacer coincidir las solicitudes de puja con las configuraciones de PSP. El perfil es: 1. Se genera automáticamente al usar la interfaz de usuario de PSP, o bien 2. Creado en base a la entrada del usuario a través de la `psp-campaign-objects` API. Para modificar un perfil, use la `psp-campaign-objects` API. El servicio de configuración devuelve el objeto solo en `GET` las `psp_profile` respuestas.

Propiedades de metadatos de destino

Propiedad	Tipo	Descripción
`priority`	integer	Cada subasta utiliza una configuración de PSP y su conjunto de parámetros de socios de demanda. Cuando varias configuraciones coinciden con una subasta: - Se selecciona la configuración con la prioridad definida por el usuario más alta. - Si varias configuraciones comparten la misma prioridad, se usa la que tiene el ID más alto (más reciente).

Exigir las propiedades de configuración de los asociados

Propiedad	Tipo	Descripción
`deleted`	integer	Indica que el objeto de configuración no está disponible para su uso, pero sus datos siguen siendo visibles. Los valores permitidos son: `0` = activo, `1` = eliminado
`enabled`	integer	Indica si el asociado de demanda se ha habilitado o deshabilitado. Para obtener más información, consulte el Servicio de asociado de demanda. Los valores permitidos son: `1`= habilitada, `0`= deshabilitado
`id`	integer	El identificador de las asignaciones de parámetros para el partner de demanda específico.
`last_modified`	string	Fecha de modificación más reciente del `demand_partner_config`archivo .
`last_modified_by`	string	La persona que realizó las últimas modificaciones en el `demand_partner_config`archivo .
`member_id`	integer	El member_id asociado con el `demand_partner_config`archivo .
`name`	string	El nombre del licitador de Prebid para el asociado de demanda.
`params`	objeto	Los parámetros específicos del partner y los valores asignados. Para obtener más información, consulte el Servicio de parámetros de Demand Partner.
`prebid_settings_id`	integer	El id. de la configuración, que puede contener varias asignaciones de parámetros del asociado a la demanda.

Granularidad del precio

La granularidad del precio define los cubos de precios CPM en los que se agruparán las pujas de los partners de demanda en el servidor de anuncios. Esto se define en el servicio de configuración entre socios.

Propiedad	Tipo	Descripción
`currency_code`	string	Cadena que contiene el código de moneda deseado para los cálculos del cubo de precios. Debe formar parte de la lista de monedas aprobada por Microsoft.
`label`	string	El tipo de escala definida en la documentación de Prebid (baja, media, alta, automática, densa, personalizada). Consulte el servicio de configuración entre asociados.
`precision`	integer	El número de posiciones decimales a las que se redondea el precio. El valor predeterminado es dos decimales, por lo que un precio de 2,1234 se redondearía a 2,12.
`ranges`	objeto	Objeto contenedor que describe el intervalo de granularidad de precios.
`ranges.max`	integer	La longitud máxima del rango.
`ranges.increment`	float	La cantidad que se va a incrementar a través del intervalo.

Perfil

El profile objeto contiene los atributos de segmentación de inventario usados para hacer coincidir las solicitudes de puja con las configuraciones de PSP.

El perfil es:

Se genera automáticamente al usar la interfaz de usuario de PSP, o bien
Creado a partir de la entrada del usuario a través de la psp-campaign-objects API.

Para actualizar un perfil, use la psp-campaign-objects API. El servicio de configuración devuelve el objeto solo en GET las psp_profile respuestas.

Propiedad	Tipo	Descripción
`psp_profile`	objeto	Determina qué solicitudes de puja del editor activan la configuración de PSP. Para conocer la estructura y los detalles, consulte la documentación del servicio de perfiles . Este objeto se crea y actualiza a través de la interfaz de usuario de PSP o el `psp-campaign-objects` servicio.

Paginación

El número de respuestas se puede limitar pasando el num_elements argumento. El elemento que se va a empezar a ver se puede establecer a través del start_element argumento.

Propiedad	Tipo	Descripción
`num_elements`	Entero	Cuántos elementos devolver. Por ejemplo, iniciar en el objeto # 4 y devolver 3 objetos, o # 4, 5, 6.
`start_element`	Entero	El número en el que debe empezar a contar.

Ejemplo de llamada para limitar a quince resultados e iniciar los resultados en el décimo elemento

Los elementos devueltos se indexarán del 10º al vigésimo quinto.

GET https://api.appnexus.com/prebid/config?num_element=15&start_element=10

Ejemplo de respuesta


{
  "id": 450,
  "member_id": 13859,
  "bidder_timeout_ms": 500,
  "price_granularity": {
    "label": "Auto",
    "currency_code": "USD",
    "precision": 2,
    "ranges": [
      {
        "max": 5,
        "increment": 0.05
      },
      {
        "max": 10,
        "increment": 0.1
      },
      {
        "max": 20,
        "increment": 0.5
      }
    ]
  },
  "deleted": 0,
  "last_modified_by": "user123",
  "last_modified": "2024-08-21T16:37:24.000Z",
  "demand_partner_settings": {
    "appnexus": {
      "id": 2045,
      "bid_cpm_adjustment": 0.7,
      "enabled": 1
    },
    "openx": {
      "id": 2065,
      "bid_cpm_adjustment": 1,
      "enabled": 0
    },
    "ix": {
      "id": 2106,
      "bid_cpm_adjustment": 0.9,
      "enabled": 1
    },
    "adform": {
      "id": 2110,
      "bid_cpm_adjustment": 1,
      "enabled": 1
    }
  },
  "total_configs": 2,
  "configs": [
    {
      "id": 87053,
      "member_id": 13859,
      "name": "ConfigName1",
      "targeting_level_code": 4,
      "targeting_id": 25172737,
      "enabled": 1,
      "targeting_metadata": {
        "priority": 10
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-17T18:17:56.000Z",
      "demand_partner_config_params": [
        {
          "id": 619584,
          "member_id": 13859,
          "prebid_settings_id": 87053,
          "name": "ix",
          "params": {
            "size": null,
            "siteId": "yyy.com"
          },
          "enabled": 1,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-07-17T18:36:40.000Z"
        }
      ],
      "psp_profile": {
        "id": 147870841,
        "description": "",
        "country_action": "include",
        "supply_type_action": "include",
        "advertiser_id": 11125655,
        "created_on": "2025-10-23 18:02:50",
        "country_targets": [
          {
            "id": 59,
            "name": "Germany",
            "code": "DE",
            "active": true
          },
          {
            "id": 233,
            "name": "United States",
            "code": "US",
            "active": true
          }
        ],
        "supply_type_targets": [
          "mobile_app",
          "mobile_web",
          "web"
        ],
        "ad_type_targets": [
          {
            "id": 2,
            "name": "video"
          }
        ],
        "placement_targets": [
          {
            "id": 36707024,
            "action": "include",
            "name": "Placement Name 1",
            "deleted": 0,
            "site_id": 7908985,
            "site_name": "Placement Group 1",
            "publisher_id": 2545613,
            "publisher_name": "Publisher 1"
          }
        ]
      }
    },
    {
      "id": 87784,
      "member_id": 13859,
      "name": "ConfigName2",
      "targeting_level_code": 4,
      "targeting_id": 25175861,
      "enabled": 1,
      "targeting_metadata": {
        "priority": 10
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-31T21:34:34.000Z",
      "demand_partner_config_params": [
        {
          "id": 619080,
          "member_id": 13859,
          "prebid_settings_id": 87784,
          "name": "openx",
          "params": {
            "unit": "3456",
            "platform": null,
            "delDomain": "abc.com",
            "customFloor": null,
            "customParams": null
          },
          "enabled": 0,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-08-21T21:10:28.000Z"
        },
        {
          "id": 619081,
          "member_id": 13859,
          "prebid_settings_id": 87784,
          "name": "ix",
          "params": {
            "size": null,
            "siteId": "abc.com"
          },
          "enabled": 1,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-07-17T18:36:06.000Z"
        },
        {
          "id": 625915,
          "member_id": 13859,
          "prebid_settings_id": 87784,
          "name": "adform",
          "params": {
            "inv": null,
            "mid": "1414158",
            "mname": null,
            "priceType": null
          },
          "enabled": 1,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-07-17T18:36:09.000Z"
        }
      ],
      "psp_profile": {
        "id": 147870841,
        "description": "",
        "country_action": "include",
        "supply_type_action": "include",
        "advertiser_id": 11125655,
        "created_on": "2025-10-23 18:02:50",
        "country_targets": [
          {
            "id": 59,
            "name": "Germany",
            "code": "DE",
            "active": true
          },
          {
            "id": 233,
            "name": "United States",
            "code": "US",
            "active": true
          }
        ],
        "supply_type_targets": [
          "mobile_app",
          "mobile_web",
          "web"
        ],
        "ad_type_targets": [
          {
            "id": 2,
            "name": "video"
          }
        ],
        "placement_targets": [
          {
            "id": 36707024,
            "action": "include",
            "name": "Placement Name 2",
            "deleted": 0,
            "site_id": 7908985,
            "site_name": "Placement Group 2",
            "publisher_id": 2545613,
            "publisher_name": "Publisher 2"
          }
        ]
      }
    }
  ]
}

POST

Habilita la creación de un nuevo objeto de configuración. El demand_partner_config_params.enabled campo no debe incluirse en ninguna solicitud a este servicio. El valor se hereda del estado del asociado en el servicio de asociado de demanda.

Nota:

Las selecciones de tipo de medio ya no se definen en el servicio de configuración. Use la matriz del servicio dead_type_targets objetos de campaña de PSP para definir esos valores.

Ejemplo de llamada con curl

curl -d @config.json -X POST --header "Content-Type: application/json" 'https://api.appnexus.com/prebid/config'

POST: Parámetros

Propiedad	Tipo	Ámbito	Descripción
`demand_partner_config_params`	matriz	Obligatorio	Un contenedor con los parámetros del adaptador del asociado de demanda y los valores que recibirán en las solicitudes de oferta de PSP. Para ver los elementos contenidos en el `demand_partner_config_params` objeto, consulte la tabla de propiedades de configuración del asociado de demanda a continuación.
`enabled`	integer	Obligatorio	Indica si la configuración está habilitada o deshabilitada. Los valores permitidos son: `1`= habilitada, `0`= deshabilitado
`name`	string	Obligatorio	El nombre de la configuración.
`targeting_id`	integer	Obligatorio	El identificador del objeto al que está asociada la configuración (por ejemplo, una línea de pedido). Las solicitudes se envían a los socios de demanda cuando la solicitud de oferta coincide con la segmentación de la línea de pedido o el perfil. La línea de pedido debe ser un subtipo "psp", creado por el servicio de objetos de campaña de PSP, que crea y vincula automáticamente la línea de pedido al perfil.
`targeting_metadata`	objeto	Opcional	Incluye modificadores para el objeto de destino. Consulta la tabla Propiedades de metadatos de segmentación para ver los elementos contenidos en el `targeting_metadata` objeto. `targeting_metadata.priority` aprendizaje automático.

POST: Exigir las propiedades de configuración de los asociados

Propiedad	Tipo	Ámbito	Descripción
`name`	string	Obligatorio	El nombre del licitador de Prebid para el asociado de demanda.
`params`	objeto	Obligatorio	Los parámetros específicos del partner y los valores asignados. Para obtener más información, consulte el Servicio de parámetros de Demand Partner.

POST: Propiedades de metadatos de destino

Propiedad	Tipo	Ámbito	Descripción
`priority`	integer	Obligatorio	Cada subasta utiliza una configuración de PSP y su conjunto de parámetros de socios de demanda. Cuando varias configuraciones coinciden con una subasta: - Se selecciona la configuración con la prioridad definida por el usuario más alta. - Si varias configuraciones comparten la misma prioridad, se usa la que tiene el ID más alto (más reciente).

Ejemplo de solicitud JSON


{
    "name": "ConfigName1",
    "targeting_id": 22378872,
    "enabled": 0,
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "id": 1718542,
            "member_id": 13859,
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            }
        }
    ]
}

Respuesta

Una respuesta correcta devolverá el nuevo objeto de configuración.

POST: Ejemplo de respuesta JSON

{
    "id": 196038,
    "member_id": 13859,
    "name": "ConfigName1",
    "targeting_level_code": 4,
    "targeting_id": 22378872,
    "enabled": 1,
    "targeting_metadata": {
        "priority": 20
    },
    "deleted": 0,
    "last_modified_by": "user123",
    "last_modified": "2024-08-22T21:24:40.000Z",
    "demand_partner_config_params": [
        {
            "id": 1718542,
            "member_id": 13859,
            "prebid_settings_id": 196038,
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            },
            "enabled": 1,
            "deleted": 0,
            "last_modified_by": "user123",
            "last_modified": "2024-08-22T21:24:40.000Z"
        }
    ]
}

PUT

Sobrescritura de una configuración de Prebid existente. Inclúyalo prebidSettingsId como último componente de la ruta de acceso URL. Pase la información de actualización como JSON en el cuerpo de la solicitud.

El demand_partner_config_params.enabled campo no debe incluirse en ninguna solicitud a este servicio. El valor se hereda del estado del asociado en el servicio de asociado de demanda.

PUT: Ejemplo de llamada con curl

curl -d @config-update.json -X PUT --header "Content-Type: application/json https://api.appnexus.com/prebid/config/{prebidSettingsId}

PUT: Ejemplo de solicitud JSON

{
    "name": "ConfigName1",
    "targeting_id": 22378872,
    "enabled": 0,
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "id": 1718542,
            "member_id": 13859,
            "prebid_settings_id": 196038,
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            }
        }
    ]
}

PUT: Respuesta

Devuelve un objeto de configuración Prebid.

PATCH

Actualizar parcialmente una configuración de Prebid existente. Incluya el prebidSettingsId como último componente de la ruta de acceso. Pase la información de actualización como JSON en el cuerpo de la solicitud. La solicitud debe incluir un objeto de nivel config superior que contenga los demás elementos que se van a actualizar.