Compartir a través de

Servicio de configuración

  • Artículo

El servicio de configuración permite la recuperación, creación y edición de configuraciones de Prebid Server Premium (PSP). Las configuraciones de PSP son objetos que asignan el inventario monetizar a asociados de demanda, lo que permite a los asociados identificar el inventario en las solicitudes de puja. Cada configuración incluye una matriz de parámetros de asociados de demanda adjuntos que especifican los valores que recibirán los asociados. Tenga en cuenta que los asociados deben agregarse primero a nivel global a través del servicio de asociados de demanda. 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.
media_types objeto Los tipos de medios asociados a las configuraciones. Para ver los elementos contenidos en un objeto media_types, consulte la tabla de propiedades de tipos multimedia que se muestra a continuació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:
- 1 colocación
- 2 grupo o sitio de selección de ubicación
- 3 editor
- 4 perfil de elemento de línea o destino
targeting_id integer Identificador del objeto con el que está asociada la configuración (por ejemplo, elemento de línea, ubicación, grupo de selección de ubicación, publicador). Las solicitudes se enviarán a los asociados de demanda cuando la solicitud de puja especifique el mismo objeto o coincida con la segmentación del elemento de línea o perfil. Si se usa un identificador de elemento de línea, debe ser un elemento de línea de subtipo "psp" asociado a un perfil. Al crear configuraciones en la interfaz de usuario de PSP, estos objetos se crean y vinculan automáticamente.
targeting_level_name string Nombre del nivel (por ejemplo: publisher).
targeting_metadata objeto 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 . Cuando es targeting_id un identificador de elemento de línea, targeting_metadata.priority es necesario.

Tipos de medios

El objeto de tipo multimedia determina qué formatos (actualmente banner, nativo y vídeo) y tamaños de anuncio se incluyen en las solicitudes para exigir asociados.

Propiedad Tipo Descripción
sizes objeto Los asociados de demanda solo recibirán solicitudes para esta configuración donde estén presentes estos tamaños de anuncio.
sizes.width integer Ancho de la unidad. Por ejemplo, 300.
sizes.height integer Alto de la unidad. Por ejemplo, 250.
sizes.is_standard booleano Indica si el miembro ha definido el tamaño como estándar.
types matriz Incluye los tipos de medios aptos para la configuración. Solo estos tipos se pasarán a los asociados de demanda en las solicitudes. Los valores son banner, native, video.

Propiedades de metadatos de destino

