Compartir a través de

Servicio de clave de destino

  • Artículo

El servicio de clave de destino funciona junto con el servicio targeting-value para permitirle definir sus propias combinaciones de clave/valor para su uso en la selección de destino en elementos de línea, campañas, etc. Consulte Custom Key Value Targeting (Destino de valor de clave personalizada ) para obtener más información.

API de REST

Http (método) Endpoint Description
POST https://api.appnexus.com/targeting-key
(create_target_key JSON)		 Agregue una nueva clave de destino.
PUT https://api.appnexus.com/targeting-key?id=TARGETING_KEY_ID
(update_targeting_key JSON)		 Modificar una clave de destino.
GET https://api.appnexus.com/targeting-key Ver todas las claves de destino.
GET https://api.appnexus.com/targeting-key?id=TARGETING_KEY_ID Ver una clave de destino específica.
GET https://api.appnexus.com/targeting-key?name=TARGETING_KEY_NAME1,TARGETING_KEY_NAME2,TARGETING_KEY_NAME3 Vea un conjunto de claves de destino por nombre.
DELETE https://api.appnexus.com/targeting-key?id=TARGETING_KEY_ID Elimine una clave de destino.

Campos JSON

General

Campo Tipo (longitud) Description
id Entero Identificador de la clave de destino.

Valor predeterminado: número generado automáticamente
Obligatorio activado: PUT/ DELETE, en la cadena de consulta
type enumeración Tipo de datos de la clave y sus valores asociados. Debe ser uno de los siguientes valores:
- string
- numeric
Obligatorio activado: POST
name string Nombre de la clave de destino.
El valor debe ser una palabra, sin espacios. Este nombre debe ser único dentro de su miembro.

Obligatorio activado: POST
label string Etiqueta de la clave que se va a usar para la generación de informes. Este valor no es necesario, pero si incluye un valor, debe ser único dentro de su miembro. La etiqueta puede tener un máximo de 190 caracteres.
state enumeración Estado de la clave de destino. Valores posibles: active y inactive.

Valor predeterminado: active
created_on date Solo lectura. Fecha y hora en que se creó la clave de destino.
last_modified date Solo lectura. Fecha y hora en que se modificó por última vez la clave de destino.

Requisitos clave

Número de claves

  • Puede tener hasta 500 claves activas a la vez.
  • Puede tener hasta 100 000 valores por clave.
  • Puede tener hasta 2500 000 valores activos totales a la vez.

Nomenclatura de claves

  • Los nombres de clave no distinguen mayúsculas de minúsculas.
  • La longitud máxima del nombre de clave es de 50 caracteres.
  • Los nombres de clave deben ser una palabra, sin espacios en blanco.
  • Los nombres de clave no pueden contener ninguno de los siguientes caracteres especiales:
    • " (comillas dobles)
    • ' (apóstrofo)
    • = (signo igual)
    • ! (signo de exclamación)
    • + (signo más)
    • # (hashtag)
    • * (asterisco)
    • ~ (tilde)
    • ; (punto y coma)
    • ^ (símbolo de intercalación)
    • () (paréntesis)
    • <> (corchetes angulares)
    • [ ] (corchetes)
    • , (coma)
    • & (y)
    • @ (at)
    • : (dos puntos)
    • ? (signo de interrogación)
    • % (signo porcentual)
    • / (barra diagonal)

Ejemplos

Visualización de todas las claves de destino

$ curl -b cookies 'https://api.appnexus.com/targeting-key'

{
    "targeting-keys": [
        {
            "id": 7,
            "type": "string",
            "name": "key1",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 11,
            "type": "string",
            "name": "testkey",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-26 06:30:37"
        },
        {
            "id": 12,
            "type": "string",
            "name": "testkey3",
            "label": "This is a test",
            "state": "active",
            "created_on": "2016-08-26 08:04:42",
            "last_modified": "2016-08-26 08:15:02"
        }
    ]...
}

Visualización de una clave de destino específica

$ curl -b cookies 'https://api.appnexus.com/targeting-key?id=12'
 
{
    "targeting-key": {
        "id": 12,
        "type": "string",
        "name": "testkey3",
        "label": "This is a test",
        "state": "active",
        "created_on": "2016-08-26 08:04:42",
        "last_modified": "2016-08-26 08:15:02"
    }...
}

Adición de una clave de destino

$ cat create_targeting_key.json
{
    "targeting-key": {
        "name": "testkey4",
        "type": "string"
    } 
}
 
$ curl -b cookies -H "Content-Type:application/json" -X POST -d '@create_targeting_key.json' 'https://api.appnexus.com/targeting-key'

Modificación de una clave de destino

$ cat update_targeting_key.json
{
    "targeting-key": {
        "name": "newtestkey3",
        "label": "This is a test"
    } 
}
 
$ curl -b cookies -H "Content-Type:application/json" -X PUT -d @update_target_key.json 'https://api.appnexus.com/targeting-key?id=12'

Filtrar las claves de destino por nombre

$ curl -b cookies 'https://api.appnexus.com/targeting-key?name=key1,key2'

{
    "targeting-keys": [
        {
            "id": 7,
            "type": "string",
            "name": "key1",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 8,
            "type": "string",
            "name": "key2",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-26 06:30:37"
        }
    ]...
}

Búsqueda dentro de un nombre o etiqueta

En este ejemplo se busca la cadena "car" en cualquier lugar dentro de los name campos o label .

$ curl -b cookies 'https://api.appnexus.com/targeting-key?search=car'

{
    "targeting-keys": [
        {
            "id": 1,
            "type": "string",
            "name": "bluecar",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 2,
            "type": "string",
            "name": "key5",
            "label": "Scary values",
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 3,
            "type": "string",
            "name": "car",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-26 06:30:37"
        }
    ]...
}

Ordenar por fecha de última modificación

Puede ordenar los resultados por id, , namelabel, created_ono last_modified. Puede ordenar en orden ascendente (asc) o descendente (desc).

$ curl -b cookies 'https://api.appnexus.com/targeting-key?sort=last_modified.asc'

{
    "targeting-keys": [
        {
            "id": 7,
            "type": "string",
            "name": "key1",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:29:29",
            "last_modified": "2016-08-26 06:29:29"
        },
        {
            "id": 10,
            "type": "string",
            "name": "akey",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 04:45:07",
            "last_modified": "2016-08-26 12:52:29"
        },
        {
            "id": 8,
            "type": "string",
            "name": "key2",
            "label": null,
            "state": "active",
            "created_on": "2016-08-26 06:30:37",
            "last_modified": "2016-08-30 10:34:37"
        }
    ]...
}

Eliminación de una clave de destino

Al eliminar una clave de destino, se eliminarán automáticamente todos los valores de esa clave.

$ curl -b cookies -X DELETE 'https://api.appnexus.com/targeting-key?id=12'