データ サービス

概要

Yield Analytics Data API では、Yield Analytics 環境内から使用可能なデータと構成を検索するための機能が公開されています。

コンテンツ タイプ

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 へのアクセスは、次のコンテキスト内で行う必要があります。

認証

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

機密性

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

AliasFunction

AliasFunction の要求を保持する JSON オブジェクト。

名前	必須	Schema
入力	false	文字列配列
name	false	string

AliasFunctions

AliasFunctions の要求を保持する JSON オブジェクト。

名前	必須	Schema
aliasFunctions	false	AliasFunction 配列

ConsumptionFilters

ConsumptionFilters の要求を保持する JSON オブジェクト。

名前	必須	Schema
consumptionFilters	false	文字列配列

関連トピック

Yield Analytics API