次の方法で共有

セグメント課金カテゴリ サービス

  • [アーティクル]

セグメント課金カテゴリ サービスを使用すると、セグメントを Data Marketplace の価格分類に マップ できます。 次に、動作のしくみを示します。

  1. Data Marketplace でアクティブ化するセグメントのマッピング レコードを作成します。
  2. マッピング レコードで、セグメントを割り当てる価格カテゴリを指定します。 セグメントを共有したクライアントがキャンペーンでそのセグメントをターゲットにできるようになりました。Xandr は使用量のコストをクリアします。

注:

  • このサービスを使用すると、既存のカテゴリにマップできます。 新しいカテゴリを作成するには、Xandr の担当者にお問い合わせください。
  • マッピング レコードからセグメントを削除すると、メンバーはキャンペーンでセグメントを引き続き使用できますが、Xandr はデータ使用量の追跡を停止します。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/data-provider すべての価格分類を表示します。
GET https://api.appnexus.com/segment-billing-category すべてのマッピング レコードを表示します。
POST https://api.appnexus.com/segment-billing-category (マッピング JSON)

メモ： 一度にマップできるセグメントは 1 つだけです。		 マッピング レコードを追加します。
PUT https://api.appnexus.com/segment-billing-category (マッピング JSON) マッピング レコードを変更します。
DELETE https://api.appnexus.com/segment-billing-category?id=RECORD_ID マッピング レコードを削除します。

ヒント

JSON 構造体:

マッピング レコードを追加または更新するときは、JSON を "segment-billing-category" という 1 つのオブジェクトとして構造化する必要があります。 正確な書式設定については、次の 例を 参照してください。

セグメント課金カテゴリ サービスは、プラットフォーム API とインプレッション バス API の両方で機能します。 以下でのみ api.adnxs.com 使用されますが、プラットフォーム API へのアクセス権を持つクライアントに置き換 api.appnexus.com えることができます。 プラットフォーム API にアクセスできるのは、オンのメンバーのみです。 ほとんどのデータ プロバイダーは、インプレッション バス API にのみアクセスできます。

JSON フィールド

フィールド 型 (長さ) 説明 既定値 必須
id int Xandr セグメント ID が課金カテゴリにマップされるときに作成される一意の ID。 これは、レコードごとのマッピング ID と呼ばれます。 自動生成された数値 PUT (JSON 内)
DELETE (クエリ文字列内)
segment_id int マップされている Xandr セグメント ID。 POST/PUT
data_provider_id int Data Marketplace によって割り当てられたデータ プロバイダー ID。
メモ：POST/CALLアカウントが所有していない ID を送信すると、通話は失敗します。		 POST/PUT
data_category_id int Xandr で作成された価格カテゴリ ID。
メモ：POST/PUTアカウントが所有していない ID を送信すると、呼び出しは失敗します。		 POST/PUT
active ブール値 マッピング レコードの状態。 に設定すると true、マッピング レコードがアクティブになります。 POST
member_id int 読み取り専用です。 メンバー ID。
is_public ブール値 セグメントをパブリックまたは プライベートとしてマークする設定。 を に true設定すると、セグメントはすぐにすべての Data Marketplace 購入者と共有されます。 false PUT
data_segment_type_id string セグメントの種類。 これにより、購入者は特定の種類のセグメントを簡単に検索できます。 [ブランドの安全性] と [不正検出] セグメントの種類の場合は、フィールド (以下を参照) がセグメントの種類に対して適切な値に設定されていることを確認 recommend_include します。
有効なオプションは次のとおりです。
-未割り当て
-観客
- ブランドの安全性
- 不正検出
- 視認性
-コンテキスト
-ジオロケーション
-B2b
-購入
-関心
-デモ
- In-Market		 未割り当て
recommend_include ブール値 セグメントが包含 () または除外false (true) を意図しているかどうかを判断します。 既定では、これは除外である に false 設定されます。セグメントが含まれる場合は に true 設定されます。 このフィールドがセグメントの種類に対して適切な値に設定されていることを確認します。 false

改ページ

要求のクエリ文字列で と num_elements をstart_element指定することで、結果をGET改ページできます。 たとえば、次の要求では、要素 26 から 25 個の項目が返されます。

curl -b cookies -c cookies 'https://api.appnexus.com/segment-billing-category?start_element=26&num_elements=25'
フィールド 種類 説明
count int 結果の合計数。
start_element int 結果セットを開始する要素番号。
num_elements int 返す要素の数、max = 100、既定値 = 25。

例

価格分類を表示する

$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/data-provider'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "dbg_info": {
      "instance": "01.data-clearing-api.prod.nym2",
      "db": "",
      "warnings": [],
      "start_microtime": 1459912197.525,
      "time": 14,
      "version": "",
      "output_term": "data-providers"
    },
    "data-providers": [
      {
        "id": 1,
        "node_name": "Sample Data Provider Name",
        "member_id": 958,
        "data_revshare_pct": 0.01,
        "active": true,
        "data_publishers": [
          {
            "id": 1,
            "node_name": "Sample Data Publisher Name",
            "level_index": 0,
            "data_provider_id": 958,
            "active": true,
            "member_id": 958,
            "data_categories": [
              {
                "id": 1001,
                "node_name": "Sample Data Category Name",
                "level_index": 0,
                "data_publisher_id": 1,
                "data_provider_id": 958,
                "active": true,
                "member_id": 958
              }
            ]
          }
        ]
      }
    ]
  }
}

マッピング レコードを作成する

$ cat create_segment_mapping
{
        "segment-billing-category": {
                "active": true, 
                "data_provider_id": 958,
                "data_category_id": 1001,
                "segment_id": 111111,
                "is_public": true,
                "data_segment_type_id": "Audience"
        }
}
$ curl -b cookies -c cookies -X POST -d @create_segment_mapping 'https://api.appnexus.com/segment-billing-category?member_id=958'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "segment_billing_categories": [
      {
        "id": 22286,
        "segment_id": 111111,
        "data_provider_id": 958,
        "data_category_id": 1001,
        "active": true,
        "member_id": 958,
                "is_public": true,
                "data_segment_type_id" : "Audience"
      }
    ]
  }
}

マッピング レコードを更新する

$ cat update_segment_mapping
{
        "segment-billing-category": {
                "id": 22286,
                "active": false,
                "is_public": true,
                "data_provider_id": 958,
        "data_category_id": 1001,
                "data_segment_type_id": "Contextual"
        }
}
$ curl -b cookies -c cookies -X PUT -d @update_segment_mapping 'https://api.appnexus.com/segment-billing-category?member_id=958'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "segment_billing_categories": [
      {
        "id": 22286,
        "segment_id": 111111,
        "data_provider_id": 958,
        "data_category_id": 1001,
        "active": false,
        "member_id": 958,
                "is_public": true,
                "data_segment_type_id": "Contextual"
      }
    ]
  }
}

マッピング レコードを削除する

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/segment-billing-category?member_id=958&id=22286'
{
  "response": {
    "status": "OK",
    "count": 0,
    "start_element": 0,
    "num_elements": 0,
    "segment_billing_category": null
  }
}

すべてのマッピング レコードを表示する

$ curl -b cookies -c cookies 'https://api.appnexus.com/segment-billing-category'
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": 0,
    "num_elements": 25,
    "segment_billing_categories": [
      {
        "id": 22286,
        "segment_id": 111111,
        "data_provider_id": 958,
        "data_category_id": 1001,
        "active": true,
        "member_id": 958,
                "is_public": true,
                "data_segment_type_id": "Contextual"
      }
    ]
  }
}