次の方法で共有

Creative Custom Request パートナー サービス

  • [アーティクル]

注:

仲介は、Microsoft 収益化 Ad Server のお客様のみが利用できます。

仲介に関するコンテキストについては、「 仲介によるインベントリの販売」を参照してください。

仲介パートナー (カスタム要求パートナーとも呼ばれます) は、このサービスを通じて識別および定義できます。 これらのパートナーは、 UI または 仲介ネットワーク サービスを使用して、顧客固有のネットワークに割り当てられます。

各パートナーは、 クリエイティブ カスタム リクエスト テンプレート サービスで定義されているテンプレートにも関連付けられます。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/creative-custom-request-partner すべてのパートナーを表示します。
GET https://api.appnexus.com/creative-custom-request-partner?id=NETWORK_ID 特定のパートナーを表示します。
POST https://api.appnexus.com/creative-custom-request-partner 新しいパートナーを作成します。
PUT https://api.appnexus.com/creative-custom-request-partner?id=NETWORK_ID パートナーを更新します。
DELETE https://api.appnexus.com/creative-custom-request-partner?id=NETWORK_ID パートナーを削除します。

JSON フィールド

フィールド 種類 説明
id int カスタム パートナーの一意の識別番号。
name 文字列 パートナーの名前。
必須:POST
macro_type string パートナーの定義に使用されるマクロの種類を示します。 有効な値は次のとおりです。
- standard: 統合はユーザー定義 のカスタム ネットワーク経由ではなく、標準のクリエイティブ マクロにアクセスして要求を作成できます。 これには、サポートされている SDK 統合を含めることができます。
- customsdk: 統合は、ユーザーが作成した カスタム モバイル ネットワークです。
- customweb: 統合は、ユーザーが作成した カスタム Web ネットワークです。
- customvideo: 統合は、ユーザーが作成した カスタム ビデオ ネットワークです。
デフォルト：standard
必須:POST
member_id int このカスタム クリエイティブ リクエスト パートナーを使用できるユーザーを決定します。 0 の値は、任意のメンバーがこのパートナーと統合できることを示します (つまり、仲介を使用して販売先)。 値が特定の 0 以外のメンバー ID の場合、パートナーはそのメンバーのみが使用できます。
デフォルト：0
last_modified 日付型 読み取り専用です。 このレコードが最後に変更された日付と時刻。
creative_custom_request_templates 配列 この配列には、このカスタム パートナーによって使用されるマクロの詳細が含まれています。 これは、マクロ情報が必要ない場合に null できます。 詳細については、「 Creative Custom Request Template Service」を参照してください。

例

すべてのカスタム パートナーを表示する

