カテゴリAPI

カテゴリAPIを使用して、使用可能なすべてのカテゴリが含まれる階層ツリー構造であるOracle Data Cloudタクソノミのカテゴリ・データを取得作成更新およびフィルタ処理できます。タクソノミからカテゴリを選択し、OR論理を使用してカテゴリをセグメントにグループ化することでターゲット・オーディエンスを作成した後、ANDまたはNAND論理を使用して個々のセグメントを含めたり除外できます。

重要: カテゴリAPIでは、Self-ClassificationカテゴリおよびタクソノミAPIは非推奨になっています。古いAPIを使用している場合、追加パラメータのメリットを活用するには、このAPIに移行する必要があります。これらの新機能には、タクソノミの任意の場所にカテゴリを作成する機能や、Oracle Data Cloudサービス・チームによって作成されたカテゴリを編集する機能、新しい所有者と公開ビューを使用してファーストパーティ・カテゴリやサードパーティ・カテゴリを取得する機能、(国やIDソースで)カテゴリのリーチを表示する機能などがあります。

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

このトピックの内容  

APIについて知る

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

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

categories15.docs.apiary.io/

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

サービスURI

カテゴリAPIのURIは、次のとおりです。

taxonomy.bluekai.com/taxonomy/categories

スキーマ

カテゴリAPIスキーマのURIは、次のとおりです。

taxonomy.bluekai.com/taxonomy/categories/category.schema

キャンペーンの読取り

キャンペーンの情報を取得するには、次のGETコールに示すように、そのIDを指定します。

taxonomy.bluekai.com/taxonomy/categories/categoryID&bkuid=BKUID&bksig=BKSIG

たとえば、/taxonomy/categories/288885へのGETコールにより、次のレスポンスが返されます。

{
  "id" : 288885,
  "name" : "Cat Owner",
  "parentCategory" : {
    "id" : 288884
  },
  "description" : "ACXM Interest, Pet Owner, Cat Owner",
  "partner" : {
    "id" : 303,
    "name" : "Acxiom Corporation"
  },
  "vertical" : {
    "id" : 23,
    "name" : "Branded Data - Acxiom"
  },
  "isPublicFlag" : true,
  "isForNavigationOnlyFlag" : false,
  "ownershipType" : "thirdParty",
  "isLeafFlag" : true,
  "pathFromRoot" : {
    "ids" : [ 344, 24148, 150555, 319645, 288849, 288884, 288885 ],
    "names" : [ "ROOT", "Branded Data", "Acxiom", "Basic Rate", "ACXM Interest", "Pet Owner", "Cat Owner" ]
  },
  "status" : "active",
  "links" : [ ]
}

レスポンス・プロパティ

プロパティ タイプ 説明
buyerPrice 整数 カテゴリ・プロバイダによって現在の購入者に対して設定された価格。このプロパティは、universalPriceの値を上書きします。値が-1の場合、カテゴリに購入者固有の価格が設定されていません。
categoryPrice 整数 購入者の実際のカテゴリ価格。この値は、購入者固有のレート・カードで上書きされないかぎり、一般的には、universalPriceの値と同じになります。
description 文字列 親ノードのパスが含まれるカテゴリの説明
id 整数 カテゴリに割り当てられているユニークID
isForNavigationOnlyFlag ブール trueの場合、このカテゴリはナビゲーションに使用される親ノードとなり、オーディエンスに追加できません。デフォルト値はfalseです。
isLeafFlag ブール (読取り専用) trueの場合、このカテゴリは現在のリクエストのビューにおけるリーフ・ノード(タクソノミ・パスの最後のノード)になります。
isPublicFlag ブール (読取り専用) trueの場合、カテゴリはパブリックです。デフォルト値はfalseです。
links 配列 追加メタデータへのリンクのリスト(該当する場合)
name 文字列 (必須)カテゴリ・ノードの名前
ownershipType 文字列 (読取り専用)データ所有権のタイプを示し、次のいずれかになります。
  • firstParty: プライベートのファーストパーティ・タクソノミ内のカテゴリ
  • secondParty: 別のDMPパートナと共有しているプライベート・カテゴリ
  • thirdParty: すべてのDMPパートナが使用できるカテゴリ
parentCategory オブジェクト (必須)カテゴリの親ノードに割り当てられているユニークIDと名前が含まれるオブジェクト
partner オブジェクト (必須)カテゴリの所有者を(パートナIDや名前を含めて)記述するオブジェクト
pathFromRoot オブジェクト ルートからカテゴリまでのフルパスにおけるIDの配列を含むオブジェクト
status 文字列

カテゴリのステータスを示し、次のいずれかになります。

  • active: カテゴリはアクティブです。
  • deleted: カテゴリは削除されました。
  • draft: Oracleの内部使用のみ
