ベンダーAPI

ベンダーWebサービスを使用してアプリ・パートナのプラットフォームにDMPを接続するように、ベンダーのアプリを構成できます。ベンダーのアプリとオーディエンスをキャンペーンに関連付けたら、キャンペーンをアクティブ化してデータ配信を開始できます。

ノート: ユーザーがOracle Data CloudプラットフォームUIでキャンペーンを作成することはなくなりました。キャンペーン・ワークフローは、オーディエンス・ワークフローの一部になりました。ただし、プラットフォームでは引き続きキャンペーンを使用して、オーディエンス・データ配信を管理できます。キャンペーンは、UIユーザーがオーディエンスを配信する際に自動的に作成されます。APIでは、以前と同様にキャンペーンを作成して使用します。

このトピックの内容  

APIについて知る

次の埋込みI/Oドキュメントを参照して、APIについての理解を深めることができます。I/Oドキュメントでは、各メソッドのパラメータについて説明し、コールのテンプレートを提供しています。ただし、ツールからライブAPIコールを実行することはできません。

次のリンクを新しいタブで開くと、I/Oドキュメントが3つのペインの形式で表示されます。

vendors3.docs.apiary.io

このAPIの詳細は、My Oracle Support (MOS)にお問い合せください。

サービスURI

ベンダーAPIのURIは、次のとおりです。

services.bluekai.com/rest/vendors

スキーマ

ベンダーAPIスキーマのURIは、次のとおりです。

services.bluekai.com/rest/vendor.schema

関連するAPIコール

次に、通常、ベンダーAPIを使用した後に実行するAPIコールを示します。

ベンダーAPIの後 ユースケース
オーディエンスAPI キャンペーンとアプリで使用するオーディエンスを作成および管理します。
キャンペーンAPI DMPパートナにターゲット・オーディエンスを配信するための指示を作成します。

GETレスポンスとPOSTレスポンスのサマリー

ベンダーAPIのGETレスポンスとPOSTレスポンスには、返される各ベンダーについての次の情報が含まれます。

プロパティ タイプ 説明
attributes 配列 ベンダーの詳細を示す、キーと値のペアの配列
campaign 配列 ベンダーに関連付けられているキャンペーンを記述するオブジェクト。
このプロパティの詳細は、キャンペーンAPIを参照してください。
createdAt 文字列 ベンダーが作成された時間を示す、ISO 8601の日時書式(yyyy-MM-dd'T'HH:mm:ssZ)のタイムスタンプ
例: 2017-03-18T17:46:32-05:00
id 整数 ベンダーに割り当てられた一意の識別子
name 文字列 Oracle Modeling 360 configurationなどの、ベンダーのアプリのユーザー指定の名前
partnerId 整数 2345などの、Oracle Data Cloudプラットフォームの関連するパートナに割り当てられたユニークID
permissionedCategoryIds 配列

ホワイトリストに登録されたカテゴリIDの配列
詳細は、タクソノミ・パートナ権限APIを参照してください。

pricingModel 配列 請求およびレポートに使用される価格設定モデルを(namedescriptionおよびidを含めて)記述するオブジェクト。
idは、次のいずれかになります。
  • 1: CPS
  • 2: CPM
  • 3: FlatFee
  • 4: 検索
  • 5: 支出の%
  • 6: IOで設定
profileInputs 配列 関連するオーディエンスの行動とデモグラフィックのプロファイルを(カテゴリおよびパートナIDを含めて)記述するオブジェクト
solutionType 配列 キャンペーン・ソリューションのタイプを(次のパラメータを含めて)記述するオブジェクト:
  • id: ルックアライク・モデリングの6などの、ソリューション・タイプの数値ID
  • name: lookalikeなどの、ソリューション・タイプの名前
  • systemName: nameに対応するシステム名
  • description: ソリューション・タイプの説明
  • type: ソリューションのタイプ
idパラメータは、次のキャンペーン・タイプのいずれかを示します。
  • 1: メディア・ターゲッティング
  • 2: ダイナミック・クリエイティブ最適化(DCO)
  • 3: サイトサイド最適化(SSO)
  • 5: 検索
  • 6: ルックアライク・モデリング
status 文字列 ベンダーがactive (デフォルト)かdeletedかを示します。
updatedAt 文字列 Oracle Data Cloudプラットフォームでベンダーが最後に変更された時間を示す、ISO 8601の日時書式(yyyy-MM-dd'T'HH:mm:ssZ)のタイムスタンプ。例: 2017-04-18T17:46:32-05:00
vendorTemplate 配列 関連するベンダー・テンプレートの値を含むオブジェクト

レスポンスのエラー

最新のエラー・コードを確認するには、services.bluekai.com/rest/vendors.errors?bkuid=bkUID&bksig=signedStringをコールします。

リクエストが失敗した場合、レスポンスでは次のいずれかのエラー・メッセージが使用されます。

エラー・コード 説明
BK-10001 Could not find resource for the specified path
BK-10002 Bad query parameters
BK-10003 Invalid JSON input
BK-10004 Input JSON does not pass schema validation
BK-10005 Input JSON contains bad property
BK-10006 Input JSON has missing properties
BK-10007 Input JSON has bad property that does not match min length requirement
BK-10008 Input JSON has bad property that does not match max length requirement
BK-10009 Not enough privileges to access requested resource
BK-10010 The request could not be completed by the service due to malformed data or syntax
BK-10011 Incorrect sorting parameter
BK-10012 Additional properties detected.Schema does not allow extra properties to be present
BK-10013 Incorrect expand parameter
BK-10014 Incorrect q query parameter syntax
BK-10015 Property has unacceptable/bad format
BK-10016 Property value does not appear on the list of acceptable values
BK-10017 Array must not contain duplicate entries
BK-43001 ベンダーが見つかりませんでした
BK-43002 価格設定モデルが必要です
BK-43003 ソリューション・タイプが必要です
BK-43004 ベンダー・テンプレートが必要です
BK-43005 サードパーティの識別子が必要です
BK-43006 ユーザー名が必要です
BK-43007 パスワードが必要です
BK-43008 アクセス・トークンが必要です
BK-43009 クライアント・コードが必要です
BK-43010 AdboxのURLが必要です
BK-43011 収集タイプが必要です
BK-43012 EloquaのインストールIDが必要です
BK-43013 EloquaのサイトIDが必要です
BK-43014 EloquaのPOD APIのURLが必要です
BK-43015 該当するソリューション・タイプではベンダー・テンプレートまたは価格設定モデルがサポートされていません
BK-43016 ベンダー属性が無効です
BK-43017 連絡先情報が必要です
BK-43018 データの粒度のキャンペーンが必要です
BK-43019 データの粒度のカテゴリが必要です
BK-43020 ベンダー・テンプレートの変更は禁止されています
BK-43021 広告主が必要です
BK-43022 通貨コードが必要です
BK-43023 権限付与されたカテゴリIDが必要です
BK-43024 プロファイル入力が必要です
BK-43025 プロファイル入力名が必要です
BK-43026 プロファイル入力IDが必要です
BK-43027 プロファイル入力のカテゴリIDが必要です
BK-43028 選択されたアプリのIDスワップ・ピクセルURLが正しくありません
BK-43029 このアプリ・パートナにはすでにIDスワップ・ピクセルが構成されています
BK-43030 連絡先情報に無効な電子メール・アドレスが含まれています

さらに学ぶ

アプリのインストール

日付書式