プロファイル書き出しジョブエンドポイント

最終更新日： 2023-11-14

トピック：
Profiles
このトピックの詳細を表示

作成対象：
Developer

User

Admin

Leader

Real-Time Customer Profile を使用すると、属性データと行動データの両方を含む複数のソースからのデータを統合し、個々の顧客の単一のビューを構築できます。その後、プロファイルデータをデータセットに書き出して、さらに処理することができます。例： Profile オーディエンスを作成してデータをアクティブ化用に書き出し、レポート用にプロファイル属性を書き出すことができます。

このドキュメントでは、プロファイル API.

メモ

このガイドでは、 Profile API. Adobe Experience Platform Segmentation Service の書き出しジョブの管理方法について詳しくは、セグメント化 API でのジョブの書き出し.

書き出しジョブの作成に加えて、 Profile データを /entities エンドポイント（別名「」）Profile Access". 詳しくは、エンティティエンドポイントガイドを参照してください。にアクセスする手順については、 Profile UI を使用するデータ ( ユーザーガイド.

はじめに

このガイドで使用する API エンドポイントは、Real-Time Customer ProfileAPI の一部です。先に進む前に、はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API の呼び出しを成功させるのに必要なヘッダーに関する重要な情報を確認してください。

エクスポートジョブの作成

エクスポート中 Profile データを書き出すには、まずデータの書き出し先となるデータセットを作成し、その後新しい書き出しジョブを開始する必要があります。これらの両方の手順は、Experience PlatformAPI を使用して実行できます。前者はカタログサービス API を使用し、後者はリアルタイム顧客プロファイル API を使用します。各手順を完了するための詳細な手順については、以下の節で説明しています。

ターゲットデータセットの作成

書き出し時 Profile データの場合は、最初にターゲットデータセットを作成する必要があります。データセットを正しく設定して、エクスポートが正常に行われるようにすることが重要です。

重要な考慮事項の 1 つは、データセットのベースとなるスキーマ（以下の API サンプルリクエストの schemaRef.id）です。プロファイルデータを書き出すには、データセットが XDM Individual Profile 和集合スキーマ (https://ns.adobe.com/xdm/context/profile__union) をクリックします。和集合スキーマは、同じクラスを共有するスキーマのフィールドを集計する、システム生成の読み取り専用のスキーマです。この場合、 XDM Individual Profile クラス。和集合表示スキーマについて詳しくは、『スキーマ構成の基本』ガイドの「和集合」セクション.

このチュートリアルの以降の手順では、 XDM Individual Profile スキーマの和集合 Catalog API. また、 Platform ユニオンスキーマを参照するデータセットを作成するユーザーインターフェイス。 UI を使用する手順については、オーディエンスのエクスポートに関するこの UI チュートリアルしかしここでも当てはまります。完了したら、このチュートリアルに戻り、新しいエクスポートジョブを開始する手順に進むことができます。

互換性のあるデータセットが既に存在し、その ID がわかっている場合は、新しいエクスポートジョブを開始する手順に直接進むことができます。

API 形式

POST /dataSets

リクエスト

次のリクエストは、新しいデータセットを作成し、ペイロードに設定パラメーターを提供します。

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "Profile Data Export",
        "schemaRef": {
          "id": "https://ns.adobe.com/xdm/context/profile__union",
          "contentType": "application/vnd.adobe.xed+json;version=1"
        }
      }'

プロパティ	説明
`name`	データセットのわかりやすい名前。
`schemaRef.id`	データセットが関連付けられる和集合表示（スキーマ）の ID。

応答

応答に成功した場合、新しく作成されたデータセットの読み取り専用のシステム生成された一意の ID を含む配列が返されます。プロファイルデータを正常にエクスポートするには、適切に設定されたデータセット ID が必要です。

[
  "@/datasets/5b020a27e7040801dedba61b"
]

エクスポートジョブの開始

和集合永続化データセットを取得したら、に対してPOSTリクエストを実行することで、プロファイルデータをデータセットに保持する書き出しジョブを作成できます /export/jobs エンドポイントを使用して、書き出すデータの詳細をリクエストの本文に指定できます。

API 形式

POST /export/jobs

リクエスト

次のリクエストは、新しいエクスポートジョブを作成し、ペイロードに設定パラメーターを提供します。

curl -X POST \
  https://platform.adobe.io/data/core/ups/export/jobs \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "fields": "identities.id,personalEmail.address",
    "mergePolicy": {
      "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
      "version": 1
    },
    "additionalFields": {
      "eventList": {
        "fields": "environment.browserDetails.name,environment.browserDetails.version",
        "filter": {
          "fromIngestTimestamp": "2018-10-25T13:22:04-07:00"
        }
      }
    }
    "destination": {
      "datasetId": "5b020a27e7040801dedba61b",
      "segmentPerBatch": false
    },
    "schema": {
      "name": "_xdm.context.profile"
    }
  }'

