Data Analytics API - 挿入注文サービス

[アーティクル]
02/23/2024

概要

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

挿入順序サービスは現在、次に関連するインターフェイスを公開しています。

注文レベルでの品目の出荷と能力の保証
受注レベルでの明細の納入履歴

コンテンツタイプ

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

JSON - using Content-type: application/json

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

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

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

セキュリティ

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

cURL認証の例

認証は、各要求で http ヘッダーを介して資格情報を渡すことによって行われます。

- username: curl -H "username:username"
- password: curl -H "password:password"
- source: curl -H "source:client_id"

HTTPS 認証の例

GET /api/v1/rest/
HTTPS/1.1
Host: yieldanalytics.xandr.com
Accept: application/xml, application/json
Content-Type: application/json
username: {{username}}
password: {{password}}
source: {{client_id}}

POSTMAN 認証の例

Postman のヘッダー設定の例を次に示します。
注:
- 'Authorization' が "No Auth" に設定されています。次の設定は、[ヘッダー] タブに配置します。
- Postman の使用に関する詳細なチュートリアルについては、「 Yield Analytics API での Postman の使用」を参照してください。

機密性

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

Paths

1 つの注文の保証容量を取得する

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

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
消費

application/json
生成

application/json
Tags

挿入順序サービスのエンドポイント

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

cURL要求の例

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

HTTP 要求の例

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

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
} ]
} ]

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

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

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK string
消費

test/csv
生成

test/csv
Tags

挿入順序サービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

二重タイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

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

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK string
消費

test/csv
生成

test/csv
Tags

挿入順序サービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

1 つのタイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

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

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK string
消費

application/json
生成

test/csv
Tags

挿入順序サービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

二重タイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

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

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK string
消費

application/json
生成

test/csv
Tags

挿入順序サービスのエンドポイント

HTTP コード	説明	Schema
200	OK	string

1 つのタイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

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

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
消費

application/json
生成

test/csv
Tags

挿入順序サービスのエンドポイント

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

cURL要求の例

$ curl 'https://{{client_url}}/api/v1/rest/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://{{client_url}}/api/v1/rest
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}

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
消費

application/json
生成

application/json
Tags

挿入順序サービスのエンドポイント

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

cURL要求の例

$ curl 'https://{{client_url}}/api/v1/rest/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://{{client_url}}/api/v1/rest
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}

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
消費

application/json
生成

application/json
Tags

挿入順序サービスのエンドポイント

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

cURL要求の例

$ curl 'https://{{client_url}}/api/v1/rest/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://{{client_url}}/api/v1/rest
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
  } ]
} ]

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

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

説明

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

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
消費

application/json
生成

application/json
Tags

挿入順序サービスのエンドポイント

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

cURL要求の例

$ curl 'https://{{client_url}}/api/v1/rest/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}}' -H 'source: {{source}}'

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}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

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 として保証された配信履歴容量を取得する

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK OrderDeliveryInfo
消費

application/json
生成

application/json
Tags

挿入順序サービスのエンドポイント

HTTP コード	説明	Schema
200	OK	OrderDeliveryInfo

cURL要求の例

$ curl 'https://{{client_url}}/api/v1/rest/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}}' -H 'source: {{source}}'

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}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

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 を使用して挿入注文インベントリを取得します。

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	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 を使用して挿入順序のインベントリと競合を取得します。

パラメーター

種類	名前	説明	必須	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
HeaderParameter	source	Yield Analytics API にアクセスするためのクライアントソース	true	string

応答

HTTP コード説明 Schema

200 OK InsertionOrderResponse 配列
消費

application/json
生成

application/json
Tags

挿入順序サービスのエンドポイント

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

cURL要求の例

$ curl 'https://{{client_url}}/api/v1/rest/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://{{client_url}}/api/v1/rest
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	次の日へのキーのマップ	true	object
nextHours	次の時間へのキーのマップ	true	object
targetings	挿入順序ターゲット応答のコレクション	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

次の方法で共有

Data Analytics API - 挿入注文サービス

概要

コンテンツタイプ

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

セキュリティ

機密性

Paths

1 つの注文の保証容量を取得する

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

二重タイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

1 つのタイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

二重タイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

1 つのタイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

二重タイムゾーンの注文 ID のグループ別の保証された配信動的容量を取得する

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

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

JSON として保証された配信履歴容量を取得する

JSON を使用して挿入注文インベントリを取得する

JSON で挿入注文のインベントリと競合を取得する

定義

ExternalOrderIdPool

InsertionOrderResponse

InsertionOrderTargetingResponse

OrderDeliveryInfo

OrderLineDeliveryDetail

その他のリソース

次の方法で共有

Data Analytics API - 挿入注文サービス

概要

コンテンツ タイプ

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

セキュリティ

機密性

Paths

1 つの注文の保証容量を取得する

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

二重タイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

1 つのタイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

二重タイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

1 つのタイムゾーンの注文 ID のグループ別に CSV として保証された配信動的容量を取得する

二重タイムゾーンの注文 ID のグループ別の保証された配信動的容量を取得する

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

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

JSON として保証された配信履歴容量を取得する

JSON を使用して挿入注文インベントリを取得する

JSON で挿入注文のインベントリと競合を取得する

定義

ExternalOrderIdPool

InsertionOrderResponse

InsertionOrderTargetingResponse

OrderDeliveryInfo

OrderLineDeliveryDetail

関連トピック

その他のリソース

コンテンツタイプ

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

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