サイト サービス

サイト (配置グループとも呼ばれます) は、管理目的で 配置を グループ化する方法を提供します。 広告の品質と広告枠の分類はサイト レベルで設定できるため、配置間で重複する必要はありません。 各サイトは パブリッシャーに属し、各配置はサイトに属している必要があります。

パブリッシャーを作成すると、サイトが自動的に作成されます。 その後、必要に応じてそのサイトを変更したり、より多くのサイトを作成したりできます。

REST API

HTTP メソッド エンドポイント 説明
POST https://api.appnexus.com/site?publisher_id=PUBLISHER_ID
(サイト JSON)
サイトを追加します。
PUT https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_ID

https://api.appnexus.com/site?id=SITE_ID
(サイト JSON)
既存のサイトを変更します。
DELETE https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_ID

https://api.appnexus.com/site?code=SITE_CODE&publisher_code=PUBLISHER_CODE
サイトを削除します。
GET https://api.appnexus.com/site 発行元のすべてのサイトを表示します。
GET https://api.appnexus.com/site?publisher_id=PUBLISHER_ID いずれかの発行元のすべてのサイトを表示します。
GET https://api.appnexus.com/site?id=SITE_ID&publisher_id=PUBLISHER_ID

https://api.appnexus.com/site?id=SITE_ID
いずれかの発行元の特定のサイトを表示します。
GET https://api.appnexus.com/site?id=1,2,3 コンマ区切りリストを使用して、ID で複数のサイトを表示します。

注:

publisher_code codeは、それぞれpublisher_idとidと同じ意味で使用できます。

JSON フィールド

フィールド 種類 説明
id int このサイトを参照するために API によって割り当てられた Xandr ID。

必須: クエリ文字列内のPUT
code string (100) このサイトの省略可能なコード。
name string (100) サイトに関連付けられている名前。

必須:PUT、 POST
state 列挙 このサイトの状態。 使用可能な値: active または inactive。

既定値: active
url string (255) このサイトの URL。
publisher_id int このサイトが属している発行元の ID。

必須: クエリ文字列内のPOST/PUT
primary_content_category_id int ユーザーは必要に応じて、配置のプライマリ コンテンツ カテゴリ を指定できます (下記 の例を 参照)。 このカテゴリはターゲット設定に使用でき、レポートに表示されます。 コンテンツ カテゴリは、サイト レベルまたは配置レベルで設定できますが、両方で設定することはできません。
last_modified timestamp この配置に対する最後のアクティビティのタイムスタンプ。
placements オブジェクトの配列 このサイトに関連付けられている配置の ID。 詳細については 、以下の「配置」 を参照してください。
content_categories 配列 ユーザーは必要に応じて、配置に 1 つ以上のコンテンツ カテゴリを指定できます。 これらのカテゴリはターゲット設定に使用でき、サイトレベルと配置レベルの両方で設定できます。 サイトでは、最大 20 個のカテゴリを設定できます。 詳細については、以下の コンテンツ カテゴリ を参照してください。
intended_audience 列挙 サイトの対象ユーザー。 'audited'がtrueされている場合は、nullしないでください。 使用可能な値:
- children
- young_adult
- general
- mature

既定値: null
inventory_attributes 配列 サイトに含まれる機密性の高い属性。サイト レベルで設定した場合、 inventory_attributes は配置レベルのオブジェクトにも影響します。 ID と属性のマッピングは次のとおりです。 配列の形式も以下に含まれています。

既定値: null
audited ブール値 サイトが監査されているかどうか。
publisher_join 配列
publisher_name string (100) サイトの対象となる発行元の名前
supply_type string 非推奨。 このフィールドは引き続き既定値は "web" ですが、各オークションで Xandr によって供給タイプが自動的に検出されるため、その値は無視されます。 ユーザーは、供給の種類を手動で指定するのではなく、Xandr の自動検出に依存する必要があります。

既定値: web
creative_format_action string - exclude: creative_formats 配列で指定されているものを除き、すべてのクリエイティブ形式がこのサイトで配信できるようにします
- include: で指定されたリストに含まれる形式のクリエイティブのみが配信されます。 creative_formats

既定値: exclude。
一部のモバイル アプリケーション供給ソースでは、Xandr で使用できるすべてのクリエイティブ形式がサポートされていません。
creative_formats 文字列の配列 このサイトで除外または含めるクリエイティブ形式。

既定値: text
allowed_click_actions 文字列の配列 サポートされているクリエイティブのクリック アクションの種類を購入者に通知します。 モバイル Web とアプリでは、多くの場合、クリックから呼び出し、SMS へのクリック、電子メールへのクリック、マップへのクリックなど、Web サイトへのクリック以外の追加のクリック 操作が許可されます。

