Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Una vez que se ha integrado el inventario con Prebid Server Premium (PSP), se ha revisado la configuración entre asociados y se han habilitado los asociados de demanda , el inventario debe asignarse a los asociados de demanda a través de configuraciones de PSP. Estas asignaciones permiten a PSP enviar solicitudes de puja con los parámetros de los asociados de demanda para que los asociados puedan identificar el inventario y representarlo mejor a 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 tiene como destino una parte del inventario del publicador en Monetizar mediante una o varias dimensiones, como la ubicación, el grupo de selección de ubicación, el publicador, la geografía, el tipo de inventario o el valor de clave.
- Cada configuración incluye uno o más asociados de demanda a los que el publicador quiere pujar en el inventario.
- Cada asociado de demanda especifica los parámetros obligatorios y opcionales que desea recibir en su adaptador de Prebid Server Go de código abierto, que se exponen en PSP. Permiten que el asociado coincida con la solicitud de puja con los objetos de su plataforma.
- Los publicadores rellenan parámetros de asociados de demanda con valores asignados a objetos de la plataforma de cada asociado, normalmente otra plataforma del lado de la oferta (SSP)
Requisitos de asociados de demanda
Todos los asociados de demanda que el publicador desea pujar 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 asociados de demanda de PSP planeados para determinar una estrategia de asignación. Algunos asociados extraen información dinámicamente de la solicitud de puja (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 asociado de demanda requiere una asignación muy pormenorizada a los objetos de su plataforma, esto determinará cómo se asignan otros asociados y cuántas configuraciones son necesarias. Cuanto mejor pueda identificar el inventario un partner de demanda (ya sea a través de la solicitud de puja o de los parámetros estáticos de preinserción), más información puede proporcionar a sus compradores, lo que aumenta los ingresos del publicador.
Se pueden encontrar parámetros de asociados de demanda:
- 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 , que proporciona el contexto completo y los detalles.
- En el servicio de esquema de asociados de demanda de PSP.
En la documentación siguiente se 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
| Http (método) | Endpoint | Description |
|---|---|---|
GET |
https://api.appnexus.com/prebid/config | Devuelve todas las configuraciones de Prebid. |
GET |
https://api.appnexus.com/prebid/config/{prebidSettingsId} | Devuelve configuraciones de prebid específicas. |
POST |
https://api.appnexus.com/prebid/config | Agregue una nueva configuración de Prebid. |
PUT |
https://api.appnexus.com/prebid/config/{prebidSettingsId} | Actualice una configuración de Prebid existente. |
PATCH |
https://api.appnexus.com/prebid/config/{prebidSettingsId} | Actualice una parte de las configuraciones de Prebid existentes. |
DELETE |
https://api.appnexus.com/prebid/config/{prebidSettingsId} | Elimine una configuración de Prebid existente. |
GET
Devuelve todas las configuraciones de Prebid para el miembro del llamador. 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 mediante curl con argumentos de filtro de estado
curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/config?status_filter=enabled
Llamada de ejemplo mediante curl para devolver una configuración específica
Anexe el identificador de configuración como el ú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á JSON que contiene la configuración entre asociados del miembro y todas sus configuraciones de PSP. Incluir un elemento específico prebidSettingsId en la cadena de consulta dará lugar a 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 configs 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 siguiente. |
deleted |
booleano | Si truees , indica que el objeto config no está disponible para su uso, pero sus datos todavía se pueden ver. |
demand_partner_settings |
matriz | Propiedades del asociado de demanda. Para ver los elementos contenidos en el demand_partner_settings objeto, consulte la tabla de configuración del asociado de demanda siguiente. |
id |
integer | - Cuando la solicitud no especifica , prebidSettingsIdel primer identificador de la respuesta representa el identificador de configuración único entre asociados para el miembro. El objeto configs incluye los valores de identificador de cada configuración. - Cuando la solicitud especifica un prebidSettingsId, que 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 | 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 | 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 asociados de demanda en el servidor de anuncios. Consulte la tabla de granularidad de precios siguiente. El objeto se administra mediante el servicio de configuración entre asociados. |
total_configs |
integer | Número de configuraciones devueltas. |
Configuración del asociado de demanda
| Propiedad | Tipo | Descripción |
|---|---|---|
bid_cpm_adjustment |
float | Valor multiplicador aplicado al precio de puja de CPM del partner de demanda para ajustar la forma en que las pujas compiten en la subasta. Consulte Demand Partner Service para obtener más información. |
enabled |
booleano | Indica si el asociado de demanda se ha habilitado o deshabilitado. |
id |
integer | Identificador de la configuración del asociado de demanda. |
name |
string | Nombre del asociado de demanda. Consulte Demand Partner Service para obtener más información. |
Propiedades de configuración
| Propiedad | Tipo | Descripción |
|---|---|---|
deleted |
booleano | Si truees , indica que el objeto de configuración no está disponible para su uso, pero sus datos todavía se pueden ver. |
demand_partner_config_params |
matriz | Un contenedor con los parámetros del adaptador del asociado de demanda y los valores que recibirá en las solicitudes de puja de PSP. Para ver los elementos incluidos en el demand_partner_config_params objeto , consulte la tabla de propiedades de configuraciones de asociados de demanda que se muestra a continuación. |
enabled |
booleano | Indica si la configuración está habilitada o deshabilitada. |
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 | Identificador del miembro asociado a las configuraciones. |
name |
string | Nombre de la configuración. |
targeting_level_code |
integer | Tipo de objeto asociado a la configuración: - 4 perfil de elemento de línea o destino |
targeting_id |
integer | Identificador del objeto al que está asociada la configuración (por ejemplo, un elemento de línea). Las solicitudes se envían a los asociados de demanda cuando la solicitud de puja coincide con la selección de destino del elemento de línea o perfil. El elemento de línea debe ser un subtipo "psp", creado por el servicio de objetos de campaña psp, que crea y vincula automáticamente el elemento de línea 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, vea la tabla Propiedades de metadatos de destino . El targeting_metadata.priority campo es obligatorio. |
Propiedades de metadatos de destino
| Propiedad | Tipo | Descripción |
|---|---|---|
priority |
integer | Cada subasta usa una configuración de PSP y su conjunto de parámetros de asociados de demanda. Cuando varias configuraciones coinciden con una subasta: : se selecciona la configuración con la prioridad más alta definida por el usuario. - Si varias configuraciones comparten la misma prioridad, se usa la que tiene el identificador más alto (más reciente). |
Propiedades de configuración de asociados de demanda
| Propiedad | Tipo | Descripción |
|---|---|---|
deleted |
booleano | Si truees , indica que el objeto de configuración no está disponible para su uso, pero sus datos todavía se pueden ver. |
enabled |
booleano | Indica si el asociado de demanda se ha habilitado o deshabilitado. Para obtener más información, consulte Demand Partner Service. |
id |
integer | Identificador de las asignaciones de parámetros para el asociado de demanda específico. |
last_modified |
string | Fecha de modificación más reciente de .demand_partner_config |
last_modified_by |
string | La persona que realizó las últimas modificaciones en .demand_partner_config |
member_id |
integer | El member_id asociado a demand_partner_config. |
name |
string | El nombre del postor de prebid para el asociado de demanda. |
params |
objeto | Parámetros específicos del asociado y valores asignados. Para obtener más información, consulte Demand Partner Params Service. |
prebid_settings_id |
integer | Identificador de la configuración que puede contener varias asignaciones de parámetros de asociados de demanda. |
Granularidad del precio
La granularidad del precio define los cubos de precios de CPM en los que se agruparán las pujas de asociados de demanda en el servidor de anuncios. Esto se define en el servicio de configuración entre asociados.
| 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 aprobadas por Microsoft. |
label |
string | El tipo de escala tal como se define en la documentación de Prebid (baja, media, alta, automática, densa, personalizada). Consulte el servicio entre asociados. |
precision |
integer | Número de posiciones decimales a las que se redondea el precio. El valor predeterminado es dos posiciones 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 | Longitud máxima del intervalo. |
ranges.increment |
float | Cantidad que se va a incrementar a través del intervalo. |
Paginación
El número de respuestas se puede limitar pasando el num_elements argumento . Qué elemento para empezar a ver se puede establecer a través del start_element argumento .
| Propiedad | Tipo | Descripción |
|---|---|---|
num_elements |
Entero | Número de elementos que se van a devolver. Por ejemplo, comience en el objeto 4 y devuelva 3 objetos, o bien 4, 5, 6. |
start_element |
Entero | Número en el que se va a empezar a contar. |
Llamada de ejemplo 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"
}
]
},
{
"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"
}
]
}
]
}
POST
Habilita la creación de un nuevo objeto configurations.
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 multimedia ya no se definen en el servicio de configuración. Use la matriz del servicio de objetos de campaña pspad_type_targets para definir esos valores.
Ejemplo de llamada mediante 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á en las solicitudes de puja de PSP. Para ver los elementos incluidos en el demand_partner_config_params objeto , consulte la tabla de propiedades de configuraciones de asociados de demanda que se muestra a continuación. |
enabled |
booleano | Obligatorio | Indica si la configuración está habilitada o deshabilitada. |
name |
string | Obligatorio | Nombre de la configuración. |
targeting_id |
integer | Obligatorio | Identificador del objeto al que está asociada la configuración (por ejemplo, un elemento de línea). Las solicitudes se envían a los asociados de demanda cuando la solicitud de puja coincide con la selección de destino del elemento de línea o perfil. El elemento de línea debe ser un subtipo "psp", creado por el servicio de objetos de campaña psp, que crea y vincula automáticamente el elemento de línea al perfil. |
targeting_metadata |
objeto | Opcional | Incluye modificadores para el objeto de destino. Consulte la tabla Propiedades de metadatos de destino para ver los elementos contenidos en el targeting_metadata objeto .
targeting_metadata.priority es necesario. |
POST: Propiedades de configuración de asociados de demanda
| Propiedad | Tipo | Ámbito | Descripción |
|---|---|---|---|
name |
string | Obligatorio | El nombre del postor de prebid para el asociado de demanda. |
params |
objeto | Obligatorio | Parámetros específicos del asociado y valores asignados. Para obtener más información, consulte Demand Partner Params Service. |
POST: Propiedades de metadatos de destino
| Propiedad | Tipo | Ámbito | Descripción |
|---|---|---|---|
priority |
integer | Obligatorio | Cada subasta usa una configuración de PSP y su conjunto de parámetros de asociados de demanda. Cuando varias configuraciones coinciden con una subasta: : se selecciona la configuración con la prioridad más alta definida por el usuario. - Si varias configuraciones comparten la misma prioridad, se usa la que tiene el identificador más alto (más reciente). |
Solicitud JSON de ejemplo
{
"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: Respuesta JSON de ejemplo
{
"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
Sobrescriba una configuración de Prebid existente. Incluya como prebidSettingsId el último componente de la ruta de acceso de la dirección 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: llamada de ejemplo mediante curl
curl -d @config-update.json -X PUT --header "Content-Type: application/json https://api.appnexus.com/prebid/config/{prebidSettingsId}
PUT: solicitud JSON de ejemplo
{
"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
Actualice parcialmente una configuración de Prebid existente. Incluya como prebidSettingsId ú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.
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.
PATCH: llamada de ejemplo mediante curl
curl -d @config-update.json -X PATCH --header "Content-Type: application/json https://api.appnexus.com/prebid/config/{prebidSettingsId}
PATCH: solicitud JSON de ejemplo
{
"config": {
"enabled": 0
}
}
PATCH: respuesta
Devuelve un objeto de configuración Prebid.
DELETE
Elimine una configuración de Prebid existente. Incluya como prebidSettingsId último componente de la ruta de acceso.
DELETE: llamada de ejemplo mediante curl
curl -X DELETE https://api.appnexus.com/prebid/config/{prebidSettingsId}
DELETE: respuesta
Si se ejecuta correctamente, la configuración indicada 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.
Temas relacionados
- Servicio objetos de campaña de PSP
- Servicio de esquema de asociados de demanda
- Demand Partner Service
- Servicio Prebid Demand Partner Params
- Servicio de tamaños de anuncios
- Servicio de tipo multimedia
- Servicio de configuración entre asociados
- Creación de una nueva configuración de PSP
- Prebid Server Premium Demand Partner Integrations
- Problemas comunes y procedimientos recomendados