Leer en inglés

Compartir a través de


API de plataforma digital: servicio de región

El servicio de región de solo lectura permite ver información sobre las regiones y los estados registrados en el sistema Xandr, incluido el país al que pertenece cada región o estado. Puede usar este servicio para recuperar identificadores de región para dirigirse a campañas (consulte region_targets el servicio de perfil).

API de REST

Http (método) Endpoint Description
GET https://api.appnexus.com/region Ver todas las regiones.
GET https://api.appnexus.com/region?id=ID Ver una región específica por identificador.
GET https://api.appnexus.com/region?name=NAME Vea una región específica por NAME.
GET https://api.appnexus.com/region?code=CODE Vea una región específica por CODE.
GET https://api.appnexus.com/region/meta Averigüe por qué campos puede filtrar y ordenar.

Campos JSON

Campo Tipo Descripción
active Booleano Si truees , la región está disponible para la selección de destino. Si falsees , no hay datos de geolocalización para la región, por lo que no es posible la entrega.

Nota: En ocasiones, las regiones pueden convertirse o inactive basarse active en cambios en el direccionamiento IP o cambios en las tecnologías de geolocalización, así como en función de los cambios en los bordes geográficos.
code string Obsoleto.
country_code enumeración Código ISO del país al que pertenece la región. Puede usar country service para recuperar una lista completa de códigos de país.
country_id Entero Identificador del país al que pertenece la región.
country_name string Nombre del país al que pertenece la región. Puede usar country service para recuperar una lista completa de nombres de país.
id Entero Identificador de la región.
iso_3166_2 string Código ISO 3166-2 para la región.
name string Nombre de la región.
sales_tax_rate_pct float Impuestos a las ventas para miembros de la región que actúan como comprador.

Ejemplos

Ver todas las regiones de Alemania

$ curl -b cookies -c cookies 'https://api.appnexus.com/region?country_code=DE'
{
    "response": {
        "status": "OK",
        "count": 16,
        "start_element": null,
        "num_elements": null,
        "regions": [
            {
                "id": 825,
                "name": "Baden-Wurttemberg",
                "code": "01",
                "iso_3166_2": "BW",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 826,
                "name": "Bayern",
                "code": "02",
                "iso_3166_2": "BY",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 827,
                "name": "Bremen",
                "code": "03",
                "iso_3166_2": "HB",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 828,
                "name": "Hamburg",
                "code": "04",
                "iso_3166_2": "HH",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 829,
                "name": "Hessen",
                "code": "05",
                "iso_3166_2": "HE",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 830,
                "name": "Niedersachsen",
                "code": "06",
                "iso_3166_2": "NI",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 831,
                "name": "Nordrhein-Westfalen",
                "code": "07",
                "iso_3166_2": "NW",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 832,
                "name": "Rheinland-Pfalz",
                "code": "08",
                "iso_3166_2": "RP",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 833,
                "name": "Saarland",
                "code": "09",
                "iso_3166_2": "SL",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 834,
                "name": "Schleswig-Holstein",
                "code": "10",
                "iso_3166_2": "SH",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 835,
                "name": "Brandenburg",
                "code": "11",
                "iso_3166_2": "BR",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 836,
                "name": "Mecklenburg-Vorpommern",
                "code": "12",
                "iso_3166_2": "MV",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 837,
                "name": "Sachsen",
                "code": "13",
                "iso_3166_2": "SN",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 838,
                "name": "Sachsen-Anhalt",
                "code": "14",
                "iso_3166_2": "ST",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 839,
                "name": "Thuringen",
                "code": "15",
                "iso_3166_2": "TH",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 840,
                "name": "Berlin",
                "code": "16",
                "iso_3166_2": "BE",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            }
        ]
    }
}

Ver todas las regiones de Alemania y Francia

$ curl -b cookies -c cookies 'https://api.appnexus.com/region?country_code=DE,FR'
{
    "response": {
        "status": "OK",
        "count": 38,
        "start_element": 0,
        "num_elements": 100,
        "regions": [
            {
                "id": 825,
                "name": "Baden-Wurttemberg",
                "code": "01",
                "iso_3166_2": "BW",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 826,
                "name": "Bayern",
                "code": "02",
                "iso_3166_2": "BY",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 827,
                "name": "Bremen",
                "code": "03",
                "iso_3166_2": "HB",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            {
                "id": 828,
                "name": "Hamburg",
                "code": "04",
                "iso_3166_2": "HH",
                "country_id": 59,
                "country_name": "Germany",
                "country_code": "DE",
                "active": true
            },
            ...
            {
                "id": 1070,
                "name": "Aquitaine",
                "code": "97",
                "iso_3166_2": "B",
                "country_id": 78,
                "country_name": "France",
                "country_code": "FR",
                "active": true
            },
            {
                "id": 1071,
                "name": "Auvergne",
                "code": "98",
                "iso_3166_2": "C",
                "country_id": 78,
                "country_name": "France",
                "country_code": "FR",
                "active": true
            },
            {
                "id": 1072,
                "name": "Basse-Normandie",
                "code": "99",
                "iso_3166_2": "P",
                "country_id": 78,
                "country_name": "France",
                "country_code": "FR",
                "active": true
            },
            ...
        ]
    }
}

Ver todas las regiones que contienen "California" en sus nombres

$ curl -b cookies -c cookies 'https://api.appnexus.com/region?like_name=California'
{
    "response": {
        "status": "OK",
        "count": 3,
        "start_element": 0,
        "num_elements": 100,
        "regions": [
            {
                "id": 2600,
                "name": "Baja California",
                "code": "02",
                "iso_3166_2": "BCN",
                "country_id": 159,
                "country_name": "Mexico",
                "country_code": "MX",
                "active": true
            },
            {
                "id": 2601,
                "name": "Baja California Sur",
                "code": "03",
                "iso_3166_2": "BCS",
                "country_id": 159,
                "country_name": "Mexico",
                "country_code": "MX",
                "active": true
            },
            {
                "id": 3922,
                "name": "California",
                "code": "CA",
                "iso_3166_2": "CA",
                "country_id": 233,
                "country_name": "United States",
                "country_code": "US",
                "active": true
            }
        ]
    }
}