universalPrice 整数 購入者固有のレート・カードで上書きされないかぎり、すべての購入者に対して設定されたデフォルトのカテゴリ価格
vertical オブジェクト このカテゴリのトップレベル・カテゴリ

カテゴリのリスト

様々な問合せパラメータを組み合せて、フィルタ処理された一連のカテゴリをリクエストできます。

所有しているすべてのカテゴリのリスト

自分が所有しているすべてのカテゴリを表示するには、次のGETコールに示すように、必須のviewおよびpartner.idパラメータを指定します。

taxonomy.bluekai.com/taxonomy/categories?view=OWNER&partner.id=partnerID&bkuid=BKUID&bksig=BKSIG

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

パブリック・カテゴリのリスト

すべてのパブリック(サードパーティ)・カテゴリを表示するには、次のGETコールに示すように、view=PUBLICおよびパートナIDを指定します。

taxonomy.bluekai.com/taxonomy/categories?view=PUBLIC&partner.id=partnerID&bkuid=BKUID&bksig=BKSIG

ノート: このコールには多くのカテゴリが含まれている可能性があるため、レスポンスを取得するまで時間がかかる場合があります。

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

カテゴリの購入者ビューのリスト

すべてのパブリック(サードパーティ)・カテゴリおよびプライベート(管理対象)ツリーとSelf-Classificationツリーのファーストパーティ・カテゴリやセカンドパーティ・カテゴリを表示するには、次のGETコールに示すように、view=BUYERおよびパートナIDを指定します。

taxonomy.bluekai.com/taxonomy/categories?view=BUYER&partner.id=partnerID&bkuid=BKUID&bksig=BKSIG

ノート: このコールには多くのカテゴリが含まれている可能性があるため、レスポンスを取得するまで時間がかかる場合があります。

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

リーチのないカテゴリのリスト例

次のリスト・コールは、ルート・カテゴリ(parentCategory.id=344)から4レベル(numOfLevels=4)の深さまでのすべてのカテゴリをリクエストします。デフォルトでは、レスポンスには各カテゴリのリーチ統計は含まれません。

https://taxonomy.bluekai.com/taxonomy/categories?parentCategory.id=344&numOfLevels=4&partner.id=partnerID&view=BUYER&bkuid=BKUID&bksig=BKSIG

リーチ統計のないサンプル・リスト・レスポンス:

リーチのあるカテゴリのリスト例

次のリスト・コールは、4レベルの深さまでのすべてのカテゴリをリクエストし、showReach=trueを指定しているため各カテゴリのリーチ統計が含まれます。

https://taxonomy.bluekai.com/taxonomy/categories?parentCategory.id=344&numOfLevels=4&partner.id=partnerID&showReach=true&view=BUYER&bkuid=BKUID&bksig=BKSIG

レスポンスには、"reach" : integerを指定する各カテゴリのstatsオブジェクトが含まれます。

重要: showReachtrueに設定した場合、返されるカテゴリの数と、指定されたオプションによっては、レスポンス時間が大幅に長くなる可能性があります。

リーチ統計のあるサンプル・リスト・レスポンス:

カテゴリのエクスポート

カテゴリをエクスポートするには、次の例に示すように、必要な問合せパラメータでGETリクエストをフィルタ処理します。

/taxonomy/categories/export?view=BUYER&partner.id=2208&showReach=true&parentCategory.id=17&parentCategory.id=3&numOfLevels=1

サンプル・レスポンス:

17      Autos   ROOT>In-Market>Autos    3       252351600
3       In-Market       ROOT>In-Market  344     1016820000

ノート: エクスポートでは、addStatsパラメータはサポートされません。

カテゴリの作成

カテゴリを作成するには、次のPOSTコールにパートナIDとリクエスト本文を含めます。

/taxonomy/categories?partner.id={yourPartnerId}

必須フィールドを指定するサンプル・リクエスト本文:

バルク作成

複数のカテゴリを作成するには、次のPOSTコールにパートナIDとリクエスト本文を含めます。

/taxonomy/categories?partner.id={yourPartnerId}

複数のカテゴリを指定するサンプル・リクエスト本文:

バルク・インポート(ファイル・アップロード経由)