既定値: click-to-web only
marketplace_map object アクセス可能なマーケットプレースの種類 (パフォーマンス、RTB、取引) を購入者に通知します。 内部フィールド定義については、以下の 「Marketplace Map」 を参照してください。
mobile_app_instance multi-object このサイトに関連付けられている モバイル アプリ インスタンス 。 このフィールドは、 supply_type が mobile_appされている場合にのみ設定できます。 内部フィールド定義については、以下の 「Mobile App Instance」 を参照してください。

必須:mobile_appのsupply_typeを持つサイトのPOST。
mobile_app_instance_id int このサイトに関連付けられているモバイル アプリ インスタンスの ID。 このフィールドは、mobile_appのsupply_typeを持つサイトにのみ関連付けられます。

Marketplace マップ

パラメーター 型 説明
an_audit_perf_only ブール型 読み取り専用。 サイトが、監査に基づいて CPA/CPC 要求の対象となるかどうか。 true場合は、はい。

既定値: false
rtb ブール型 サイトに関連付けられているインベントリ (およびそのすべての配置) が RTB Marketplace の一部であるかどうかを指定します (つまり、CPM 需要の対象)。
- true場合、このサイトの配置に関連付けられているすべてのインベントリは、RTB Marketplace 内で再販されます。
- サイト内のいずれかの配置で展開可能なメディアの種類がサポートされている場合、フィールドを true に設定することはできません。 メディアの種類とサブタイプのフィールドの詳細については、「 配置サービス 」を参照してください。
- false場合、サイト内の展開可能な配置を、フィールドが trueされているサイトに移動することはできません。
- [ false ] に設定されている場合、このサイトのプレースメントに関連付けられているすべてのインベントリはダイレクト キャンペーンでのみ使用できます。 このプレースメント グループのプレースメントに関連付けられているインベントリは再販されません。

既定値: true
performance ブール型 更新されたパフォーマンス マーケットプレースを使用して、サイトが CPA/CPC 需要の対象かどうか。 true場合は、はい。

既定値: false
deals_allowed ブール型 このサイトで取引を提供できるかどうかを指定します。

既定値: true
rtb_suspended ブール型 読み取り専用。 このサイトとその配置に関連付けられているすべてのインベントリが RTB Marketplace への参加をブロックされていることを示します。

既定値: false
deals_suspended ブール型 読み取り専用。 すべての取引がこのサイトでの提供を停止していることを示します。

既定値: false

モバイル アプリ インスタンス

パラメーター 型 説明
id int このアプリ インスタンスの一意の ID。 このフィールドは、 POSTでは省略可能です。送信された場合は、 bundle_id と os_family_idを検索するために使用されます。 このフィールドが PUT または POSTに設定されていない場合は、 bundle_id フィールドと os_family_id フィールドを渡す必要があり、新しいモバイル アプリ インスタンス ID が作成されます。
bundle_id int POSTにidフィールドが渡されない場合は、このフィールドが必要です。 このフィールドは、モバイル アプリ インスタンスのバンドル ID を表し、モバイル アプリ インスタンス ID の検索に使用されます。 このバンドル ID に関連付けられているアプリ インスタンス ID がない場合は、新しいインスタンス ID が作成されます。
os_family_id int PUTまたはPOSTでidフィールドが渡されない場合は、このフィールドが必要です。 このフィールドは、このアプリ インスタンスが関連付けられているオペレーティング システム ファミリの一意の ID を表します。 この OS ファミリ ID に関連付けられているアプリ インスタンス ID がない場合は、新しいインスタンス ID が作成されます。

プレースメント

パラメーター 型 説明
id int 配置の一意識別子。 配置サービスを使用して、配置 ID を検索できます。
code string 配置の内部コード。

コンテンツ カテゴリ

パラメーター 型 説明
id int コンテンツ カテゴリの ID。 コンテンツ カテゴリ サービスを使用して、カテゴリ ID を検索できます。
is_system ブール型 コンテンツ カテゴリがシステム ("universal") カテゴリであるかどうか。
name string (100) カテゴリの名前。
site 配列 このコンテンツ カテゴリに該当する ID の一覧。
primary ブール型 カテゴリがサイトのプライマリ カテゴリであるかどうか。 プライマリにできるカテゴリは 1 つだけです。

インベントリ属性

パラメーター 型 説明
inventory_attribute_id int インベントリ属性の ID。
name string (50) 読み取り専用。 インベントリ属性の名前。

インベントリ属性 ID

Id 属性名
2 政治
4 ソーシャル メディア
6 写真 & ビデオ共有
8 フォーラム (モデレート)
10 フォーラム (非モデレート)
12 インセンティブ付きクリック数
14 英語以外の言語
16 ストリーミング メディア
17 ツール バー、プラグイン、または拡張機能

例

サイトへのコンテンツ カテゴリの追加

