外部インベントリ コード サービス

一部の販売者は、パブリッシャー > サイト > の配置よりも詳細にインベントリを分割するために独自のコードを使用します。 外部インベントリ コード サービスを使用すると、このようなコードを Xandr に登録して、広告呼び出しに渡してレポートすることができます。

次に、動作のしくみを示します。

  1. このサービスを POST 呼び出して、手順 2 と 3 の前に外部インベントリ コードを Xandr に登録する必要があります。
  2. タグベースの広告呼び出しのクエリ文字列のようにコードext_inv_codeを渡すか (以下の例を参照)、または AST の defineTag API または Mobile SDK の API を使用して値を定義extInvCodeします。
  3. その後、(このページで説明されている API サービスを介して外部インベントリ コードからマップされた) 外部インベントリ ID/名前を、次のいずれかのレポート/フィード (アクセス権を持つ) でレポートできます。

外部インベントリ コードを含む配置タグの例

<script src="https://ib.adnxs.com/ttj?id=1234&ext_inv_code=ABC" type="text/javascript"></script>

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/external-inv-code すべての外部インベントリ コードを表示します。
GET https://api.appnexus.com/external-inv-code?publisher_id=PUBLISHER_ID 特定の発行元のすべての外部インベントリ コードを表示します。
GET https://api.appnexus.com/external-inv-code?id=ID 特定の外部インベントリ コードを表示します。
GET https://api.appnexus.com/external-inv-code?code=CODE 特定の外部インベントリ コードを表示します。
POST https://api.appnexus.com/external-inv-code 新しい外部インベントリ コードを追加します。
PUT https://api.appnexus.com/external-inv-code?id=ID 外部インベントリ コードを変更します。
DELETE https://api.appnexus.com/external-inv-code?id=ID 外部インベントリ コードを削除します。

JSON フィールド

ヒント

codepublisher_id各組み合わせは一意である必要があります。

フィールド 型 (長さ) 説明
code string (100) タグベースの広告呼び出しのクエリ文字列、または AST/SDK ベースの ut/v3 広告呼び出しの要求本文のように渡される ext_inv_code 値。

必須:POST
id int 外部インベントリ コードの ID。

既定値: 自動生成された数値
必須:PUT およびDELETE
name string (100) 外部インベントリ コードの名前。 この名前は、上記の (最初の 4 つの) Network/Publisher Analytics UI/API レポートに含めることができます。

必須:POST
publisher_id int 外部インベントリ コードが使用される発行元の ID。 の場合 0、コードは複数のパブリッシャー間で使用されます。

既定値: 0

特定の発行元の外部インベントリ コードを追加する

$ cat ext_inv_code.json
{
   "external_inv_code": {
      "publisher_id": 103764,
      "code":"55",
      "name":"Code 55"
   }
}
$ curl -b cookies -c cookies -X POST -d @ext_inv_code.json 'https://api.appnexus.com/external-inv-code'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 102,
        "start_element": 0,
        "num_elements": 100,
        "external_inv_code": {
            "member_id": 1066,
            "id": 102,
            "publisher_id": 103764,
            "name": "55",
            "code": "Code 55"
        }
        }
    }
}

複数の発行元間で使用する外部インベントリ コードの追加

$ cat ext_inv_code.json
{
   "external_inv_code": {
      "publisher_id": 0,
      "code":"74",
      "name":"Code 74"
   }
}
$ curl -b cookies -c cookies -X POST -d @ext_inv_code.json 'https://api.appnexus.com/external-inv-code'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 102,
        "start_element": 0,
        "num_elements": 100,
        "external_inv_code": {
            "member_id": 1066,
            "id": 103,
            "publisher_id": 0,
            "name": "74",
            "code": "Code 74"
        }
    }
}

外部インベントリ コードの更新

$ cat ext_inv_code_update
{
   "external_inv_code": {
      "name":"Fresh new name"
   }
}
$ curl -b cookies -c cookies -X PUT -d @ext_inv_code_update.json 'https://api.appnexus.com/external-inv-code?id=102'
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "102",
        "start_element": 0,
        "num_elements": 100,
        "external_inv_code": {
            "member_id": 1066,
            "id": 102,
            "publisher_id": 103764,
            "name": "Fresh new name",
            "code": "Code 5"
        }
    }
}

外部インベントリ コードの削除

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/external-inv-code?id=102'
{
    "response": {
        "status": "OK"
    }
}