Servicio de búsqueda

Artículo
05/18/2024

Este servicio de solo lectura permite recuperar el identificador, el nombre, el código, el estado y, en algunos casos, las descripciones de los siguientes tipos de objetos de la cuenta. También devuelve información jerárquica sobre estos objetos, por ejemplo, el identificador del publicador para una ubicación o el identificador de anunciante de un elemento de línea. En los casos en los que tiene información limitada sobre los objetos, este servicio le ofrece una manera sencilla de asignar a otros datos pertinentes. Fuentes de informes masivas, por ejemplo, devuelve datos agrupados por identificadores de objeto. Puede usar el servicio de búsqueda para hacer coincidir estos identificadores con nombres, códigos, etc.

Anunciantes
Pedidos de inserción
Elementos de línea
Campañas
Creativos
Píxeles de segmento
Píxeles de conversión
Editores
Reglas de pago
Sitios
Colocaciones
Etiquetas

Nota:

El servicio de búsqueda es diferente del servicio de búsqueda porque devuelve todos los objetos de un tipo determinado de la cuenta. El servicio de búsqueda permite buscar objetos con un nombre, código o identificador específicos.
El servicio lookup puede devolver un máximo de 50 000 objetos.
El servicio de búsqueda se basa en los datos que se almacenan en caché y se actualizan una vez cada 8 minutos.

API de REST

Método	Endpoint	Description
`GET`	https://api.appnexus.com/lookup	Ver información sobre todos los objetos del sistema.
`GET`	https://api.appnexus.com/lookup?type=OBJECT_TYPE	Ver información sobre todos los objetos de un tipo específico. Nota: Puede obtener información sobre los siguientes tipos de objeto: `advertiser`, `insertion_order`, , `line_item`, `budget_splittercampaign`, `creative`, `segment_pixel`, `conversion_pixel`, `publisher`, `payment_rule`, , `placement`, `site`y `label`.
`GET`	https://api.appnexus.com/lookup?advertiser_id=ADVERTISER_ID	Ver información sobre todos los objetos que pertenecen a un anunciante específico.

Campos JSON

Campos devueltos para todos los tipos de objeto:

Campo	Tipo	Descripción
`code`	string	Código personalizado para el objeto (no aplicable a todos los tipos de objeto).
`id`	Entero	Identificador interno asociado al objeto .
`last_modified`	Timestamp	Fecha y hora en que se modificó por última vez el objeto.
`name`	string	Nombre del objeto.
`state`	enumeración	Estado del objeto. Valores posibles: `"active"` o `"inactive"`.

Campos JSON específicos del objeto

Campos adicionales devueltos para tipos de objeto específicos.

Anunciante

Campo	Tipo	Description
`member_id`	Entero	Id. del miembro al que pertenece el anunciante.

Orden de inserción

Campo	Tipo	Description
`advertiser_id`	Entero	Identificador del anunciante al que pertenece el pedido de inserción.

Elemento de línea

Campo	Tipo	Description
`advertiser_id`	Entero	Identificador del anunciante al que pertenece el elemento de línea.

Campaña

Campo	Tipo	Description
`line_item_id`	Entero	Identificador del elemento de línea al que pertenece la campaña.

Divisor de presupuesto

Campo	Tipo	Description
`line_item_id`	Entero	Identificador del elemento de línea al que pertenecen las divisiones presupuestarias.
`name`	string	Nombre de la división de presupuesto.
`id`	Entero	Identificador de la división de presupuesto.
`state`	string	Estado de la división presupuestaria. Los valores permitidos son: - `active` - `inactive`
`last_modified`	date	Marca de tiempo cuando se modificó por última vez la división.

Creatividad

Campo	Tipo	Description
`advertiser_id`	Entero	Id. del anunciante al que pertenece la creatividad.
`brand_id`	Entero	Identificador de la marca asociada a la creatividad.
`description`	string	Descripción de la creatividad.
`landing_page_url`	string	Dirección URL de la página de aterrizaje asociada a esta creatividad.
`publisher_id`	Entero	Identificador del publicador al que está asociada la creatividad.

Píxel de segmento

Campo	Tipo	Description
`advertiser_id`	Entero	Identificador del anunciante al que está asociado el píxel del segmento.
`member_id`	Entero	Identificador del miembro al que pertenece el píxel de segmento.

Píxel de conversión

Campo	Tipo	Description
`advertiser_id`	Entero	Identificador del anunciante al que pertenece el píxel de conversión.

Publisher

Campo	Tipo	Description
`member_id`	Entero	Identificador del miembro al que pertenece el publicador.

Regla de pago

Campo	Tipo	Descripción
`description`	string	Descripción de la regla de pago.
`publisher_id`	Entero	Identificador del publicador al que pertenece la regla de pago.

Ubicación

Campo	Tipo	Description
`publisher_id`	Entero	Identificador del publicador al que pertenece la ubicación.

Site

Campo	Tipo	Description
`publisher_id`	Entero	Identificador del publicador al que pertenece el sitio.

Etiqueta

Campo	Tipo	Description
`label_id`	Entero	Identificador de la etiqueta.
`member_id`	Entero	Identificador del miembro al que pertenece la etiqueta.
`object_id`	Entero	Identificador del objeto al que se puede aplicar la etiqueta.
`object_type`	enumeración	Tipo de objeto al que se puede aplicar la etiqueta. Valores posibles: `"advertiser"`, `"insertion_order"`, `"line_item"`, `"campaign"`o `"publisher"`.
`value`	string	Texto de la etiqueta.

