Data Analytics API - 広告掲載オーダーサービス

概要

Yield Analytics API とサービスは、REST ベースのインターフェイスを介して公開されます。これは、Web 2.0、AJAX、REST、およびサービス指向の開発プラットフォームの経験を持つ開発者にとって、カスタム機能の開発を快適にすることを目的としています。開発者は、Yield Analytics API とサービスを使用して開発を試みる前に、AJAX、XML、JSON、HTTP(S) プロトコルなどの Web ベースのアプリケーションパラダイムに精通している必要があります。

広告掲載オーダーサービスは現在、以下に関連するインターフェイスを公開しています。

注文レベルでの品目の保証された配送と容量
注文レベルでの品目の履歴配信

コンテンツタイプ

サービス REST API は現在、次のコンテンツタイプをサポートするように設計されています。

JSON - 使用 Content-type: application/json

目的のコンテンツタイプの選択は、API 開発者がケースバイケースで選択する必要があります。 API 機能はコンテンツタイプ間で対称です。 API 開発者は、HTTP GET または POST メソッドパラメーターで、または AJAX または HTTP クライアントライブラリを使用して、必要なコンテンツタイプを指定できます。

エラーチェックと状態コード

API 開発者は、サービス REST API から返される HTTP 応答コードをチェックして、API 呼び出しから伝播されたエラーを検出する必要があります。サービスへの呼び出しが成功すると、200 の範囲の応答コードが生成されます。 HTTP 応答の範囲が 400 から 500 の場合は、エラーを示します。特定の応答コードとテキストは、API のベータ版開発中に変更される可能性がありますが、範囲は変更されません。

セキュリティ

サービス API は、アプリケーションデータを安全な方法で公開します。 API 機能の使用は認証されたユーザーに限定され、セキュリティで保護されたトランスポートプロトコルを介して公開されます。 API へのアクセスは、次のコンテキスト内で行われる必要があります。

認証

認証の詳細については、「 Yield Analytics API - 認証プロセス」を参照してください。

機密性

機密性は、Secure Socket Layer ベースの通信を使用して Yield Analytics API と対話することで維持されます。 API 開発者は、可能な限り、安全でない通信が HTTP よりも HTTPS を使用することを優先する必要があります。 Web ブラウザーコンテキストの外部で開発する場合に HTTP over SSL を有効にする方法については、HTTP クライアントライブラリを参照してください。

ホスト

https://api.appnexus.com/imf/

Paths

1 回の注文で保証された容量を取得する

GET /api/v1/rest/order/capacity/future/{externalId}/{nbDays}

説明

特定のタイムゾーンの CSV 形式で、保証された配信動的容量を取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
実行する

application/json
生成する

application/json
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	InsertionOrderResponse 配列

cURL 要求の例

$ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/future/1/1' -i -H 'Content-Type: application/json' 
  -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}'

HTTP 要求の例

GET /api/v1/rest/order/capacity/future/1/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

HTTP 応答の例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
"externalId" : "1",
"nextHours" : {
"20200619T05:00+1000" : 1000,
"20200619T12:00+1000" : 1000,
"20200619T06:00+1000" : 1000,
"20200619T13:00+1000" : 1000,
"20200619T20:00+1000" : 1000,
"20200619T04:00+1000" : 1000,
"20200619T07:00+1000" : 1000,
"20200619T21:00+1000" : 1000,
"20200619T03:00+1000" : 1000,
"20200619T10:00+1000" : 1000,
"20200619T08:00+1000" : 1000,
"20200619T11:00+1000" : 1000,
"20200619T02:00+1000" : 1000,
"20200619T17:00+1000" : 1000,
"20200619T00:00+1000" : 1000,
"20200619T09:00+1000" : 1000,
"20200619T16:00+1000" : 1000,
"20200619T23:00+1000" : 1000,
"20200619T18:00+1000" : 1000,
"20200619T15:00+1000" : 1000,
"20200619T01:00+1000" : 1000,
"20200619T19:00+1000" : 1000,
"20200619T14:00+1000" : 1000,
"20200619T22:00+1000" : 1000
},
"nextDays" : {
"20200619T00:00+1000" : 240000
},
"targetings" : [ {
"start" : "2020-03-19",
"end" : "2020-06-19",
"expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') 
or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and 
segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and 
size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and 
segment-4860908 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
segment-3222990 in ('true') and segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and 
size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and 
segment-4860941 in ('true')",
"impressionCap" : 5,
"impressionCapPeriod" : 77,
"dynamic" : false
} ]
} ]

