タクソノミ・パートナ権限API

DMPパートナまたはデータ・プロバイダは、タクソノミ・パートナ権限APIを使用して、別のパートナに対して、ファーストパーティ・カテゴリとインベントリの数値をホワイトリスト登録(共有)またはブラックリスト登録(制限)できます。ホワイトリストに登録されたカテゴリを受信したパートナは、カテゴリを所有するDMPユーザーと同じように、Oracle Data Cloudプラットフォームにログインすると、タクソノミ・ツリーからそのカテゴリを表示および選択できます。また、このAPIを使用して、他のパートナに対してホワイトリスト登録またはブラックリスト登録された、プライベート・タクソノミ内のファーストパーティ・カテゴリを表示できます。

タクソノミ権限付与とオーディエンスの共有によって、Oracle Data Cloudプラットフォームのセカンドパーティ・マーケットプレイスが促進されます。オーディエンスの共有では1つのオーディエンスを共有できる一方、タクソノミ権限付与では信頼できるパートナとカテゴリレベルの情報を共有できます。

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

このトピックの内容  

APIについて知る

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

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

taxonomypermissioning.docs.apiary.io/

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

サービスURI

タクソノミ・パートナ権限APIのURIは、次のとおりです。

taxonomy.bluekai.com/taxonomy/partnerPermissions

関連するAPIコール

次に、通常、タクソノミ・パートナ権限APIを使用する前に実行するAPIコールを示します。

タクソノミ・パートナ権限APIの前 ユースケース
カテゴリAPI プライベート・タクソノミにファーストパーティ・カテゴリを追加します。
ルールAPI 自分のサイトから収集されたユーザー・データをカテゴリにマッピングする分類ルールを作成します。
カテゴリAPI DMPユーザーおよびパートナと共有できるファーストパーティ・カテゴリを表示します。

次に、通常、タクソノミ・パートナ権限APIを使用した後に実行するAPIコールを示します。

タクソノミ・パートナ権限APIの後 ユースケース
オーディエンスAPI 最適化またはモデリングされるDMPユーザーからカテゴリを受信します。

スキーマ

タクソノミ・パートナ権限APIスキーマのURIは、次のとおりです。

taxonomy.bluekai.com/taxonomy/partnerPermission.schema

{
  "type" : "object",
  "$schema" : "https://json-schema.org/draft-04/schema#",
  "id" : "#partnerPermission",
  "description" : "The details of a particular partner permission stored at Bluekai",
  "additionalProperties" : false,
  "properties" : {
    "id" : {
      "type" : "integer",
      "description" : "The ID of a partner permission [Read Only Field]",
      "minimum" : 1
    },
    "partner" : {
      "type" : "object",
      "description" : "The Partner of a partner permission",
      "javaType" : "com.oracle.bluekai.types.taxonomy.Partner",
      "properties" : {
        "id" : {
          "type" : "integer",
          "description" : "ID of a partner"
        },
        "name" : {
          "type" : "string",
          "description" : "Name of a partner",
          "minLength" : 1,
          "maxLength" : 255
        }
      }
    },
    "buyer" : {
      "type" : "array",
      "items" : {
        "$ref" : "#stub"
      }
    },
    "whitelistCategories" : {
      "type" : "array",
      "items" : {
        "type" : "integer"
      },
      "description" : "List of category ids that are whitelisted",
      "minItems" : 1
    },
    "blacklistCategories" : {
      "type" : "array",
      "items" : {
        "type" : "integer"
      },
      "description" : "List of category ids that are blacklisted",
      "minItems" : 1
    },
    "notes" : {
      "type" : "string",
      "description" : "Notes for a partner permission",
      "minLength" : 1
    },
    "permissionType" : {
      "enum" : [ "targetingAndAnalytics", "analytics" ],
      "description" : "Describes the taxonomy permission type",
      "default" : "targetingAndAnalytics"
    },
    "createdAt" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Creation date and time [Read Only Field]",
      "minLength" : 20,
      "maxLength" : 25
    },
    "updatedAt" : {
      "type" : "string",
      "format" : "date-time",
      "description" : "Update date and time [Read Only Field]",
      "minLength" : 20,
      "maxLength" : 25
    }
  },
  "required" : [ "partner", "buyer" ]
}

権限のリスト

すべてのタクソノミ・パートナ権限を表示するには、次のGETコールを実行します。

taxonomy.bluekai.com/taxonomy/partnerPermissions?pid=yourPartnerID&bkuid=BKUID&bksig=BKSIG

pidの値は、ユーザー・アカウントが複数のパートナ・シートに関連付けられている場合にのみ必要です。

サンプル・リスト・レスポンス:

