Servicio de categoría de facturación de segmentos

El servicio categoría de facturación de segmentos le permite asignar los segmentos a la taxonomía de precios de Data Marketplace. Aquí se muestra cómo funciona:

Se crea un registro de asignación para un segmento que se activa en Data Marketplace.
En el registro de asignación, especifique a qué categoría de precios se debe asignar el segmento. Los clientes con los que ha compartido el segmento ahora pueden dirigirse a ese segmento en campañas y Xandr borrará el costo de uso.

Nota:

Este servicio le permite asignar a categorías existentes. Para crear una nueva categoría, póngase en contacto con su representante de Xandr.
Al quitar un segmento de un registro de asignación, el miembro puede seguir usando el segmento en una campaña, pero Xandr dejará de realizar el seguimiento del costo del uso de datos.

API de REST

Http (método)	Endpoint	Description
`GET`	https://api.appnexus.com/data-provider	Vea toda la taxonomía de precios.
`GET`	https://api.appnexus.com/segment-billing-category	Ver todos los registros de asignación.
`POST`	https://api.appnexus.com/segment-billing-category (json de asignación) Nota: Solo se puede asignar un segmento a la vez.	Agregue un registro de asignación.
`PUT`	https://api.appnexus.com/segment-billing-category (json de asignación)	Modificar un registro de asignación.
`DELETE`	https://api.appnexus.com/segment-billing-category?id=RECORD_ID	Elimine un registro de asignación.

Sugerencia

Estructura JSON:

Al agregar o actualizar un registro de asignación, debe estructurar el JSON como un único objeto denominado "segment-billing-category". Para obtener el formato exacto, consulte los ejemplos siguientes.

El servicio Categoría de facturación de segmento funciona tanto en la API de plataforma como en la API del bus de impresiones. Aunque solo api.adnxs.com se usa a continuación, se puede reemplazar por api.appnexus.com para aquellos clientes que tengan acceso a la API de la plataforma. Solo los miembros que estén en tendrán acceso a la API de la plataforma. La mayoría de los proveedores de datos solo pueden acceder a la API del bus de impresiones.

Campos JSON

Campo	Tipo (longitud)	Description	Predeterminada	Obligatorio activado
`id`	Entero	Identificador único creado cuando un identificador de segmento Xandr se asigna a una categoría de facturación. Se puede hacer referencia a él como el identificador de asignación por registro.	Número generado automáticamente	`PUT` (en JSON) `DELETE` (en la cadena de consulta)
`segment_id`	Entero	Identificador de segmento Xandr que se está asignando.		`POST`/`PUT`
`data_provider_id`	Entero	Identificador del proveedor de datos asignado por Data Marketplace. Nota: Se producirá un error en la `POST`/`CALL` llamada si envía un identificador que no pertenece a su cuenta.		`POST`/`PUT`
`data_category_id`	Entero	Identificador de categoría de precios creado en Xandr. Nota: Las `POST`/`PUT` llamadas producirán un error si envía un identificador que no pertenece a su cuenta.		`POST`/`PUT`
`active`	booleano	Estado del registro de asignación. Si se establece en `true`, el registro de asignación está activo.		`POST`
`member_id`	Entero	Solo lectura. Su id. de miembro.
`is_public`	booleano	Valor que marca el segmento como público o privado. Si se establece en `true`, el segmento se comparte inmediatamente con todos los compradores de Data Marketplace.	`false`	`PUT`
`data_segment_type_id`	string	Tipo de segmento. Esto facilita a los compradores la búsqueda de tipos específicos de segmentos. Para los tipos de segmento seguridad de marca y detección de fraudes, asegúrese de que el `recommend_include` campo (vea a continuación) esté establecido en el valor adecuado para el tipo de segmento. Las opciones válidas son: - sin asignar -Audiencia - Seguridad de marca - Detección de fraudes - Capacidad de visualización - Contextual -Geolocalización -B2B -Compra -Interés -Demo - In-Market	unassigned
`recommend_include`	booleano	Determina si un segmento está pensado para la inclusión (`true`) o la exclusión (`false`). De forma predeterminada, se establece en `false` que es una exclusión; se establece en `true` si el segmento está pensado para su inclusión. Asegúrese de que este campo está establecido en el valor adecuado para el tipo de segmento.	`false`