保証された配信の動的容量を単一タイムゾーンの CSV として取得する

GET /api/v1/rest/order/capacity/guaranteed/future/csv/{nbDays}/{timeZone}

説明

特定のタイムゾーンの CSV 形式で、保証された配信動的容量を取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK string
実行する

テスト/CSV
生成する

テスト/CSV
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

double timezone の注文 ID のグループごとに CSV として保証された配信動的容量を取得します

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/csv/{nbDays}/{timeZone}/{timeZoneSecond}

説明

タイムゾーン内の注文グループの保証された配信動的容量を CSV として取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	timeZoneSecond	timeZoneSecond	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK string
実行する

テスト/CSV
生成する

テスト/CSV
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

保証された配信の動的容量を、単一タイムゾーンの注文 ID のグループごとに CSV として取得します

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/csv/{nbDays}/{timeZone}

説明

タイムゾーン内の注文グループの保証された配信動的容量を CSV として取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK string
実行する

application/json
生成する

テスト/CSV
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

double timezone の注文 ID のグループごとに CSV として保証された配信動的容量を取得します

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/csv/{nbDays}/{timeZone}/{timeZoneSecond}

説明

2 倍のタイムゾーンの注文グループの CSV として、保証された配信動的容量を取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	timeZoneSecond	timeZoneSecond	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK string
実行する

application/json
生成する

テスト/CSV
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

保証された配信の動的容量を、単一タイムゾーンの注文 ID のグループごとに CSV として取得します

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/{nbDays}/{timeZone}

説明

タイムゾーン内の注文グループの容量を保証します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
実行する

application/json
生成する

テスト/CSV
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	InsertionOrderResponse 配列

cURL 要求の例

$ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/orderids/1/EST' -i -X 
POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
"externalOrderIdPool" : 
{
"orderIds" : [ "1" ]
}
}'

HTTP 要求の例

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/1/EST HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 60

{
"externalOrderIdPool" : {
"orderIds" : [ "1" ]
}
}

HTTP 応答の例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
"externalId" : "1",
"nextHours" : {
"20200619T05:00+1000" : 1000,
"20200619T12:00+1000" : 1000,
"20200619T06:00+1000" : 1000,
"20200619T13:00+1000" : 1000,
"20200619T20:00+1000" : 1000,
"20200619T04:00+1000" : 1000,
"20200619T07:00+1000" : 1000,
"20200619T21:00+1000" : 1000,
"20200619T03:00+1000" : 1000,
"20200619T10:00+1000" : 1000,
"20200619T08:00+1000" : 1000,
"20200619T11:00+1000" : 1000,
"20200619T02:00+1000" : 1000,
"20200619T17:00+1000" : 1000,
"20200619T00:00+1000" : 1000,
"20200619T09:00+1000" : 1000,
"20200619T16:00+1000" : 1000,
"20200619T23:00+1000" : 1000,
"20200619T18:00+1000" : 1000,
"20200619T15:00+1000" : 1000,
"20200619T01:00+1000" : 1000,
"20200619T19:00+1000" : 1000,
"20200619T14:00+1000" : 1000,
"20200619T22:00+1000" : 1000
},
"nextDays" : {
"20200619T00:00+1000" : 240000
},
"targetings" : [ {
"start" : "2020-03-19",
"end" : "2020-06-19",
"expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true')",
"impressionCap" : 5,
"impressionCapPeriod" : 77,
"dynamic" : false
} ]
} ]

