Servicio de parámetros de partner de demanda de Prebid

El servicio Prebid Demand Partner Params permite a los usuarios ver, agregar, eliminar, habilitar y deshabilitar socios específicos en configuraciones de PSP. Las configuraciones se administran mediante el servicio de configuración. Un partner de demanda debe estar habilitado en el servicio de configuración entre partners para poder añadirlo a cualquier configuración del servicio de parámetros y antes de que pueda recibir solicitudes de pujas a través de Prebid Server Premium (PSP). Si intentas agregar un socio que no está presente en la configuración entre socios, se producirá un error.

Nota:

Aunque se puede deshabilitar un partner a través de este servicio en el nivel de configuración, cualquier cambio futuro que se realice en el partner en el servicio de configuración entre partners invalidará las configuraciones individuales y habilitará o deshabilitará al partner en todas las configuraciones. Puede encontrar detalles sobre los parámetros admitidos por cada asociado en el servicio de esquema de asociado de demanda.

API de REST

Método HTTP Endpoint Description
GET - https://api.appnexus.com/prebid/prebid-demand-partner-params?prebid_settings_id={prebid_settings_id} Obtenga todos los parámetros de partner de demanda de Prebid para una configuración de Prebid específica.
GET https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} Obtenga un parámetro de partner de demanda de Prebid específico. Incluya el param ID como último componente de ruta de acceso URL.
POST https://api.appnexus.com/prebid/prebid-demand-partner-params Cree nuevos parámetros de partners de demanda. Para ver un ejemplo de cURL y una respuesta, consulte la POST sección siguiente.
PUT https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} Actualizar un parámetro de partner de demanda de Prebid específico. Inclúyalo param ID como último componente de la ruta de acceso URL.
DELETE https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} Eliminar un parámetro de partner de demanda de Prebid específico. Incluya el param ID como último componente de ruta de acceso URL.

GET

Devuelve todos los parámetros de los partners de demanda, o un conjunto específico, dentro de una configuración de PSP. Incluya la prebid_settings_id (configuración) o el identificador de los parámetros como último componente de la dirección URL.

Ejemplo de llamada que usa cURL para devolver un parámetro específico


curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId}

Ejemplo de llamada que usa cURL para devolver todos los parámetros de una configuración específica


curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/prebid-demand-partner-params?prebid_settings_id={prebid_settings_id}

Respuesta

Una respuesta correcta devolverá todos los parámetros de la configuración de Prebid solicitada o de un parámetro solicitado específico.

Propiedad Tipo Descripción
deleted integer Indica si se ha eliminado el objeto Params de este asociado. Los valores permitidos son:
0 = activo,
1 = eliminado
enabled integer Indica si el asociado de demanda está habilitado o deshabilitado a través del servicio de asociado de demanda. Los valores permitidos son:
1 = habilitada,
0 = deshabilitado
id integer El identificador único para el conjunto de parámetros asociados con el asociado de demanda en la configuración de PSP.
last_modified string La fecha de modificación más reciente de los parámetros de configuración del asociado de demanda.
last_modified_by string La persona que realizó las últimas modificaciones en los parámetros de los socios de demanda.
member_id integer El identificador de miembro de la persona que llama.
name objeto El nombre del asociado de demanda.
params objeto Objeto que contiene los parámetros admitidos por el asociado y los valores asignados. Los parámetros admitidos se pueden encontrar aquí.
prebid_settings_id integer El identificador único de la configuración de PSP.

Ejemplo de respuesta

[
  {
    "id": 1718542,
    "member_id": 13859,
    "prebid_settings_id": 196038,
    "name": "appnexus",
    "params": {
      "placement_id": 123456
    },
    "enabled": 0,
    "deleted": 0,
    "last_modified_by": "user123",
    "last_modified": "2024-08-22T21:45:05.000Z"
  }
]

POST

Permite la creación de un nuevo objeto Prebid Demand Partner Param.

El 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.

Ejemplo de llamada con cURL

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

Ejemplo de solicitud JSON

{
    "prebid_settings_id": 196038,
    "member_id": 13859,
    "name": "adform",
    "params": {
        "inv": null,
        "mid": "11111111",
        "mname": null,
        "priceType": null
    }
}

Parameters

Nombre Tipo Ámbito Descripción
name string Obligatorio El nombre del asociado de demanda de Prebid.
member_id integer Obligatorio El identificador del miembro asociado a la configuración.
params objeto Obligatorio Objeto que contiene los parámetros admitidos por el asociado y los valores asignados. Los parámetros admitidos se pueden encontrar aquí.
prebid_settings_id integer Obligatorio El identificador único para la configuración de PSP.

POST: Respuesta de ejemplo

[
  {
    "id": 1718543,
    "member_id": 13859,
    "prebid_settings_id": 196038,
    "name": "adform",
    "params": {
      "inv": null,
      "mid": "11111111",
      "mname": null,
      "priceType": null
    },
    "enabled": 1,
    "deleted": 0,
    "last_modified_by": "user123",
    "last_modified": "2024-08-22T22:40:21.000Z"
  }
]

PUT

Sobrescribe un parámetro de partner de demanda Prebid existente. Inclúyalo prebidDemandPartnerParamId 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 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/prebid-demand-partner-params/{prebidDemandPartnerParamId}

Ejemplo de solicitud JSON

{
    "member_id": 13859,
    "prebid_settings_id": 196038,
    "name": "adform",
    "params": {
        "inv": null,
        "mid": "11111111",
        "mname": null,
        "priceType": null
    }
}

PUT: Respuesta

Devuelve un objeto Param de partner de demanda Prebid.

DELETE

Eliminar un parámetro de partner de demanda de Prebid existente. Incluya el prebidSettingsId como último componente de la ruta de acceso.

DELETE: Ejemplo de llamada con cURL

curl -X DELETE https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId}

DELETE: Respuesta

Si se realiza correctamente, el objeto Param del partner de demanda Prebid se devuelve como un objeto JSON con la propiedad eliminada establecida en 1. Los parámetros del partner de demanda Prebid ya no estarán disponibles en el sistema. También se eliminarán los subobjetos.

  • Last updated on