Propiedad Tipo Descripción
os_family_ids matriz Los asociados de demanda solo recibirán solicitudes para esta configuración donde estén presentes estos sistemas operativos. Sistemas operativos representados por identificadores enteros del servicio de System-Families operativo.
priority integer La clasificación de la configuración solo se usa cuando está asociada a un elemento de línea. Esta clasificación indica a Monetizar qué configuración usar cuando la selección de destino de varios elementos de línea es apta para la misma solicitud de puja. La escala oscila entre 1 y 20, siendo 20 la más alta. Esta clasificación es necesaria cuando targeting_id es un identificador de elemento de línea y no se aplica a las configuraciones de ubicación, grupo de selección de ubicación o publicador. Cuando varias configuraciones de elementos de línea tienen la misma prioridad, la configuración con el identificador más alto (más reciente) se usará en la subasta.

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": 1,
      "targeting_id": 25172737,
      "enabled": 1,
      "media_types": {
        "sizes": [],
        "types": [
          "video"
        ]
      },
      "targeting_metadata": {
        "os_family_ids": []
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-17T18:17:56.000Z",
      "targeting_level_name": "placement",
      "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": 1,
      "targeting_id": 25175861,
      "enabled": 1,
      "media_types": {
        "sizes": [],
        "types": [
          "banner",
          "video",
          "native"
        ]
      },
      "targeting_metadata": {
        "os_family_ids": []
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-31T21:34:34.000Z",
      "targeting_level_name": "placement",
      "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.

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.
media_types objeto Obligatorio El media_types asociado a la configuración. Para ver los elementos contenidos en un media_type objeto, consulte la tabla de propiedades de tipo multimedia siguiente.
name string Obligatorio Nombre de la configuración.
targeting_id integer Obligatorio Identificador del objeto con el que está asociada la configuración (por ejemplo, elemento de línea, ubicación, grupo de selección de ubicación, publicador). Las solicitudes se enviarán a los asociados de demanda cuando la solicitud de puja especifique el mismo objeto o coincida con la segmentación del elemento de línea o perfil. Si se usa un identificador de elemento de línea, debe ser un elemento de línea de subtipo "psp" asociado a un perfil. Al crear configuraciones en la interfaz de usuario de PSP, estos objetos se crean y vinculan automáticamente.
targeting_level_code integer Obligatorio Tipo de objeto asociado a la configuración:
- 1 colocación
- 2 grupo o sitio de selección de ubicación
- 3 editor
- 4 perfil de elemento de línea o destino
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 objeto targeting_metadata. Cuando es targeting_id un identificador de elemento de línea, 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: tipos de medios

El objeto de tipo multimedia determina qué formatos (actualmente banner, nativo y vídeo) y tamaños de anuncio se incluyen en las solicitudes para exigir asociados.

Propiedad Tipo Ámbito Descripción
sizes objeto Opcional Los asociados de demanda solo recibirán solicitudes para esta configuración donde estén presentes estos tamaños de anuncio.
sizes.width integer Opcional Ancho de la unidad. Por ejemplo, 300.
sizes.height integer Opcional Alto de la unidad. Por ejemplo, 250.
sizes.is_standard booleano Opcional Indica si el miembro ha definido el tamaño como estándar.
types matriz Obligatorio Incluye los tipos de medios aptos para la configuración. Solo estos tipos se pasarán a los asociados de demanda en las solicitudes. Los valores son banner, native, video.

POST: propiedades de metadatos de destino

Propiedad Tipo Ámbito Descripción
os_family_ids matriz Opcional Los asociados de demanda solo recibirán solicitudes para esta configuración donde estén presentes estos sistemas operativos. Sistemas operativos representados por identificadores enteros del servicio de System-Families operativo.
priority integer Opcional La clasificación de la configuración solo se usa cuando está asociada a un elemento de línea. Esta clasificación indica a Monetizar qué configuración usar cuando la selección de destino de varios elementos de línea es apta para la misma solicitud de puja. La escala oscila entre 1 y 20, siendo 20 la más alta. Esta clasificación es necesaria cuando el targeting_id es un identificador de elemento de línea y no se aplica a las configuraciones de ubicación, grupo de selección de ubicación o publicador. Cuando varias configuraciones de elementos de línea tienen la misma prioridad, la configuración con el identificador más alto (más reciente) se usará en la subasta.

Solicitud JSON de ejemplo

{
    "name": "ConfigName1",
    "targeting_level_code": 4,
    "targeting_id": 25401118,
    "enabled": true,
    "media_types": {
        "sizes": [
            {
                "height": 300,
                "width": 250
            }
        ],
        "types": [
            "banner",
            "video",
            "native"
        ]
    },
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "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,
    "media_types": {
      "sizes": [
        {
          "height": 300,
          "width": 250
        }
      ],
      "types": [
        "banner",
        "native",
        "video"
      ]
    },
    "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.

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_level_code": 4,
    "targeting_id": 22378872,
    "enabled": 0,
    "media_types": {
        "sizes": [
            {
                "height": 300,
                "width": 250
            }
        ],
        "types": [
            "banner",
            "native",
            "video"
        ]
    },
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "id": 1718542,
            "member_id": 13859,
            "prebid_settings_id": 196038,
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            },
            "enabled": 1
        }
    ]
}

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.

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,
        "media_types": {
            "types": [
                "banner"
            ]
        }
    }
}

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.