$ cat site

{
    "site": {
        "content_categories": [
            {
                "id": 2561,
                "primary": true
            },
            {
                "id": 2558
            }
        ],
        "name": "Site 1"
    }
}

$ curl -b cookies -c cookies -X PUT -d @site 'https://api.appnexus.com/site?id=5822'

パブリッシャーのすべてのサイトを表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/site'

{
   "response":{
      "status":"OK",
      "sites":[
         {
            "id":2411,
            "code":null,
            "name":"[Default RTB Media Buy] - ROS",
            "state":"active",
            "url":"",
            "primary_content_category_id":null,
            "last_modified":"2010-05-12 22:46:42",
            "intended_audience":"general",
            "inventory_attributes":[
                {
                    "id":2,
                    "name":"Political"
                }
            ]
            "placements":[

            ],
            "content_categories": [
                {
                    "id": 2561,
                    "primary": true
                },
                {
                    "id": 2558
                }
            ],
         },
         {
            "id":2412,
            "code":null,
            "name":"[Weekdays Only] - ROS",
            "state":"active",
            "url":"",
            "media_buy_id":1559,
            "primary_content_category_id": 2561,
            "last_modified":"2010-05-12 23:28:40",
            "placements":[

            ],
            "content_categories":null
         },
         {
            "id":2413,
            "code":null,
            "name":"[Weekends Only] - ROS",
            "state":"active",
            "url":"",
            "media_buy_id":1560,
            "primary_content_category_id":null,
            "last_modified":"2010-05-12 23:28:52",
            "placements":[

            ],
            "content_categories":null
         },
         {
            "id":5775,
            "code":null,
            "name":"[Conversion Test] - ROS",
            "state":"active",
            "url":"",
            "media_buy_id":4732,
            "primary_content_category_id":null,
            "last_modified":"2010-06-15 20:09:38",
            "placements":[
               {
                  "id":"57851"
               }
            ],
            "content_categories":null
         }
      ],
      "count":4,
      "start_element":null,
      "num_elements":null
   }
}        

モバイル アプリの供給の種類を使用してサイトを作成する

この例では、モバイル アプリの提供用に設計されたサイトを作成します。 次の例でも使用します。

$ cat the-site.json
 
{"site":{"name":"One site to rule them all", "supply_type":"mobile_app"}}
 
$ curl -b cookies -X POST -d @the-site.json 'https://api.appnexus.com/site?publisher_id=102306'
 
{
    "response":{,
         "site":{
            "allowed_click_actions":[
                "click-to-web"
            ],
             "creative_formats":[
                "text"
            ],
             "inventory_attributes":null,
             "content_categories":null,
             "placements":null,
             "mobile_app_instance":null,
             "member_id":1309,
             "creative_format_action":"exclude",
             "supply_type":"mobile_app",
             "publisher_name":"RICH'S CRAZY RESELLER",
             "audited":false,
             "intended_audience":null,
             "last_modified":"2014-02-20 20:56:03",
             "primary_content_category_id":null,
             "publisher_id":102306,
             "url":"",
             "state":"active",
             "name":"One site to rule them all",
             "code":null,
             "id":273205
        },
         "num_elements":100,
         "start_element":0,
         "id":273205,
         "count":1,
         "status":"OK"
    }
}

モバイル アプリ インスタンスをサイトに追加する

この例では、必要なモバイル アプリ供給の種類を持つ既存のサイトがあります。 サイトを既存のモバイル アプリ インスタンスに関連付けるために PUT 呼び出しを行い、応答で更新されたオブジェクトを表示することで機能したことがわかります。 モバイル アプリ インスタンスの詳細については、「 Mobile App Instance Service」を参照してください。

$ cat update.json

{"site":{"supply_type":"mobile_app", "mobile_app_instance":{"id":62}}}
 
$ curl -b cookies -X PUT -d @update.json
 
{
    "response":{
        "site":{
            "allowed_click_actions":[
                "click-to-web"
            ],
            "creative_formats":[
                "text"
            ],
            "inventory_attributes":null,
            "content_categories":null,
            "placements":null,
            "mobile_app_instance":{
                "os_family_id":3,
                "bundle_id":"2342342345566666",
                "id":62
            },
            "member_id":1309,
            "creative_format_action":"exclude",
            "supply_type":"mobile_app",
            "publisher_name":"RICH'S CRAZY RESELLER",
            "audited":false,
            "intended_audience":null,
            "last_modified":"2014-02-20 21:18:15",
            "primary_content_category_id":null,
            "publisher_id":102306,
            "url":"",
            "state":"active",
            "name":"One site to rule them all",
            "code":null,
            "id":273205
        },
        "num_elements":100,
        "start_element":0,
        "id":"273205",
        "count":1,
        "status":"OK"
    }
}