ダブルタイムゾーンの注文 ID のグループごとに保証された配信動的キャパシティを取得します

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/{nbDays}/{timeZone}/{timeZoneSecond}

説明

ダブルタイムゾーンの注文グループの保証された容量を取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	timeZoneSecond	timeZoneSecond	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
実行する

application/json
生成する

application/json
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	InsertionOrderResponse 配列

cURL 要求の例

$ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/orderids/1/Australia/Sydney' -i -X 
  POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "externalOrderIdPool" : 
  {
    "orderIds" : [ "1" ]
  }
}'

HTTP 要求の例

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/1/Australia/Sydney HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 60

{
  "externalOrderIdPool" : {
    "orderIds" : [ "1" ]
  }
}

HTTP 応答の例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and 
     segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
     segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and 
     size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and 
     segment-4860908 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
     segment-3222990 in ('true') and segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and 
     size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and 
     segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

単一のタイムゾーンの注文 ID のグループごとに、保証された配信の動的容量を取得する

GET /api/v1/rest/order/capacity/guaranteed/future/{nbDays}/{timeZone}

説明

タイムゾーン内の注文グループの容量を保証します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
実行する

application/json
生成する

application/json
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	InsertionOrderResponse 配列

cURL 要求の例

$ curl 'https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/orderids/1/EST' -i -X POST 
   -H 'Content-Type: application/json;charset=UTF-8' -d '{
   "externalOrderIdPool" : 
  {
    "orderIds" : [ "1" ]
  }
}'

HTTP 要求の例

POST /api/v1/rest/order/capacity/guaranteed/future/orderids/1/EST HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 60

{
  "externalOrderIdPool" : {
    "orderIds" : [ "1" ]
  }
}

HTTP 応答の例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
     and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

2 倍のタイムゾーンで保証された配信動的容量を取得する

GET /api/v1/rest/order/capacity/guaranteed/future/{nbDays}/{timeZone}/{timeZoneSecond}

説明

ダブルタイムゾーンの注文グループの保証された容量を取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	timeZone	timeZone	true	string
PathParameter	timeZoneSecond	timeZoneSecond	true	string
PathParameter	nbDays	nbDays	true	integer (int32)
BodyParameter	externalOrderIdPool	externalOrderIdPool	true	ExternalOrderIdPool
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
実行する

application/json
生成する

application/json
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	InsertionOrderResponse 配列

cURL 要求の例

$ https://api.appnexus.com/imf/v1/rest/order/capacity/guaranteed/future/1/Australia/Sydney' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}'

HTTP 要求の例

GET /api/v1/rest/order/capacity/guaranteed/future/1/Australia/Sydney HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

HTTP 応答の例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
     and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and 
     segment-4860908 in ('true') or country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and 
     segment-3222990 in ('true') and segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and 
     size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') 
     and segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

保証された配信の過去の容量を JSON として取得する

Parameters

種類	名前	説明	必須	Schema
PathParameter	外部ID	外部ID	true	string
PathParameter	startDate	startDate	true	string
PathParameter	endDate	endDate	true	string
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK OrderDeliveryInfo
実行する

application/json
生成する

application/json
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	OrderDeliveryInfo

cURL 要求の例

$ curl 'https://api.appnexus.com/imf/v1/rest/order/delivery/1/2016-06-01/2016-07-01' -i -H 
'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}'

HTTP 要求の例

GET /api/v1/rest/order/delivery/1/2016-06-01/2016-07-01 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
Host: https://api.appnexus.com/imf/

HTTP 応答の例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 241

