エンタイトルメントの種類サービス
注:
このサービスは現在、限られた一連のクライアントと Microsoft の従業員のみが利用できます。
エンタイトルメントタイプのサービスを使用すると、メンバーサービスを通じてメンバーに割り当てるコードを定義できます。 このコードは、特定のメンバーにのみ特定の機能を提供するために使用されます。 たとえば、ターゲット設定や取引検出キーワード (keyword)実行できるメンバーがいる場合があります。 このサービスを使用してエンタイトルメントタイプを作成した後、1 つ以上のエンタイトルメントタイプをメンバーに割り当てることができます。
REST API
| HTTP メソッド | Enpoints | 説明 |
|---|---|---|
GET |
https://api.appnexus.com/entitlement-type |
すべてのエンタイトルメントの種類を表示する |
POST |
https://api.appnexus.com/entitlement-type |
エンタイトルメントの種類を作成する |
PUT |
https://api.appnexus.com/entitlement-type?id=ENTITLEMENT_TYPE_ID |
エンタイトルメントの種類を変更する |
DELETE |
https://api.appnexus.com/entitlement-type?id=ENTITLEMENT_TYPE_ID |
エンタイトルメントの種類を削除する |
JSON フィールド
一般
| フィールド | 型 (長さ) | 説明 |
|---|---|---|
id |
int | エンタイトルメントの種類の ID。 この値は、 で POST自動生成されます。既定値: 自動生成された数値。 |
code |
string | エンタイトルメントに関連付けられているコード。 この値はエンジニアによって設定され、エンジニアが指定する必要があります。 |
description |
object | 権利の説明。 この値は省略可能であり、実際の権利には影響しません。 説明は、エンタイトルメントタイプが作成された後に変更できる唯一のフィールドです。 |
created_on |
timestamp | 権利が作成された日付と時刻。 既定値: 作成時に自動生成されます。 |
last_activity |
timestamp | エンタイトルメントが最後に変更された日付と時刻。 既定値: 各変更時に自動生成されます。 |
例
すべてのエンタイトルメントの種類を表示する
$ curl -b cookies 'https://api.appnexus.com/entitlement-type'
{
"response": {
"status": "OK",
"count": 4,
"start_element": 0,
"num_elements": 100,
"entitlement-types": [
{
"id": 1,
"code": "seller_external_uid",
"description": "Boolean, when true allows external uid mapping for a seller",
"last_activity": "2016-10-12 15:39:28",
"created_on": "2016-10-12 15:39:28"
},
{
"id": 2,
"code": "seller_deal_discovery",
"description": "Boolean, when true allows deal discovery for a seller",
"last_activity": "2016-10-13 16:43:51",
"created_on": "2016-10-13 16:43:51"
},
{
"id": 3,
"code": "seller_keyword_targeting",
"description": "Boolean, when true allows keyword targeting for a seller",
"last_activity": "2016-10-13 16:43:51",
"created_on": "2016-10-13 16:43:51"
},
{
"id": 4,
"code": "seller_keyword_segment_targeting",
"description": "Boolean, when true allows keyword-based segment targeting for a seller",
"last_activity": "2016-10-13 16:43:51",
"created_on": "2016-10-13 16:43:51"
}
],
...
}
エンタイトルメントの種類を作成する
$cat entitlement_type.json
{
"entitlement-type": {
"code": "test_entitlement_code",
"description": "testing entitlement type"
}
}
$ curl -b cookies -X POST -d @entitlement_type.json 'https://api.appnexus.com/entitlement-type'
{
"response": {
"status": "OK",
"count": 1,
"id": 1,
"start_element": 0,
"num_elements": 100,
"entitlement-type": {
"id": 1,
"code": "test_entitlement_code",
"description": "testing entitlement type",
"last_activity": "2016-12-02 16:47:47",
"created_on": "2016-12-02 16:47:47"
}, ...
}
エンタイトルメントの種類を変更する
$cat entitlement_type_update.json
{
"entitlement-type": {
"description": "entitlement type for testing"
}
}
$ curl -b cookies -X POST -d @entitlement_type_update.json 'https://api.appnexus.com/entitlement-type?id=1'
{
"response": {
"status": "OK",
"count": 1,
"id": 1,
"start_element": 0,
"num_elements": 100,
"entitlement-type": {
"id": 1,
"code": "test_entitlement_code",
"description": "entitlement type for testing",
"last_activity": "2016-12-02 16:56:48",
"created_on": "2016-12-02 16:47:47"
}, ...
}