Oracle Data CloudプラットフォームAPI開発者ガイド

Oracle Data Cloud APIは、Oracle Data Cloudプラットフォームとあなたのアプリケーションの間でJavaScript Object Notation (JSON)データを転送するための標準のHTTPメソッドを使用するRESTful Webサービスです。次の各項では、Oracle Data Cloud APIを表示し、HTTPメソッドとそれらがサポートしているJSONデータ型の概要を説明します。

Oracle Data Cloud APIの使用を開始するには、Oracle Data Cloud APIキーを取得して、対話型のAPIドキュメントの使用方法を学習し、次の表に表示されているAPIをクリックして、Oracle Data Cloudプラットフォームとのインテグレーションに使用する方法を学習してください。

ノート: Oracle Data Cloudのタグとコードには、BlueKaiとbkへの参照が含まれています。これらの参照は、従来のネーミング・ポリシーによるものです。

API

Oracle Data Cloudプラットフォームは、収集したユーザー・データのプログラムによる分類、分析、共有、またはシステムやメディア実行プラットフォームへの配信のための次のAPIを提供しています。

API	説明	サービスURI
オーディエンス	オーディエンスのカテゴリを表示します。ターゲット、モデリング、最適化または分析するファーストパーティ、セカンドパーティ、サードパーティのカテゴリを選択します。	services.bluekai.com/Services/WS/audiences
Audience Discoveryレポート	セグメントの個々のカテゴリで構成された事前定義済オーディエンスに関連するカテゴリのリストを取得します。	services.bluekai.com/Services/WS/WSMultiAudience
オーディエンス権限	オーディエンスをDMPパートナと共有します。	services.bluekai.com/Services/WS/AudienceGrant
バルク収集	ユーザー・データAPIへの多くのコールを1つのHTTPS POSTの本文でバッチ処理します。	bulkapi.bluekai.com/2/api
キャンペーン	DMPパートナにターゲット・オーディエンスを配信するための指示を作成します。	services.bluekai.com/rest/campaigns
カテゴリ	ファーストパーティ・カテゴリをタクソノミに追加します。ターゲット・オーディエンスの作成に使用できるファーストパーティ・カテゴリとサードパーティ・カテゴリを表示します。	taxonomy.bluekai.com/taxonomy/categories
コンテナ	サイト・データまたは一意のユーザーID (UUID)をOracle Data Cloudプラットフォームに渡すためのコンテナを作成します。	services.bluekai.com/Services/WS/sites
国	Oracle Data Cloudプラットフォームでサポートされている国を表示し、それらの国をオーディエンスおよびインベントリ・リーチAPIに渡します。	services.bluekai.com/rest/countries
IDタイプ	カテゴリIDソースに関する情報を取得し、パートナ・シートのIDタイプを作成および管理します。	services.bluekai.com/rest/idTypes
OnRamp	Oracle Data CloudプラットフォームでCRMデータを収集およびアクティブ化します。	portal.datalogix.com/audience-onramp/api/v1/audiences
ping	APIキーを使用してOracle Data Cloudプラットフォームに認証済メッセージ・リクエストを送信できることを検証できます。	services.bluekai.com/Services/WS/Ping
ルールAPI	自分のサイトから収集されたユーザー・データをカテゴリにマッピングする分類ルールを個別に作成します。	services.bluekai.com/rest/taxonomyRuleChains
スケジュール	タグを発火するための指示を指定します。	services.bluekai.com/rest/schedules
セグメント・リーチ	カテゴリ、セグメントおよびオーディエンスの一意のユーザーの推定数を取得します。	services.bluekai.com/Services/WS/SegmentInventory
Self-Classificationカテゴリ	プライベート・タクソノミにファーストパーティのカテゴリを個別に追加します。	services.bluekai.com/Services/WS/classificationCategories
Self-Classificationルール	自分のサイトから収集されたユーザー・データをカテゴリにマッピングする分類ルールを個別に作成します。	services.bluekai.com/Services/WS/classificationRules
タクソノミ (非推奨)	ターゲット・オーディエンスの作成に使用できるファーストパーティ・カテゴリとサードパーティ・カテゴリを表示します。	services.bluekai.com/Services/WS/Taxonomy
タクソノミ・パートナ権限	特定の購入者に対して、プライベート・タクソノミのファーストパーティ・カテゴリをホワイトリスト登録(共有)またはブラックリスト登録(制限)します。	taxonomy.bluekai.com/taxonomy/partnerPermissions
ユーザー・データ	サーバーサイドAPIを使用して、データをOracle Data Cloudプラットフォームに転送したり、プロファイル・ストアに転送します。	api.tags.bluekai.com/getdata/siteID/v1.2
ベンダー	データを収集したりアクティブ化するために、DMPをアプリ・パートナのプラットフォームに接続するように、ベンダーのアプリを構成できます。	services.bluekai.com/rest/vendors

サポートされているデータ形式

Oracle Data Cloud APIでは、JSON形式のデータのみサポートされています。

headers = {"Accept":"application/json","Content-type":"application/json","User_Agent":"Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.1) Gecko/20090624 Firefox/3.5"}

1秒間に10回のコールの制限

各APIには、1秒間に10回のコールの制限があります。この数を超えると、エラーが発生する場合があります。

URL

ほとんどのOracle Data Cloud APIのベースURLは、https://services.bluekai.com/Services/WSです

APIのリソース名がURLに追加されます。たとえば、オーディエンスAPIのURLは、https://services.bluekai.com/Services/WS/audiencesとなります

重要:コールはHTTPS経由で送信する必要があります。非セキュアなHTTPを使用したコールは、403 Forbiddenエラーになります。

HTTPメソッド

Oracle Data Cloud APIでは、オブジェクトやコレクションの取得、読取り、作成、編集、削除のためのGET、POST、PUTおよびDELETEメソッドがサポートされています。POSTおよびPUTメソッドには、リクエストの本文に含める特定のJSON形式のデータが必要です。次の表は、Oracle Data Cloud APIをコールするための構文をまとめたものです。

メソッド	説明	URI
GET (リスト)	項目のコレクションを取得します。	https://services.bluekai.com/Services/WS/resourceName
GET (読取り)	特定の項目を読み取ります。	https://services.bluekai.com/Services/WS/resourceName/?itemId=item_id
POST	新規項目を作成します。	https://services.bluekai.com/Services/WS/resourceName (JSON形式の本文が必要)
PUT	既存の項目を編集します。	https://services.bluekai.com/Services/WS/resourceName (JSON形式の本文が必要)
DELETE	項目を削除します。	https://services.bluekai.com/Services/WS/resourceName/?itemId=item_id

JSONデータ

すべてのPOSTおよびPUTリクエストでは、オブジェクトを作成または更新するために本文にJSON形式のデータが必要です。JSON形式では、判読可能なテキストを使用して、データ・オブジェクトをキーと値のペアの形式で送信します。標準のJSONデータ型は、文字列、整数、ブール、オブジェクト、配列およびnull値で構成されます。

レスポンス・コード

すべてのOracle Data Cloud APIコールは、JSON形式のデータを返します。コールが成功した場合、JSONレスポンスには、ステータス・コード200およびOKに設定されたmsgフィールドが含まれます。POSTおよびPUTレスポンスには、APIリクエストによって返されたオブジェクトのIDが含まれます。

エラー・メッセージ

Oracle Data Cloud APIに無効なリクエストを送信した場合、JSONレスポンスには、エラーが記述されたstatusフィールドとmsgフィールドが含まれます。

さらに学ぶ

Oracle Data Cloud APIコールの認証

FAQ

プログラミングの例