Show Menu
トピック×

APIを使用したデータ使用ラベルの管理

このドキュメントでは、Catalog Service APIを使用して、データセットレベルおよびフィールドレベルでデータ使用量ラベルを管理する方法について手順を説明します。

はじめに

このガイドを読む前に、 カタログサービスの概要を読んで、サービスのより強力な概要を確認することをお勧めします 。 また、カタログAPIを呼び出すために必要な資格情報を収集するには、カタログ開発者ガイドの はじめに 「はじめに」の節に説明されている手順に従う必要があります。
以下の節で説明するエンドポイントを呼び出すには、特定のデータセットに固有の id 値を持つ必要があります。 この値がない場合は、カタログオブジェクトの リスト表示に関する開発者ガイドの節を参照して、既存のデータセットのIDを確認してください

データセットのラベルを検索する

GETリクエストを作成して、既存のデータセットに適用されているデータ使用量ラベルを調べることができます。
API形式
GET /dataSets/{DATASET_ID}/labels

パラメーター
説明
{DATASET_ID}
ラベルを調べるデータセットの固有 id 値。
リクエスト
curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5abd49645591445e1ba04f87/labels' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功した場合は、データセットに適用されたデータ使用量ラベルが返されます。
{
  "AEP:dataset:5abd49645591445e1ba04f87": {
    "imsOrg": "{IMS_ORG}",
    "labels": [ "C1", "C2", "C3", "I1", "I2" ],
    "optionalLabels": [
      {
        "option": {
          "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
          "contentType": "application/vnd.adobe.xed-full+json;version=1",
          "schemaPath": "/properties/repositoryCreatedBy"
        },
        "labels": [ "S1", "S2" ]
      }
    ]
  }
}

プロパティ
説明
labels
データセットに適用されたデータ使用量ラベルのリスト。
optionalLabels
データセット内の個々のフィールドのリストで、データ使用ラベルが適用されています。

データセットへのラベルの適用

POSTまたはPUTリクエストのペイロードにラベルを提供することで、データセット用の一連のラベルを作成できます。 これらのいずれかの方法を使用すると、既存のラベルが上書きされ、ペイロードに指定されたラベルに置き換えられます。
API形式
POST /dataSets/{DATASET_ID}/labels
PUT /dataSets/{DATASET_ID}/labels

パラメーター
説明
{DATASET_ID}
ラベルを作成するデータセットの固有 id 値。
リクエスト
次のPOSTリクエストでは、一連のラベルと、そのデータセット内の特定のフィールドを追加します。 ペイロードに指定されるフィールドは、PUT要求に必要なフィールドと同じです。
curl -X POST \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5abd49645591445e1ba04f87/labels' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
  "labels": [ "C1", "C2", "C3", "I1", "I2" ],
  "optionalLabels": [
    {
      "option": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
        "contentType": "application/vnd.adobe.xed-full+json;version=1",
        "schemaPath": "/properties/repositoryCreatedBy"
      },
      "labels": [ "S1", "S2" ]
    }
  ]
}'

プロパティ
説明
labels
データセットに追加するデータ使用ラベルのリストです。
optionalLabels
データセット内でラベルを追加する個々のフィールドのリスト。 この配列の各アイテムは、次のプロパティを持つ必要があります。
option : フィールドのエクスペリエンスデータモデル(XDM)属性を含むオブジェクトです。 次の3つのプロパティが必要です。
  • id: フィールドに関連付けられているスキーマのURI $id 。
  • contentType: スキーマのコンテンツタイプとバージョン番号。 これは、XDMルックアップ要求に対して有効な リソースの検索 Acceptヘッダーの1つの形式にする必要があります 。
  • schemaPath: データセットのスキーマ内のフィールドへのパス。
labels : フィールドに追加するデータ使用ラベルのリストです。
応答
正常に完了すると、データセットに追加されたラベルが返されます。
{
  "labels": [ "C1", "C2", "C3", "I1", "I2" ],
  "optionalLabels": [
    {
      "option": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
        "contentType": "application/vnd.adobe.xed-full+json;version=1",
        "schemaPath": "/properties/repositoryCreatedBy"
      },
      "labels": [ "S1", "S2" ]
    }
  ]
}

データセットのラベルの削除

DELETEリクエストを行うと、データセットに適用されたラベルを削除できます。
API形式
DELETE /dataSets/{DATASET_ID}/labels

パラメーター
説明
{DATASET_ID}
ラベルを削除するデータセットの固有 id 値。
リクエスト
curl -X DELETE \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5abd49645591445e1ba04f87/labels' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功した応答HTTPステータス200 (OK)。ラベルが削除されたことを示します。 別の呼び出しで、データセットの既存のラベルを 調べて 、これを確認できます。

次の手順

データセットレベルとフィールドレベルでデータ使用量ラベルを追加したら、Experience Platformにデータを取り込み始めます。 詳しくは、 データ取り込みに関するドキュメントを参照して開始
適用したラベルに基づいてデータ使用ポリシーを定義できるようになりました。 詳しくは、「 データ使用ポリシーの概要 」を参照してください。