TSVまたはTXTファイルのアップロードによる、複数のカテゴリを同時に作成と編集するには:

  1. カテゴリAPIへのコールの問合せ文字列で、パスにimportを追加します。

    serviceUrl = 'https://taxonomy.bluekai.com/taxonomy/categories/import?partner.id={yourPartnerId}'

  2. headersフィールドで、Content-Typemultipart/form-dataに設定します。

    headers = {"Content-Type": "multipart/form-data; "Accept": "application/json","User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:22.0) Gecko/20100101 Firefox/22.0"}

  3. インポートする.tsvまたは.txtファイルの名前に設定されるパラメータを含めます。
  4. インポート・ファイルに次の列があることを確認します。
    フィールドデータ型必須かどうか説明
    Id文字列必須(カテゴリの編集の場合)カテゴリに割り当てられているユニークID。バルク・インポート経由でカテゴリを編集する場合、この列は必須となります。これは、バルク・インポートでは、一意のカテゴリIDに基づいてカテゴリが識別されるためです。
    Name文字列オプション簡潔なカテゴリ固有の名前。タクソノミでは、カテゴリはこの名前で表示されます。最大255文字の名前を指定できます。カテゴリの名前を変更する場合は、名前を指定することのみが必要です。
    Path文字列必須(カテゴリの追加の場合)カテゴリのタクソノミのフルパス。バルク・インポート経由でカテゴリを追加する場合、この列は必須となります。これは、バルク・インポートではタクソノミにカテゴリを追加する場所を決定するためです。
    ParentCategory整数オプション(カテゴリを移動する場合は必須)タクソノミの選択したカテゴリのすぐ上にあるカテゴリに割り当てられるユニークID。バルク・インポート経由でカテゴリを移動する場合、この列は必須となります。
    Description文字列オプションこのカテゴリに含まれているユーザーのタイプの詳細なサマリー。最大255文字の説明を指定できます。
    Status列挙オプションカテゴリをアクティブ状態にするかドラフト状態にするかを選択します。この設定のデフォルト値は、親カテゴリに基づきます。親カテゴリのステータスを変更すると、その下のすべての子カテゴリのステータスも更新されます。親ノードがドラフト状態の場合、その子ノードのいずれかをアクティブにすることはできません。
    • Active。カテゴリはタクソノミに公開されます。つまり、オーディエンス・ビルダーとタクソノミ・ビューアに表示され、オーディエンスに追加したり、他のクライアントと共有できます。
    • Draft。カテゴリは、Taxonomy Managerにのみ表示されます。オーディエンス・ビルダーおよびタクソノミ・ビューアで使用できず、共有できません。
    NavigationOnlyブールオプションこのカテゴリの機能を、ユーザー・プロファイル・データの格納、インベントリの累積またはオーディエンスへの追加が不可能な親ノードに制限します。ナビゲーション・ノードは、基本的には1つ以上の子カテゴリのフォルダとして機能します。デフォルト値はfalseです。
    ExcludeFromAnalyticsブールオプションカテゴリをオーディエンス・アナリティクス・レポートから除外します。デフォルト値はfalseです。
    MutuallyExclusiveChildrenブールオプションこのカテゴリの下の子カテゴリを相互排他的にします(最近タグ付けされた子カテゴリのみがユーザーのプロファイル内にあります)。相互排他的な子カテゴリのフラット・リストのみ作成できます。相互排他的なカテゴリの下に子カテゴリを含めることはできません。ただし、相互排他的なカテゴリをナビゲーション専用ノードとしてマークした場合を除きます

バルク・インポートのデモ

サンプルのbulk_categories_import.py Pythonコードは、カテゴリAPIを使用したバルク・カテゴリ・インポートの実行方法を示します。このスクリプトの実行に必要なものは、次のとおりです。

リクエスト・ライブラリのインストールに役立つPIP (Python Package Installationツール)を使用できます。PIPをダウンロードしてインストールするには、リクエスト・ライブラリをインストールしてPIPインストール・ファイルを削除し、コンソールに次のコマンドを入力します。

curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
sudo python get-pip.py
sudo pip install requests
rm get-pip.py

このスクリプトを実行するには、編集または作成するカテゴリが含まれるcategory_import.tsvという名前のTSVファイル(テンプレートのダウンロード)を作成し、次のパラメータを指定する必要があります。

  • url: Oracle Data Cloudプラットフォームの本番環境のURL (services.bluekai.com)
  • verbosity: 印刷情報の一連の4つの詳細オプションを入力します。
  • partnerid: カテゴリをアップロードするシートに関連付けられているパートナID。
  • bkuid: Webサービス・ユーザー・キー
  • bksecretkey: Webサービス秘密キー

次の例は、このスクリプトをコールするために必要な構文を示しています。

bulk_categories_import.py --url https://services.bluekai.com -v -v -v -v --partnerid Partner ID--bkuid WebServiceUserKey --bksecretkey WebServicePrivateKey

カテゴリの更新

プライベート・タクソノミのカテゴリを更新するには、PUTコールに、パートナIDとカテゴリIDが含まれるリクエスト本文を含めます。

サンプルPUTリクエスト:

/taxonomy/categories/{categoryId?partner.id={yourPartnerId}

カテゴリ値を指定するサンプル・リクエスト本文:

一括更新

プライベート・タクソノミの複数のカテゴリを更新するには、PUTコールのリクエスト本文で、それらのカテゴリを指定します。

サンプル・バルクPUTリクエスト:

/taxonomy/categories?partner.id={yourPartnerId}

複数のカテゴリへの更新を指定するサンプル・リクエスト本文:

問合せパラメータ

カテゴリAPIでは、次の問合せパラメータがサポートされています。

パラメータ タイプ 説明
addStats ブール trueに設定すると、指定したカテゴリの様々な統計情報(リーチなど)が含まれるstatsオブジェクトが返されます。デフォルト値はfalseです。
例: &addStats=true
注意: エクスポートでは、このパラメータはサポートされません。
countryCode 文字列 カテゴリの統計情報を制限する国の2文字のコード。他の値を指定しないかぎり米国にデフォルト設定されます。詳細は、国APIを参照してください。
例: &showReach=true&countryCode=GB
deviceType 文字列 (非推奨) desktopまたはmobileを指定して、デバイス・タイプで統計情報を問い合せます。
例: &addStats=true&deviceType=mobile
expand ブール trueに設定すると、詳細が返されます。このパラメータは、TSVファイルのエクスポートにのみ使用されます。デフォルト値はfalseです。
例: &expand=true
idTypes 整数

次のいずれかの標準タイプのIDソースでフィルタ処理します。

  • 1: Oracle Data Cloudサードパーティ・デスクトップCookie ID

  • 2: Oracle Data Cloud Mobileの統計ID

  • 3: Oracle Data Cloud MobileのCookie ID

  • 6: Google Advertising ID (AdID)

  • 9: Apple IDFA

例: &showReach=true&idTypes=9
numOfLevels 整数 カテゴリ・ツリー検索をレベルで制限します
parentCategory.id 整数 親カテゴリのIDを指定します。
デフォルト値は、ルート・カテゴリである344です。例: &parentCategory.id=17
partner.id 整数 (必須)親のユニークID
このパラメータは、viewなどの他のパラメータとともに使用できます。
例: &partner.id=1234
q 文字列

返されたカテゴリをidまたはnameプロパティに従ってフィルタ処理します。演算子: eq (等しい)をidとともに使用し、co (二重引用符で囲まれた文字列を含む)をnameとともに使用します。フィルタ式を含む問合せを発行したコンテキストによっては、パーセントエンコーディングを使用することが必要になる場合があります。たとえば、問合せをcURLコマンドとして実行する場合、フィルタ式では空白を%20に、文字列を囲む二重引用符を%22に置き換える必要があります。

例: https://taxonomy.bluekai.com/taxonomy/categories?view=BUYER&partner.id=2680&q=name%20co%20%22Cloud%22

recency 整数 ユーザーがカテゴリのカテゴリ属性で最後にタグ付けされた時点からの最大日数を指定します(デフォルトは90日)。この数値は、リーチを計算するために使用されます。
例: addStats=true&recency=2
showPriceAt 日付 ISO 8601の日時書式(yyyy-MM-dd'T'HH:mm:ssZ)の日付で、その日付での価格を決定します。例: showPriceAt=2017-06-18T17:46:32-05:00
showReach ブール trueに設定した場合、指定したカテゴリのインベントリの数値が含まれます。
showReachtrueに設定した場合、返されるカテゴリの数と、指定したオプションによっては、レスポンス時間が大幅に長くなる可能性があります。
view 文字列 (必須)次の値に基づいてレスポンスをフィルタ処理します。
  • BUYER: タクソノミ内のすべてのファーストパーティ・カテゴリとセカンドパーティ・カテゴリおよびOracle Data Marketplaceのサードパーティ・カテゴリを返します。サンプル・レスポンスを参照してください。
  • OWNER: 所有者のタクソノミ内のすべてのファーストパーティ・カテゴリを返します。サンプル・レスポンスを参照してください
  • PUBLIC: Oracle Data Marketplace内のすべてのサードパーティ・カテゴリを返します。サンプル・レスポンスを参照してください
viewパラメータでpartner.idを含める必要があります。

例: taxonomy.bluekai.com/taxonomy/categories?view=OWNER&partner.id=1234

FAQ

関連するAPIコール

次に、通常、カテゴリAPIを使用した後に実行するAPIコールを示します。

カテゴリAPIの後 ユースケース
オーディエンスAPI カテゴリを使用して、ターゲッティング、モデリング、最適化または分析を実施するオーディエンスを作成します。
キャンペーンAPI パートナにオーディエンスを配信するための指示を作成します。
セグメント・リーチAPI オーディエンスの個々のカテゴリとセグメントのリーチ(一意のユーザーの推定数)を取得します。
タクソノミ・パートナ権限API ファーストパーティ・カテゴリへのアクセスを共有または制限します。

さらに学ぶ

ルールAPI

タクソノミの管理

パーセントエンコーディング