{
  "externalOrderId" : "1",
  "impressions" : 20,
  "orderLineDeliveryDetail" : {
    "1" : [ {
      "impressions" : 10,
      "date" : "05/19/2020"
    } ],
    "2" : [ {
      "impressions" : 10,
      "date" : "06/19/2020"
    } ]
  }
}

JSON を使用して広告掲載オーダーの在庫を取得する

POST /api/v1/rest/order/inventory/apas/{startDate}/{endDate}/{consumptionFilter}

説明

JSON を使用して広告掲載オーダーの在庫を取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	startDate	startDate	true	string
PathParameter	endDate	endDate	true	string
PathParameter	consumptionFilter	consumptionFilter	true	string
PathParameter	matrixVars	matrixVars	false	object
BodyParameter	body	body	true	string
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
実行する

application/json
生成する

application/json
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	InsertionOrderResponse 配列

JSON で広告掲載オーダーの在庫と競合を取得する

POST /api/v1/rest/order/inventoryandcontention/apas/{startDate}/{endDate}/{consumptionFilter}

説明

JSON で広告掲載オーダーの在庫と競合を取得します。

Parameters

種類	名前	説明	必須	Schema
PathParameter	startDate	startDate	true	string
PathParameter	endDate	endDate	true	string
PathParameter	consumptionFilter	consumptionFilter	true	string
PathParameter	matrixVars	matrixVars	false	object
BodyParameter	body	body	true	string
HeaderParameter	username	Yield Analytics API にアクセスするためのユーザー名	true	string
HeaderParameter	password	Yield Analytics API にアクセスするためのパスワード	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
実行する

application/json
生成する

application/json
Tags

広告掲載オーダーサービスのエンドポイント

HTTP コード	説明	Schema
200	OK	InsertionOrderResponse 配列

cURL 要求の例

$ curl 'https://api.appnexus.com/imf/v1/rest/order/inventoryandcontention/apas/2017-03-01/2017-03-31/consumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d 
'{
  "expression" : "ad_server in ('TEST')"
}'

HTTP 要求の例

POST /api/v1/rest/order/inventoryandcontention/apas/2017-03-01/2017-03-31/consumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://api.appnexus.com/imf/
Content-Length: 44

{
  "expression" : "ad_server in ('TEST')"
}

HTTP 応答の例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2567

[ {
  "externalId" : "1",
  "nextHours" : {
    "20200619T05:00+1000" : 1000,
    "20200619T12:00+1000" : 1000,
    "20200619T06:00+1000" : 1000,
    "20200619T13:00+1000" : 1000,
    "20200619T20:00+1000" : 1000,
    "20200619T04:00+1000" : 1000,
    "20200619T07:00+1000" : 1000,
    "20200619T21:00+1000" : 1000,
    "20200619T03:00+1000" : 1000,
    "20200619T10:00+1000" : 1000,
    "20200619T08:00+1000" : 1000,
    "20200619T11:00+1000" : 1000,
    "20200619T02:00+1000" : 1000,
    "20200619T17:00+1000" : 1000,
    "20200619T00:00+1000" : 1000,
    "20200619T09:00+1000" : 1000,
    "20200619T16:00+1000" : 1000,
    "20200619T23:00+1000" : 1000,
    "20200619T18:00+1000" : 1000,
    "20200619T15:00+1000" : 1000,
    "20200619T01:00+1000" : 1000,
    "20200619T19:00+1000" : 1000,
    "20200619T14:00+1000" : 1000,
    "20200619T22:00+1000" : 1000
  },
  "nextDays" : {
    "20200619T00:00+1000" : 240000
  },
  "targetings" : [ {
    "start" : "2020-03-19",
    "end" : "2020-06-19",
    "expression" : "country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') 
     and segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222986 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222986 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4836884 in ('true') and segment-4860903 in ('true') or country in ('australia') and size in ('160x600') and    
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4836884 in ('true') and segment-4860908 in ('true') or 
     country in ('australia') and size in ('160x600') and site in ('outlook au desktop') and segment-3222990 in ('true') and 
     segment-4860903 in ('true') and segment-4860941 in ('true') or country in ('australia') and size in ('160x600') and 
     site in ('outlook au desktop') and segment-3222990 in ('true') and segment-4860908 in ('true') and segment-4860941 in ('true')",
    "impressionCap" : 5,
    "impressionCapPeriod" : 77,
    "dynamic" : false
  } ]
} ]