Ejemplos

Busca todas tus campañas

$ curl -b cookies -c cookies 'https://api.appnexus.com/lookup?type=campaign'
{
    "response": {
        "status": "OK",
        "num_elements": 2,
        "start_element": 0,
        "results": {
            "campaign": {
                "results": [
                    {
                        "id": "58990",
                        "name": "Car Donations",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "cdon",
                        "last_modified": "2011-10-18 17:25:00"
                    },
                    {
                        "id": "58991",
                        "name": "Bucket Builders",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "bb",
                        "last_modified": "2011-10-12 22:08:04"
                    }
                ],
                "num_elements": "2"
            }
        }
    }
}

Buscar todos los objetos accesibles para este servicio

$ curl -b cookies -c cookies 'https://api.appnexus.com/lookup'
{
    "response": {
        "status": "OK",
        "num_elements": 24,
        "start_element": 0,
        "results": {
            "advertiser": {
                "results": [
                    {
                        "id": "35081",
                        "name": "Bucketeer",
                        "code": "bucket",
                        "member_id": "1066",
                        "state": "active",
                        "last_modified": "2011-10-18 17:25:00"
                    }
                ],
                "num_elements": "1"
            },
            "insertion_order": {
                "results": null,
                "num_elements": 0
            },
            "line_item": {
                "results": [
                    {
                        "id": "31189",
                        "name": "bucket line 1",
                        "code": "bk1",
                        "advertiser_id": "35081",
                        "state": "active",
                        "last_modified": "2011-10-18 17:25:00"
                    }
                ],
                "num_elements": "1"
            },
            "campaign": {
                "results": [
                    {
                        "id": "58990",
                        "name": "Car Donations",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "cdon",
                        "last_modified": "2011-10-18 17:25:00"
                    },
                    {
                        "id": "58991",
                        "name": "Bucket Builders",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "bb",
                        "last_modified": "2011-10-17 13:24:00"
                    }
                ],
                "num_elements": "2"
            },
            "budget_splitter":{
               "results": [
                   {
                         "line_item_id": 1,
                         "name": "Split 1",
                         "id": 1,
                         "state": "active",
                         "last_modified": "2023-04-18 17:25:00"
                    },
                    {
                    "line_item_id": 1,
                    "name": "Split 2",
                    "id": 2,
                    "state": "active",
                    "last_modified": "2023-04-19 17:25:00"
                    },
                ],
                "num_elements": "2"
            },
            "creative": {
                "results": [
                    {
                        "id": "445832",
                        "code": null,
                        "description": "Donate car.png",
                        "advertiser_id": "35081",
                        "publisher_id": "0",
                        "state": "active",
                        "brand_id": 1,
                        "landing_page_url": "www.cardonations.com/donate",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "445833",
                        "code": null,
                        "description": "bucketbuilders.png",
                        "advertiser_id": "35081",
                        "publisher_id": "0",
                        "state": "active",
                        "brand_id": 3,
                        "landing_page_url": "www.buckets.com/build",
                        "last_modified": "2011-10-17 13:24:00"
                    }
                ],
                "num_elements": "2"
            },
            "segment_pixel": {
                "results": null,
                "num_elements": 0
            },
            "payment_rule": {
                "results": [
                    {
                        "id": "91345",
                        "name": "",
                        "publisher_id": "89286",
                        "state": "active",
                        "description": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "91346",
                        "name": "Default",
                        "publisher_id": "89287",
                        "state": "active",
                        "description": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "91375",
                        "name": "Base Payment Rule",
                        "publisher_id": "89314",
                        "state": "active",
                        "description": "",
                        "last_modified": "2011-10-17 13:24:00"
                    }
                ],
                "num_elements": "3"
            },
            "conversion_pixel": {
                "results": null,
                "num_elements": 0
            },
            "publisher": {
                "results": [
                    {
                        "id": "89286",
                        "name": "Default Real Time",
                        "member_id": "1066",
                        "state": "inactive",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "89287",
                        "name": "Wide Road",
                        "member_id": "1066",
                        "state": "active",
                        "code": "bb",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "89314",
                        "name": "Radio Live",
                        "member_id": "1066",
                        "state": "active",
                        "code": "rlive",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    ...
                ],
                "num_elements": "5"
            },
            "placement": {
                "results": [
                    {
                        "id": "594594",
                        "name": "[Default Real Time] - Default",
                        "publisher_id": "89286",
                        "state": "active",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "594595",
                        "name": "[Wide Road] - Placement 1",
                        "publisher_id": "89287",
                        "state": "active",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "594641",
                        "name": "[Radio Live] - Default",
                        "publisher_id": "89314",
                        "state": "active",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    ...
                ],
                "num_elements": "5"
            },
            "site": {
                "results": [
                    {
                        "id": "188039",
                        "code": "",
                        "name": "[Default Real Time] - ROS",
                        "publisher_id": "89286",
                        "state": "active",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "188040",
                        "code": "",
                        "name": "[Wide Road] - ROS",
                        "publisher_id": "89287",
                        "state": "active",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "188070",
                        "code": "",
                        "name": "[Radio Live] - ROS",
                        "publisher_id": "89314",
                        "state": "active",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    ...
                ],
                "num_elements": "5"
            },
        }
    }
}

Compartir a través de