2015 年 6 月 16 日
AppNexus ImpBus API のバージョン 1.16 に対する次の機能強化をお知らせします。
警告
新機能に加えて、このリリースには破壊的変更が含まれています。 そのため、破壊的 変更 ポリシーに記載されているように、今後 60 日間、2 つのバージョンの API がサポートされます。
バージョン 1.15: このバージョンには破壊的変更 は含まれません 。 エンドポイントは https://api.adnxs.com
、バージョン 1.15 を引き続き 60 日間指します。 その後、このエンドポイントはバージョン 1.16 を指します。
バージョン 1.16: このバージョンには、破壊的変更と新機能 が 含まれています。 次の 60 日間、このバージョンを使用するには、呼び出しで直接指す必要があります (例: https://api.adnxs.com/v1.16
)。
このセクションで説明するすべての変更は、バージョン 1.16 にのみ存在します。
1.16 リリースの時点では、ImpBus API ユーザーに対してサポートされているエンドポイントは (SSL 対応) https://api.adnxs.com
のみです。 セキュリティで保護されていない HTTP エンドポイントはサポートされなくなりました。 その他の URL はサポートされなくなりました。
バージョン 1.16 では、"integerish" 文字列を整数に自動的に変換 (キャスト) し続けます。 たとえば、 "123"
は引き続き に 123
変換されます。
ただし、バージョン 1.16 以降では、このような文字列が整数を予期するフィールドに渡される場合など"foo"
0
、"整数以外" の文字列を自動的に変換するときに API は警告しなくなります。 代わりに、エラーがスローされ、呼び出しは失敗します。
次のエラー メッセージが変更されています。
- メッセージ
"Error occured while processing your request"
が表示される任意の場所で、"発生" のスペルミスを修正するように変更されています。 新しいメッセージは になります"Error occurred while processing your request"
。 - データベース トランザクションが失敗した場合、エラー メッセージは現在
"SYSTEM::updating
" です。 これらのメッセージは、エラーの種類に応じて詳細を提供するように変更されています。 新しいメッセージは次のとおりです。SYSTEM::DEADLOCK_MAX_ATTEMPTS::A database error occurred. Please try your request again.
SYSTEM::DB_UNKNOWN::A database error occurred. Please try your request again.
クリエイティブ サービスには、次の変更が加えられます。
- フィールドは
thirdparty_page_id
、要求と応答のthirdparty_page
両方のオブジェクト内にあります。 - すべてのクリエイティブにテンプレートが必要になりました。 以前に非推奨とされた要素を使用して構成された
format
media_subtype
クリエイティブは機能しなくなります。 オブジェクトでは、 またはPOST
に nullid
以外がtemplate
PUT
必要になりました。
レガシ Bidder プロファイル サービスに対して次の変更が行われています。
フィールドが inventory_source_targets
削除されています。
地域、国、市区町村ベースのターゲット設定を ID 別のターゲットに変更しています。 次のフィールドが更新されています。
フィールドは country_targets
、次のように ID を使用して渡されます。
"country_targets": [
{
"id": 1 // id of US
},
{
"id": 2 // id of AS
}
]
さらに、呼び出しに応答して GET
このフィールドの内容は次のようになります。
"country_targets": [
{
"id": 1,
"name": "United States",
"code": "US"
}
]
ターゲット設定に使用できるすべての国の一覧を表示するには、 に要求をGET
https://api.adnxs.com/country/meta
行います。
フィールドは region_targets
、次のように ID を使用して渡されます。
"region_targets": [
{
"id": 1 // ID of NJ region in US
},
{
"id": 2 // ID of NY region in US
}
]
さらに、呼び出しに応答して GET
このフィールドの内容は次のようになります。
"region_targets": [
{
"id": 1,
"name": "New York",
"code": "NY",
"country_name": "United States",
"country_code": "US"
}
]
サポートされているリージョンの一覧については、 にhttps://api.adnxs.com/region/meta
要求を行うことで、リージョン サービス メタをGET
チェックできます。
フィールドは city_targets
、次の値に若干変更されます ("region_id"
整数は、文字列に "region_code"
置き換えられます)。
"city_targets": [
{
"id": 123,
"name": "Queens",
"region_name": "New York",
"region_code": "NY",
"country_name": "United States",
"country_code": "US"
}
]
ターゲット設定に関心がある都市を City Service で検索するには、次に示すように、名前 (または名前の一部) を使用してサービスを呼び出します。 この例では、名前に文字列 "New"
を含む都市を検索します。
curl -bc https://api.``adnxs``.com/city?like_city=New
変更されたフィールドの種類
サード パーティのページ アクセス サービスでは、フィールドの型が thirdparty_page_id
文字列から整数に変更されています。 これは、Facebookがこのフィールドの数値のみを受け入れるために必要です。
レポートを取得するための新しいメソッド
レポート サービスからレポートを取得するためのメソッドが変更されています。 1.16 リリース以降、ワークフローはコンソール API で使用されるのと同じに変更されます。 具体的には、次の手順を実行します。
- レポート サービスに JSON を使用して
POST
レポートを作成します。 これにより、レポート ID が返されます。 - 手順 1 で受け取ったレポート ID を使用してサービスに要求を行
GET
って、レポートの状態を確認します。 "execution_status"
手順 2 の要求の が の場合、"ready"
レポートをダウンロードするための URL がフィールドに"url"
表示されます。- 最後に、フィールドの内容
"url"
をGET
使用してレポート ダウンロード サービスを呼び出してレポート データを取得します。
レポートダウンロードサービス
サービスは report-download
、応答でより一貫性のある正確なヘッダーを返すようになりました。 これらの応答の場合、JSON は返されません。 可能な戻り値は次のとおりです。
- 200: OK。
- 202: レポート要求が受け入れられ、処理がまだ保留中です。
- 404: レポート ID が指定されていません。
- 405: サポートされていないメソッドが要求されました (
POST
、)。PUT
DELETE
- 410: 消去。レポートが削除されました。
- 500: 内部エラー。 レポート API は、形式が正しくない応答を返し、データを報告できなかったか、またはその他のキャッチされていない例外を返しました。
2015 年 6 月 16 日は削除されています。
次のフィールドを削除するために 、入札要求 を更新しています。
inventory_class
inventory_source_id
このセクションの変更は、API のバージョン 1.15 に適用されます。
Deal From Package Service を使用すると、購入者は既存のパッケージから取引を作成できます。