定義

ExternalOrderIdPool

名前	説明	必須	Schema
externalOrderIdPool		false	ExternalOrderIdPool
orderIds	注文 ID のコレクション	true	文字列配列

InsertionOrderResponse

広告掲載オーダーの実行結果を保持する JSON オブジェクト。

名前	説明	必須	Schema
外部ID	広告掲載オーダー応答の外部 ID	true	string
nextDays	A map of key to next days	true	object
nextHours	次の時間へのキーのマップ	true	object
ターゲティング	広告掲載オーダーターゲティング応答のコレクション	true	InsertionOrderTargetingResponse 配列

InsertionOrderTargetingResponse

広告掲載オーダーの応答でターゲティングの結果を保持する JSON オブジェクト。

名前	説明	必須	Schema
動的	広告掲載オーダーターゲティング応答の動的動的	true	ブール値
end	広告掲載オーダーターゲティング応答の終了	true	string
式	広告掲載オーダーターゲティング応答の式	true	string
impressionCap	広告掲載オーダーターゲティング応答のインプレッション上限	false	integer (int64)
impressionCapPeriod	広告掲載オーダーターゲティング応答のインプレッション上限期間	false	integer (int64)
開始	広告掲載オーダーターゲティング応答の開始	true	string

OrderDeliveryInfo

注文の配送情報を保持する JSON オブジェクト。

名前	説明	必須	Schema
externalOrderId	注文配送情報の外部注文 ID	true	string
インプレッション数	注文配信情報のインプレッション	true	integer (int64)
orderLineDeliveryDetail	注文明細配送詳細のセットへのキーのマップ	false	object

OrderLineDeliveryDetail

注文明細配送の詳細情報を保持する JSON オブジェクト。

名前	説明	必須	Schema
date	注文明細配送明細の日付	true	string
インプレッション数	注文明細配送の詳細の印象	true	integer (int64)

Yield Analytics API

Last updated on 2026-08-18

Data Analytics API - 広告掲載オーダー サービス

概要

コンテンツ タイプ

エラー チェックと状態コード

セキュリティ

認証

機密性

ホスト

Paths

1 回の注文で保証された容量を取得する

保証された配信の動的容量を単一タイムゾーンの CSV として取得する

double timezone の注文 ID のグループごとに CSV として保証された配信動的容量を取得します

保証された配信の動的容量を、単一タイムゾーンの注文 ID のグループごとに CSV として取得します

double timezone の注文 ID のグループごとに CSV として保証された配信動的容量を取得します

保証された配信の動的容量を、単一タイムゾーンの注文 ID のグループごとに CSV として取得します

ダブル タイムゾーンの注文 ID のグループごとに保証された配信動的キャパシティを取得します

単一のタイムゾーンの注文 ID のグループごとに、保証された配信の動的容量を取得する

2 倍のタイムゾーンで保証された配信動的容量を取得する

保証された配信の過去の容量を JSON として取得する

JSON を使用して広告掲載オーダーの在庫を取得する

JSON で広告掲載オーダーの在庫と競合を取得する

定義

ExternalOrderIdPool

InsertionOrderResponse

InsertionOrderTargetingResponse

OrderDeliveryInfo

OrderLineDeliveryDetail

関連トピック

その他のリソース

Data Analytics API - 広告掲載オーダーサービス

コンテンツタイプ

エラーチェックと状態コード

ダブルタイムゾーンの注文 ID のグループごとに保証された配信動的キャパシティを取得します