Paginación

Puede paginar los resultados especificando start_element y num_elements en la cadena de consulta de la GET solicitud. Por ejemplo, la siguiente solicitud devolvería 25 elementos a partir del elemento 26:

curl -b cookies -c cookies 'https://api.appnexus.com/segment-billing-category?start_element=26&num_elements=25'

Campo	Tipo	Description
`count`	Entero	Número total de resultados.
`start_element`	Entero	Número de elemento en el que se va a iniciar el conjunto de resultados.
`num_elements`	Entero	Número de elementos que se van a devolver, max = 100, default = 25.

Ejemplos

Visualización de la taxonomía de precios

$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/data-provider'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "dbg_info": {
      "instance": "01.data-clearing-api.prod.nym2",
      "db": "",
      "warnings": [],
      "start_microtime": 1459912197.525,
      "time": 14,
      "version": "",
      "output_term": "data-providers"
    },
    "data-providers": [
      {
        "id": 1,
        "node_name": "Sample Data Provider Name",
        "member_id": 958,
        "data_revshare_pct": 0.01,
        "active": true,
        "data_publishers": [
          {
            "id": 1,
            "node_name": "Sample Data Publisher Name",
            "level_index": 0,
            "data_provider_id": 958,
            "active": true,
            "member_id": 958,
            "data_categories": [
              {
                "id": 1001,
                "node_name": "Sample Data Category Name",
                "level_index": 0,
                "data_publisher_id": 1,
                "data_provider_id": 958,
                "active": true,
                "member_id": 958
              }
            ]
          }
        ]
      }
    ]
  }
}

Create un registro de asignación

$ cat create_segment_mapping
{
        "segment-billing-category": {
                "active": true, 
                "data_provider_id": 958,
                "data_category_id": 1001,
                "segment_id": 111111,
                "is_public": true,
                "data_segment_type_id": "Audience"
        }
}
$ curl -b cookies -c cookies -X POST -d @create_segment_mapping 'https://api.appnexus.com/segment-billing-category?member_id=958'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "segment_billing_categories": [
      {
        "id": 22286,
        "segment_id": 111111,
        "data_provider_id": 958,
        "data_category_id": 1001,
        "active": true,
        "member_id": 958,
                "is_public": true,
                "data_segment_type_id" : "Audience"
      }
    ]
  }
}

Actualización de un registro de asignación

$ cat update_segment_mapping
{
        "segment-billing-category": {
                "id": 22286,
                "active": false,
                "is_public": true,
                "data_provider_id": 958,
        "data_category_id": 1001,
                "data_segment_type_id": "Contextual"
        }
}
$ curl -b cookies -c cookies -X PUT -d @update_segment_mapping 'https://api.appnexus.com/segment-billing-category?member_id=958'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "segment_billing_categories": [
      {
        "id": 22286,
        "segment_id": 111111,
        "data_provider_id": 958,
        "data_category_id": 1001,
        "active": false,
        "member_id": 958,
                "is_public": true,
                "data_segment_type_id": "Contextual"
      }
    ]
  }
}

Eliminación de un registro de asignación

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/segment-billing-category?member_id=958&id=22286'
{
  "response": {
    "status": "OK",
    "count": 0,
    "start_element": 0,
    "num_elements": 0,
    "segment_billing_category": null
  }
}

Ver todos los registros de asignación

$ curl -b cookies -c cookies 'https://api.appnexus.com/segment-billing-category'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "segment_billing_categories": [
      {
        "id": 22286,
        "segment_id": 111111,
        "data_provider_id": 958,
        "data_category_id": 1001,
        "active": true,
        "member_id": 958,
                "is_public": true,
                "data_segment_type_id": "Contextual"
      }
    ]
  }
}

Last updated on 2025-10-22

Compartir a través de