{code}$ curl -b cookies -c cookies 'https://api.appnexus.com/creative-custom-request-partner'
{
    "response":{
        "status":"OK",
        "count":19,
        "start_element":0,
        "num_elements":100,
        "creative-custom-request-partners":[
            {
                "id":1,
                "name":"unknown",
                "macro_type":"standard",
                "member_id":null,
                "last_modified":"2014-03-21 21:43:33",
                "creative_custom_request_templates":[
                    {
                        "id":14,
                        "name":null,
                        "type_id":6,
                        "creative_custom_request_partner_id":1,
                        "member_id":0,
                        "hostname":null,
                        "uri":null,
                        "port":80,
                        "is_post":false,
                        "content":"[ { \"tag\":\"#{TAG}\" } ] ",
                        "timeout_ms":0,
                        "is_client":true,
                        "last_modified":"2014-03-18 13:30:44",
                        "macros":[
                            {
                                "id":68,
                                "template_id":14,
                                "code":"TAG",
                                "name":"TAG",
                                "type":"string",
                                "is_required":false,
                                "last_modified":"2014-03-18 13:30:44"
                            }
                        ]
                    },
                    {
                        "id":39,
                        "name":null,
                        "type_id":6,
                        "creative_custom_request_partner_id":1,
                        "member_id":0,
                        "hostname":null,
                        "uri":null,
                        "port":80,
                        "is_post":false,
                        "timeout_ms":0,
                        "is_client":true,
                        "last_modified":"2014-04-29 20:25:04",
                        "macros":null
                    },
                    {
                        "id":40,
                        "name":"Millennial Media Async",
                        "type_id":6,
                        "creative_custom_request_partner_id":1,
                        "member_id":0,
                        "hostname":null,
                        "uri":null,
                        "port":80,
                        "is_post":false,
                        "content":"[ { \"tag\":\"document.write('window.async = true; var cb = function(adFilled) { window.async = false; if (!adFilled) ADNXSMediation.noAd(); setTimeout(function(){ ADNXSMediation.next() }, 0); } ; window.mmAPI.placeAd({ containerElementId: \\\"adContainer\\\", apid: \\\"#{APID} \\\", placementType: \\\"inline\\\", width: ${WIDTH}, height: ${HEIGHT}, allowLocation: #{LOC} }, cb);');\" } ] ",
                        "timeout_ms":0,
                        "is_client":true,
                        "last_modified":"2014-05-27 19:45:45",
                        "macros":[
                            {
                                "id":118,
                                "template_id":40,
                                "code":"APID",
                                "name":"APID",
                                "type":"string",
                                "is_required":true,
                                "last_modified":"2014-05-27 19:45:45"
                            },
                            {
                                "id":119,
                                "template_id":40,
                                "code":"LOC",
                                "name":"Allow Location",
                                "type":"true_false",
                                "is_required":true,
                                "last_modified":"2014-05-27 19:45:45"
                            }
                        ]
                    },
                    {
                        "id":41,
                        "name":"Millennial Media Async",
                        "type_id":6,
                        "creative_custom_request_partner_id":1,
                        "member_id":0,
                        "hostname":null,
                        "uri":null,
                        "port":80,
                        "is_post":false,
                        "content":"[ { \"tag\": \"http:\/\/s3.amazonaws.com\/APN-test\/millennial-web-2.js\", \"vars\":\"var APN={ } ;APN.apid='#{APID} ';APN.w=${WIDTH} ;APN.h=${HEIGHT} ;APN.loc=#{ LOC } ;\", \"width\":${WIDTH}, \"height\":${HEIGHT} } ] ",
                        "timeout_ms":0,
                        "is_client":true,
                        "last_modified":"2014-05-30 13:28:41",
                        "macros":[
                            {
                                "id":120,
                                "template_id":41,
                                "code":"APID",
                                "name":"APID",
                                "type":"string",
                                "is_required":true,
                                "last_modified":"2014-05-27 20:09:25"
                            },
                            {
                                "id":121,
                                "template_id":41,
                                "code":"LOC",
                                "name":"Allow Location",
                                "type":"true_false",
                                "is_required":true,
                                "last_modified":"2014-05-27 20:09:25"
                            }
                        ]
                    },
                    {
                        "id":42,
                        "name":"Millennial Media Async",
                        "type_id":6,
                        "creative_custom_request_partner_id":1,
                        "member_id":0,
                        "hostname":null,
                        "uri":null,
                        "port":80,
                        "is_post":false,
                        "content":"[ { \"tag\": \"document.write(\\\" window.async = true; var cb = function(adFilled) { window.async = false;  if (!adFilled) ADNXSMediation.noAd();  setTimeout(function(){ ADNXSMediation.next() }, 0); } ; window.mmAPI.placeAd({ containerElementId: \\\\\"adContainer\\\\\", apid: \\\\\"#{APID} \\\\\", placementType: \\\\\"inline\\\\\", width: #{WIDTH}, height: #{HEIGHT}, allowLocation: #{LOC} }, cb);\\\");\" } ] ",
                        "timeout_ms":0,
                        "is_client":true,
                        "last_modified":"2014-05-27 21:31:29",
                        "macros":[
                            {
                                "id":122,
                                "template_id":42,
                                "code":"APID",
                                "name":"APID",
                                "type":"string",
                                "is_required":true,
                                "last_modified":"2014-05-27 21:31:29"
                            },
                            {
                                "id":123,
                                "template_id":42,
                                "code":"LOC",
                                "name":"Allow Location",
                                "type":"true_false",
                                "is_required":true,
                                "last_modified":"2014-05-27 21:31:29"
                            }
                        ]
                    }
                ]
            },
            {
                "id":17,
                "name":"inMobi",
                "macro_type":"standard",
                "member_id":null,
                "last_modified":"2014-04-23 22:24:46",
                "creative_custom_request_templates":null
            },
}
{code}

特定のメンバーに関連付けられているカスタム パートナーを表示する

{code}
$ curl -b cookies -c cookies 'https://api.appnexus.com/creative-custom-request-partner?id=17'    
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,
        "num_elements":100,
        "creative-custom-request-partner":{
            "id":17,
            "name":"inMobi",
            "macro_type":"standard",
            "member_id":null,
            "last_modified":"2014-04-23 22:24:46",
            "creative_custom_request_templates":null
        }
    }
}           
}
{code}

カスタム パートナーを作成する

{code}$ cat create-custom-creative-request-partner-service.json
{
    "creative-custom-request-partner": {
        "name": "Fred's Company",
        "macro_type": "standard"
    }
}
$ curl -b cookies -c cookies -X POST -d @custom-creative-request-partner-service.json 'https://api.appnexus.com/creative-custom-request-partner'
 
{
    "response":{
        "status":"OK",
        "count":1,
        "id":49,
        "start_element":0,
        "num_elements":100,
        "creative-custom-request-partner":{
            "id":49,
            "name":"Fred's Company",
            "macro_type":"standard",
            "member_id":null,
            "last_modified":"2014-06-02 17:55:27",
            "creative_custom_request_templates":null
        }
    }
}
{code}

カスタム パートナーを編集する

{code}$ cat edit-custom-creative-request-partner-service.json
{
    "creative-custom-request-partner":{
        "member_id": 3261
    }
}
$ curl -b cookies -c cookies -X PUT -d @edit-ccr-partner-service.json 'https://api.appnexus.com/creative-custom-request-partner?id=17'
{
    "response":{
        "status":"OK",
        "count":1,
        "id":"17",
        "start_element":0,
        "num_elements":100,
        "creative-custom-request-partner":{
            "id":17,
            "name":"inMobi",
            "macro_type":"standard",
            "member_id":3261,
            "last_modified":"2014-06-03 14:36:49",
            "creative_custom_request_templates":null
        }
    }
}            
{code}

カスタム パートナーを削除する

{code}$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/creative-custom-request-partner?id=49'
{
    "response": {
        "status":"OK",
        ...
    }
}
{code}