プロパティ	説明
`fields`	（オプション）エクスポートに含めるデータフィールドを、このパラメーターで指定されたデータフィールドのみに制限します。この値を省略すると、エクスポートされるデータにすべてのフィールドが含まれます。
`mergePolicy`	（オプション）エクスポートされるデータを管理する結合ポリシーを指定します。複数のオーディエンスがエクスポートされる場合は、このパラメーターを含めます。
`mergePolicy.id`	結合ポリシーの ID。
`mergePolicy.version`	使用する結合ポリシーの特定のバージョンです。この値を省略すると、デフォルトで最新バージョンが使用されます。
`additionalFields.eventList`	（オプション）次の 1 つ以上の設定を指定して、子オブジェクトまたは関連オブジェクト用に書き出される時系列イベントフィールドを制御します。 `eventList.fields`：エクスポートするフィールドを制御します。 `eventList.filter`：関連オブジェクトから取得される結果を制限する基準を指定します。エクスポートに必要な最小値（通常は日付）が基準として予期されます。 `eventList.filter.fromIngestTimestamp`：時系列イベントをフィルター処理して、指定されたタイムスタンプの後に取り込まれたイベントに絞り込みます。これは、イベント時間自体ではなく、イベントの取得時間です。
`destination`	（必須）エクスポートするデータの宛先情報： `destination.datasetId`：（必須）データのエクスポート先のデータセットの ID。 `destination.segmentPerBatch`：（オプション）指定しない場合、ブール値はデフォルトで `false` になります。値： `false` は、すべてのセグメント定義 ID を単一のバッチ ID にエクスポートします。値： `true` は、1 つのセグメント定義 ID を 1 つのバッチ ID に書き出します。値を `true` に設定すると、バッチエクスポートのパフォーマンスに影響を与える場合があることに注意してください。
`schema.name`	（必須）データのエクスポート先のデータセットに関連付けられているスキーマの名前。

メモ

プロファイルデータのみをエクスポートし、関連する時系列データを含めない場合は、「additionalFields」オブジェクトをリクエストから削除します。

応答

成功した応答では、リクエストで指定したプロファイルデータが含まれるデータセットが返されます。

{
    "profileInstanceId": "ups",
    "jobType": "BATCH",
    "id": 24115,
    "schema": {
        "name": "_xdm.context.profile"
    },
    "mergePolicy": {
        "id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
        "version": 1
    },
    "status": "NEW",
    "requestId": "IwkVcD4RupdSmX376OBVORvcvTdA4ypN",
    "computeGatewayJobId": {},
    "metrics": {
        "totalTime": {
            "startTimeInMs": 1559674261657
        }
    },
    "destination": {
      "dataSetId": "5cf6bcf79ecc7c14530fe436",
      "segmentPerBatch": false,
      "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
    },
    "updateTime": 1559674261868,
    "imsOrgId": "{ORG_ID}",
    "creationTime": 1559674261657
}

すべてのエクスポートジョブのリスト

特定の組織に対してすべてのエクスポートジョブのリストを返すには、 export/jobs endpoint. リクエストは、以下に示すように、クエリパラメーター limit および offset もサポートします。

API 形式

GET /export/jobs
GET /export/jobs?{QUERY_PARAMETERS}

パラメーター	説明
`start`	リクエストの作成時刻に従って、返された結果のページをオフセットします。例：`start=4`
`limit`	返す結果の数を制限します。例：`limit=10`
`page`	リクエストの作成時刻に従って、特定のページの結果を返します。例：`page=2`
`sort`	特定のフィールドで結果を昇順（`asc`）または降順（`desc`）で並べ替えます。結果の複数ページを返す場合、並べ替えパラメーターは機能しません。例：`sort=updateTime:asc`

リクエスト

curl -X GET \
  https://platform.adobe.io/data/core/ups/export/jobs/ \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答には、 records オブジェクトには、組織で作成されたエクスポートジョブが含まれます。