{
  "items" : [ {
    "id" : 19795,
    "partner" : {
      "id" : 2208,
      "name" : "Example Partner"
    },
    "buyer" : [ {
      "id" : 2362,
      "name" : "Example Buyer 1"
    } ],
    "whitelistCategories" : [ 338800, 344778 ],
    "blacklistCategories" : [ 339307, 339298, 339301 ],
    "permissionType" : "targetingAndAnalytics",
    "createdAt" : "2016-05-24T17:57:22-05:00",
    "updatedAt" : "2016-06-03T16:01:07-05:00"
  }, {
    "id" : 19833,
    "partner" : {
      "id" : 2208,
      "name" : "Example Partner"
    },
    "buyer" : [ {
      "id" : 1392,
      "name" : "Example Buyer 2"
    } ],
    "whitelistCategories" : [ 287744 ],
    "permissionType" : "analytics",
    "createdAt" : "2016-06-03T17:13:15-05:00",
    "updatedAt" : "2016-06-03T17:13:15-05:00"
  }, {
    "id" : 19859,
    "partner" : {
      "id" : 2208,
      "name" : "Example Partner"
    },
    "buyer" : [ {
      "id" : 1739,
      "name" : "Example Buyer 3"
    } ],
    "whitelistCategories" : [ 287744 ],
    "blacklistCategories" : [ 338799 ],
    "permissionType" : "analytics",
    "createdAt" : "2016-06-08T15:55:27-05:00",
    "updatedAt" : "2016-06-08T18:33:00-05:00"
  }, {
    "id" : 20154,
    "partner" : {
      "id" : 2208,
      "name" : "Example Partner"
    },
    "buyer" : [ {
      "id" : 486,
      "name" : "Example Buyer 4"
    } ],
    "whitelistCategories" : [ 287744 ],
    "permissionType" : "targetingAndAnalytics",
    "createdAt" : "2016-08-19T16:04:06-05:00",
    "updatedAt" : "2016-08-19T16:04:06-05:00"
  } ],
  "totalResults" : 4,
  "offset" : 0,
  "count" : 4,
  "hasMore" : false
}

権限の作成

タクソノミ・パートナ権限を作成するには、POSTコールを実行し、このとき、パートナID、購入者ID、および1つ以上のホワイトリスト登録またはブラックリスト登録されたファーストパーティ・カテゴリのリストを本文に含めます。

サンプルPOSTリクエスト

taxonomy.bluekai.com/taxonomy/partnerPermissions?pid=yourPartnerID&bkuid=BKUID&bksig=BKSIG

pidの値は、ユーザー・アカウントが複数のパートナ・シートに関連付けられている場合にのみ必要です。

サンプル本文 

{
	"partner": {
		"id": 2208
	},
	"buyer": [{
		"id": 2362
	}],
	"whitelistCategories": [828103],
	"permissionType": "targetingAndAnalytics"
}

ノート:タクソノミ権限は、購入者ごとに1つのみが許可されます。タクソノミ権限を作成(POSTコール)した後、同じ購入者について、追加のカテゴリをホワイトリスト登録またはブラックリスト登録するように、更新(PUTコール)する必要があります。

GETレスポンス、POSTレスポンスおよびPUTレスポンスのサマリー

タクソノミ・パートナ権限APIのGETリクエストでは、DMPユーザーまたはパートナと共有しているファーストパーティ・カテゴリが返されます。次に、共有されたそれぞれのファーストパーティ・カテゴリに含まれるプロパティを示します。

プロパティ タイプ 説明
blacklistCategories 配列 DMPユーザーまたはデータ購入者に対して、ブラックリストに登録されたカテゴリIDのカンマ区切りリスト
buyer 配列 (必須) whitelistCategoriesで指定されたファーストパーティ・カテゴリを共有する対象である、DMPユーザーまたはデータ購入者(パートナIDや名前など)を記述する配列
createdAt 文字列 2017-03-10T08:03:13-05:00などの、タクソノミ権限が作成された時間を示すタイムスタンプ
id 整数 タクソノミ・パートナ権限に割り当てられたユニークID
notes 文字列 タクソノミ・パートナ権限のユーザー指定のサマリー
partner オブジェクト (必須)パートナ・シートを(パートナIDや名前を含めて)記述するオブジェクト。ユーザー・アカウントに複数のパートナ・シートを関連付けた場合、リクエストにpidの値を含めて、対象のパートナ・シートのIDを指定できます。
permissionType 列挙 targetingAndAnalytics (デフォルト)またはanalyticsのタクソノミ権限のタイプ
updatedAt 文字列 タクソノミ権限が最後に変更された時間を示すタイムスタンプ
whitelistCategories 配列 DMPユーザーまたはデータ購入者に対して、ホワイトリストに登録されたカテゴリIDのカンマ区切りリスト

さらに学ぶ

Oracle Data Cloud APIの概要

データを共有するためのタクソノミ権限の使用方法