Share via

Creative Custom Request Template Type service

  • Article

Note

Mediation is only available to Microsoft Monetize Ad Server customers.

For context on mediation, see Selling Your Inventory through Mediation.

The Creative Custom Request Template Type Service is a read-only service that lists the specific types of creative custom request templates needed to integrate with various mediation partners. When creating a new custom request template using the Creative Custom Request Template Service, one of the types listed by this service must be specified. Together they describe how to make requests to the mediation partner with the correct query string parameters and creative macros.

For more information, see the Creative Custom Request Template Service.

REST API

HTTP Method Endpoint Description
GET https://api.appnexus.com/creative-custom-request-template-type View all template types.
GET https://api.appnexus.com/creative-custom-request-template-type?id=TEMPLATE_TYPE_ID View an individual template type.
GET https://api.appnexus.com/creative-custom-request-template-type/meta View available fields to filter and sort.

JSON fields

Name Type Description
id int The unique ID of this template type.
Sort by: Yes
Filter by: Yes
name string The internal name of the template type as used by our systems.
Sort by: Yes
Filter by: Yes
display_name string The "print name" of the template type, suitable for a user interface.
Sort by: Yes
Filter by: Yes
last_modified date The date and time at which this template type was last updated.
Sort by: Yes
Filter by: Yes

Examples

View all template types

{code}
$ curl -b cookies 'https://api.appnexus.com/creative-custom-request-template-type'
{
    "response": {
        "status": "OK",
        "count": 5,
        "start_element": 0,
        "num_elements": 100,
        "creative-custom-request-templates-types": [
            {
                "id": 1,
                "name": "none",
                "display_name": "",
                "last_modified": "2013-07-10 14:04:57"
            },
            {
                "id": 2,
                "name": "inmobi",
                "display_name": "InMobi",
                "last_modified": "2013-07-10 14:04:57"
            },
            {
                "id": 3,
                "name": "millenial",
                "display_name": "Millenial Media",
                "last_modified": "2013-07-10 14:04:57"
            },
            {
                "id": 4,
                "name": "mojiva",
                "display_name": "Mojiva",
                "last_modified": "2013-07-10 14:04:57"
            },
            {
                "id": 5,
                "name": "jumptap",
                "display_name": "Jumptap",
                "last_modified": "2013-07-10 14:04:57"
            }
        ],
        "dbg_info": {
            "instance": "29.bm-hbapi.prod.nym1",
            "s1ave_hit": false,
            "db": "master",
            "awesomesauce_cache_used": false,
            "count_cache_used": false,
            "warnings": [],
            "time": 43.544054031372,
            "start_microtime": 1373907586.5736,
            "version": "1.13.53",
            "s1ave_miss": "no_service_index",
            "s1ave_lag": 0,
            "member_last_modified_age": 1373907586
        }
    }
}
{code}

View an individual template type

{code}
$ curl -b cookies https://api.appnexus.com/creative-custom-request-template-type?id=1
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "creative-custom-request-template-type": {
            "id": 1,
            "name": "none",
            "display_name": "",
            "last_modified": "2013-07-10 14:04:57"
        },
        "dbg_info": {
            "instance": "29.bm-hbapi.prod.nym1",
            "s1ave_hit": false,
            "db": "master",
            "awesomesauce_cache_used": false,
            "count_cache_used": false,
            "warnings": [],
            "time": 223.9089012146,
            "start_microtime": 1373908192.0697,
            "version": "1.13.53",
            "s1ave_miss": "no_service_index",
            "s1ave_lag": 0,
            "member_last_modified_age": 1373908192
        }
    }
}
{code}