{
  "records": [
    {
      "profileInstanceId": "ups",
      "jobType": "BATCH",
      "id": 726,
      "schema": {
          "name": "_xdm.context.profile"
      },
      "mergePolicy": {
          "id": "timestampOrdered-none-mp",
          "version": 1
      },
      "status": "SUCCEEDED",
      "requestId": "d995479c-8a08-4240-903b-af469c67be1f",
      "computeGatewayJobId": {
          "exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94",
          "pushJob": "feaeca05-d137-4605-aa4e-21d19d801fc6"
      },
      "metrics": {
          "totalTime": {
              "startTimeInMs": 1538615973895,
              "endTimeInMs": 1538616233239,
              "totalTimeInMs": 259344
          },
          "profileExportTime": {
              "startTimeInMs": 1538616067445,
              "endTimeInMs": 1538616139576,
              "totalTimeInMs": 72131
          },
          "aCPDatasetWriteTime": {
              "startTimeInMs": 1538616195172,
              "endTimeInMs": 1538616195715,
              "totalTimeInMs": 543
          }
      },
      "destination": {
          "datasetId": "5b7c86968f7b6501e21ba9df",
          "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
      },
      "updateTime": 1538616233239,
      "imsOrgId": "{ORG_ID}",
      "creationTime": 1538615973895
    },
    {
      "profileInstanceId": "test_xdm_latest_profile_20_e2e_1538573005395",
      "errors": [
        {
          "code": "0090000009",
          "msg": "Error writing profiles to output path 'adl://va7devprofilesnapshot.azuredatalakestore.net/snapshot/722'",
          "callStack": "com.adobe.aep.unifiedprofile.common.logging.Logger"
        },
        {
          "code": "unknown",
          "msg": "Job aborted.",
          "callStack": "org.apache.spark.SparkException: Job aborted."
        }
      ],
      "jobType": "BATCH",
      "filter": {
        "segments": [
            {
                "segmentId": "7a93d2ff-a220-4bae-9a4e-5f3c35032be3"
            }
        ]
      },
      "id": 722,
      "schema": {
          "name": "_xdm.context.profile"
      },
      "mergePolicy": {
          "id": "7972e3d6-96ea-4ece-9627-cbfd62709c5d",
          "version": 1
      },
      "status": "FAILED",
      "requestId": "KbOAsV7HXmdg262lc4yZZhoml27UWXPZ",
      "computeGatewayJobId": {
          "exportJob": "15971e0f-317c-4390-9038-1a0498eb356f"
      },
      "metrics": {
          "totalTime": {
              "startTimeInMs": 1538573416687,
              "endTimeInMs": 1538573922551,
              "totalTimeInMs": 505864
          },
          "profileExportTime": {
              "startTimeInMs": 1538573872211,
              "endTimeInMs": 1538573918809,
              "totalTimeInMs": 46598
          }
      },
      "destination": {
          "datasetId": "5bb4c46757920712f924a3eb",
          "batchId": ""
      },
      "updateTime": 1538573922551,
      "imsOrgId": "{ORG_ID}",
      "creationTime": 1538573416687
    }
  ],
  "page": {
      "sortField": "createdTime",
      "sort": "desc",
      "pageOffset": "1538573416687_722",
      "pageSize": 2
  },
  "link": {
      "next": "/export/jobs/?limit=2&offset=1538573416687_722"
  }
}

エクスポートの進行状況の監視

特定のエクスポートジョブの詳細を表示したり、処理中のステータスを監視したりするには、/export/jobs エンドポイントに対して GET リクエストを実行し、エクスポートジョブの id をパスを含めます。status フィールドによって値「SUCCEEDED」が返されると、エクスポートジョブが完了します。

API 形式

GET /export/jobs/{EXPORT_JOB_ID}

パラメーター	説明
`{EXPORT_JOB_ID}`	アクセスするエクスポートジョブの `id`。

リクエスト

curl -X GET \
  https://platform.adobe.io/data/core/ups/export/jobs/24115 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

{
    "profileInstanceId": "ups",
    "jobType": "BATCH",
    "id": 24115,
    "schema": {
        "name": "_xdm.context.profile"
    },
    "mergePolicy": {
        "id": "0bf16e61-90e9-4204-b8fa-ad250360957b",
        "version": 1
    },
    "status": "SUCCEEDED",
    "requestId": "YwMt1H8QbVlGT2pzyxgwFHTwzpMbHrTq",
    "computeGatewayJobId": {
      "exportJob": "305a2e5c-2cf3-4746-9b3d-3c5af0437754",
      "pushJob": "963f275e-91a3-4fa1-8417-d2ca00b16a8a"
    },
    "metrics": {
      "totalTime": {
        "startTimeInMs": 1547053539564,
        "endTimeInMs": 1547054743929,
        "totalTimeInMs": 1204365
      },
      "profileExportTime": {
        "startTimeInMs": 1547053667591,
        "endTimeInMs": 1547053778195,
        "totalTimeInMs": 110604
      },
      "aCPDatasetWriteTime": {
        "startTimeInMs": 1547054660416,
        "endTimeInMs": 1547054698918,
        "totalTimeInMs": 38502
      }
    },
    "destination": {
      "dataSetId": "5cf6bcf79ecc7c14530fe436",
      "segmentPerBatch": false,
      "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
    },
    "updateTime": 1559674261868,
    "imsOrgId": "{ORG_ID}",
    "creationTime": 1559674261657
}

