概要
Yield Analytics Data API は、Yield Analytics 環境内から利用可能なデータと構成を検索するための機能を公開します。
コンテンツ タイプ
サービス 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
エイリアスの列の取得
GET /api/v1/rest/data/aliasColumns
説明
エイリアス列のコレクションを読み取る要求を取得します。
Parameters
種類 名前 説明 必須 Schema HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string 応答
HTTP コード 説明 Schema 200 OK AliasColumns 実行する
application/json
生成する
- application/xml
- application/json
Tags
データ リソース
cURL 要求の例
$ curl 'https://api.appnexus.com/imf/v1/rest/data/aliasColumns' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}'HTTP 要求の例
GET /api/v1/rest/data/aliasColumns 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: 187 { "aliasColumns" : [ { "aliasKey" : "TARGET_OVERLAPPING_PRODUCT", "dateSourceType" : "TARGET" }, { "aliasKey" : "BOOKED_VALUE", "dateSourceType" : "ORDER_LINE" } ] }
Get alias functions
GET /api/v1/rest/data/aliasFunctions
説明
エイリアス関数のコレクションを読み取る要求を取得します。
Parameters
種類 名前 説明 必須 Schema HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string 応答
HTTP コード 説明 Schema 200 OK AliasFunctions 実行する
application/json
生成する
- application/xml
- application/json
Tags
データ リソース
cURL 要求の例
$ curl 'https://api.appnexus.com/imf/v1/rest/data/aliasColumns' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}'HTTP 要求の例
GET /api/v1/rest/data/aliasColumns 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: 187 { "aliasColumns" : [ { "aliasKey" : "TARGET_OVERLAPPING_PRODUCT", "dateSourceType" : "TARGET" }, { "aliasKey" : "BOOKED_VALUE", "dateSourceType" : "ORDER_LINE" } ] }
消費フィルターを取得する
GET /api/v1/rest/data/consumptionFilters
説明
消費フィルターのコレクションを読み取る要求を取得します。
Parameters
種類 名前 説明 必須 Schema HeaderParameter username Yield Analytics API にアクセスするためのユーザー名 true string HeaderParameter password Yield Analytics API にアクセスするためのパスワード true string 応答
HTTP コード 説明 Schema 200 OK ConsumptionFilters 実行する
application/json
生成する
- application/xml
- application/json
Tags
データ リソース
cURL 要求の例
$ curl 'https://api.appnexus.com/imf/v1/rest/data/consumptionFilters' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}'HTTP 要求の例
GET /api/v1/rest/data/consumptionFilters 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: 82 { "consumptionFilters" : [ "CONSUMPTION_TYPE", "INVENTORY_CLASS", "PRIORITY" ] }
定義
AliasColumn
AliasColumn の要求を保持する JSON オブジェクト。
| 名前 | 必須 | Schema |
|---|---|---|
| aliasKey | false | string |
| dateSourceType | false | string |
AliasColumns
AliasColumns の要求を保持する JSON オブジェクト。
| 名前 | 必須 | Schema |
|---|---|---|
| aliasColumns | false | AliasColumn array |
AliasFunction
AliasFunction の要求を保持する JSON オブジェクト。
| 名前 | 必須 | Schema |
|---|---|---|
| inputs | false | 文字列配列 |
| name | false | string |
AliasFunctions
AliasFunctions の要求を保持する JSON オブジェクト。
| 名前 | 必須 | Schema |
|---|---|---|
| aliasFunctions | false | AliasFunction 配列 |
ConsumptionFilters
ConsumptionFilters の要求を保持する JSON オブジェクト。
| 名前 | 必須 | Schema |
|---|---|---|
| consumptionFilters | false | 文字列配列 |