プロパティ	説明
`batchId`	成功したエクスポートから作成されるバッチの識別子。プロファイルデータを読み取る際に参照目的で使用されます。

エクスポートジョブのキャンセル

Experience Platform では、既存のエクスポートジョブをキャンセルできます。この機能は、エクスポートジョブが完了しなかったか、処理段階で停止した場合など、様々な理由で役立つ場合があります。エクスポートジョブをキャンセルするには、/export/jobs エンドポイントに対して DELETE リクエストを実行し、キャンセルするエクスポートジョブの id をリクエストパスに含めます。

API 形式

DELETE /export/jobs/{EXPORT_JOB_ID}

パラメーター	説明
`{EXPORT_JOB_ID}`	アクセスするエクスポートジョブの `id`。

リクエスト

curl -X POST \
  https://platform.adobe.io/data/core/ups/export/jobs/726 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

削除リクエストが成功すると、HTTP ステータス 204（コンテンツなし）と空の応答本文が返され、キャンセル操作が成功したことを示します。

次の手順

エクスポートが正常に完了すると、データは Experience Platform のデータレイク内で使用できます。その後、エクスポートに関連付けられた batchId を使用して、データアクセス API でデータにアクセスできます。エクスポートのサイズに応じて、データがチャンクに格納され、バッチが複数のファイルで構成される場合があります。

データアクセス API を使用してバッチファイルにアクセスしてダウンロードする手順については、データアクセスのチュートリアルを参照してください。

また、Adobe Experience Platformクエリサービスを使用して、正常に書き出されたリアルタイム顧客プロファイルデータにアクセスすることもできます。クエリサービスでは、UI または RESTful API を使用して、クエリの書き込みと検証を行い、データレイク内のデータに対してクエリを実行することができます。

オーディエンスデータに対してクエリを実行する方法ついて詳しくは、クエリサービスのドキュメントを参照してください。

付録

次の節では、プロファイル API の書き出しジョブに関する追加情報を示します。

その他の書き出しペイロードの例

API 呼び出しの例 ( 書き出しジョブの開始は、プロファイル（レコード）とイベント（時系列）の両方のデータを含むジョブを作成します。この節では、書き出しに 1 つのデータタイプまたは他のデータタイプが含まれるように制限する、追加のリクエストペイロードの例を示します。

次のペイロードは、プロファイルデータのみを含む（イベントを含まない）書き出しジョブを作成します。

{
    "fields": "identities.id,personalEmail.address",
    "mergePolicy": {
      "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
      "version": 1
    },
    "destination": {
      "datasetId": "5b020a27e7040801dedba61b",
      "segmentPerBatch": false
    },
    "schema": {
      "name": "_xdm.context.profile"
    }
  }

イベントデータのみを含む（プロファイル属性を含まない）書き出しジョブを作成する場合、ペイロードは次のようになります。

{
    "fields": "identityMap",
    "mergePolicy": {
      "id": "e5bc94de-cd14-4cdf-a2bc-88b6e8cbfac2",
      "version": 1
    },
    "additionalFields": {
      "eventList": {
        "fields": "environment.browserDetails.name,environment.browserDetails.version",
        "filter": {
          "fromIngestTimestamp": "2018-10-25T13:22:04-07:00"
        }
      }
    },
    "destination": {
      "datasetId": "5b020a27e7040801dedba61b",
      "segmentPerBatch": false
    },
    "schema": {
      "name": "_xdm.context.profile"
    }
  }

オーディエンスのエクスポート

また、書き出しジョブのエンドポイントを使用して、 Profile データ。次のガイドを参照してください：セグメント化 API でのジョブの書き出しを参照してください。

プロファイル書き出しジョブエンドポイント

はじめに

エクスポートジョブの作成

ターゲットデータセットの作成

エクスポートジョブの開始

すべてのエクスポートジョブのリスト

エクスポートの進行状況の監視

エクスポートジョブのキャンセル

次の手順

付録

その他の書き出しペイロードの例

オーディエンスのエクスポート

このページ

次を表示：

学習

ドキュメント

コミュニティ

サポート

リソース

アドビアカウント

Adobe