ジョブエンドポイントの書き出し

書き出しジョブは、オーディエンスセグメントメンバーをデータセットに永続化するために使用される非同期プロセスです。 /export/jobsエンドポイントは、Adobe Experience PlatformセグメントAPIで使用できます。これにより、プログラムによって、書き出しジョブを取得、作成、キャンセルできます。

メモ

このガイドは、Segmentation APIでの書き出しジョブの使用について説明します。 Real-time Customer Profileデータの書き出しジョブを管理する方法について詳しくは、プロファイルAPI🔗の書き出しジョブに関するガイドを参照してください

はじめに

このガイドで使用されるエンドポイントは、Adobe Experience Platform Segmentation Service APIの一部です。 先に進む前に、はじめにガイドを見て、必要なヘッダーやAPI呼び出し例の読み方など、APIを正しく呼び出すために必要な重要な情報を確認してください。

書き出しジョブのリストの取得

IMS 組織のすべての書き出しジョブのリストを取得するには、/export/jobs エンドポイントに GET リクエストを実行します。

API 形式

/export/jobsエンドポイントは、結果のフィルタリングに役立ついくつかのクエリパラメーターをサポートしています。 これらのパラメーターはオプションですが、高価なオーバーヘッドを削減するために、このパラメーターの使用を強くお勧めします。 パラメーターを指定しないでこのエンドポイントを呼び出すと、組織で使用可能なすべての書き出しジョブが取得されます。複数のパラメーターを使用する場合は、アンパサンド(&)で区切ります。

GET /export/jobs
GET /export/jobs?limit={LIMIT}
GET /export/jobs?offset={OFFSET}
GET /export/jobs?status={STATUS}
パラメーター 説明
{LIMIT} 返される書き出しジョブの数を指定します。
{OFFSET} 結果のページのオフセットを指定します。
{STATUS} ステータスに基づいて結果をフィルターします。サポートされる値は、「NEW」、「SUCCEEDED」および「FAILED」です。

リクエスト

次のリクエストは、IMS組織内の最後の2つのエクスポートジョブを取得します。

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

応答

次の応答は、要求パスに指定されたクエリパラメーターに基づいて、正常に完了した書き出しジョブのリストを持つHTTPステータス200を返します。

{
    "records": [
        {
            "id": 100,
            "jobType": "BATCH",
            "destination": {
                "datasetId": "5b7c86968f7b6501e21ba9df",
                "segmentPerBatch": false,
                "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52",
            },
            "fields": "identities.id,personalEmail.address",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
            "status": "SUCCEEDED",
            "filter": {
                "segments": [
                    {
                        "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
                        "segmentNs": "ups",
                        "status": [
                            "realized"
                        ]
                    }
                ]
            },
            "mergePolicy": {
                "id": "timestampOrdered-none-mp",
                "version": 1
            },
            "profileInstanceId": "ups",
            "errors": [
                {
                    "code": "0100000003",
                    "msg": "Error in Export Job",
                    "callStack": "com.adobe.aep.unifiedprofile.common.logging.Logger"
                }
            ],
            "metrics": {
                "totalTime": {
                    "startTimeInMs": 123456789000,
                    "endTimeInMs": 123456799000,
                    "totalTimeInMs": 10000
                },
                "profileExportTime": {
                    "startTimeInMs": 123456789000,
                    "endTimeInMs": 123456799000,
                    "totalTimeInMs": 10000
                },
                "totalExportedProfileCounter": 20,
                "exportedProfileByNamespaceCounter": {
                    "namespace1": 10,
                    "namespace2": 5
                }
            },
            "computeGatewayJobId": {
                "exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94"
            },
            "creationTime": 1538615973895,
            "updateTime": 1538616233239,
            "requestId": "d995479c-8a08-4240-903b-af469c67be1f"
        },
        {
            "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": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
                        "segmentNs": "AAM",
                        "status": ["realized", "existing"]
                    }
                ]
            },
            "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",
                "segmentPerBatch": false,
                "batchId": "IWEQ6920712f9475762D"
            },
            "updateTime": 1538573922551,
            "imsOrgId": "1BD6382559DF0C130A49422D@AdobeOrg",
            "creationTime": 1538573416687
        }
    ],
    "page":{
        "sortField": "createdTime",
        "sort": "desc",
        "pageOffset": "1540974701302_96",
        "pageSize": 2
    },
    "link":{
        "next": "/export/jobs/?limit=2&offset=1538573416687_722"
    }
}
プロパティ 説明
destination エクスポートされたデータのエクスポート先情報:
  • datasetId:データがエクスポートされたデータセットのID。
  • segmentPerBatch:セグメントIDが統合されているかどうかを示すBoolean値。値が「false」の場合は、すべてのセグメントIDが1つのバッチIDにエクスポートされることを意味します。 値が「true」の場合は、1つのセグメントIDが1つのバッチIDにエクスポートされることを意味します。 注意:値をtrueに 設定すると、バッチエクスポートのパフォーマンスに影響する場合があります。
fields コンマで区切った、書き出すフィールドのリスト。
schema.name データをエクスポートするデータセットに関連付けられているスキーマの名前。
filter.segments 書き出されるセグメント。 次のフィールドが含まれます。
  • segmentId:プロファイルのエクスポート先のセグメントID。
  • segmentNs:指定したのセグメント名前空間 segmentID
  • status:のステータスフィルターを提供する文字列の配列で segmentIDす。デフォルトでは、status は、現在の時刻にセグメントに含まれているすべてのプロファイルを表す値 ["realized", "existing"] を持ちます。使用できる値は次のとおりです。「reliated」、「existing」および「exited」。 値が「realized」の場合は、プロファイルがセグメントに入っていることを意味します。 「既存」の値は、プロファイルが引き続きセグメント内にあることを意味します。 値が「exiting」の場合は、プロファイルがセグメントを終了していることを意味します。
mergePolicy エクスポートしたデータのポリシー情報をマージします。
metrics.totalTime 書き出しジョブの実行に要した合計時間を示すフィールドです。
metrics.profileExportTime プロファイルの書き出しに要した時間を示すフィールドです。
page 要求された書き出しジョブのページ番号に関する情報です。
link.next 書き出しジョブの次のページへのリンク。

新しい書き出しジョブの作成

/export/jobs エンドポイントに POST リクエストを実行することで、新しい書き出しジョブを作成できます。

API 形式

POST /export/jobs

リクエスト

次のリクエストは、ペイロードで提供されるパラメーターによって設定された、新しい書き出しジョブを作成します。

curl -X POST https://platform.adobe.io/data/core/ups/export/jobs \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "fields": "identities.id,personalEmail.address",
    "mergePolicy": {
        "id": "timestampOrdered-none-mp",
        "version": 1
    },
    "filter": {
        "segments": [
            {
                "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
                "segmentNs": "ups",
                "status": [
                    "realized"
                ]
            }
        ],
        "segmentQualificationTime": {
            "startTime": "2018-01-01T00:00:00Z",
            "endTime": "2018-02-01T00:00:00Z"
        },
        "fromIngestTimestamp": "2018-01-01T00:00:00Z",
        "emptyProfiles": true
    },
    "additionalFields": {
        "eventList": {
            "fields": "string",
            "filter": {
                "fromIngestTimestamp": "2018-01-01T00:00:00Z",
                "toIngestTimestamp": "2020-01-01T00:00:00Z"
            }
        }
    },
    "destination":{
        "datasetId": "5b7c86968f7b6501e21ba9df",
        "segmentPerBatch": false
    },
    "schema":{
        "name": "_xdm.context.profile"
    },
    "evaluationInfo": {
        "segmentation": true
    }
}'
プロパティ 説明
fields コンマで区切った、書き出すフィールドのリスト。空白の場合、すべてのフィールドが書き出されます。
mergePolicy 書き出されたデータを管理するマージポリシーを指定します。 複数のセグメントがエクスポートされる場合は、このパラメーターを含めます。指定されなかった場合、書き出しは指定されたセグメントと同じ結合ポリシーを使用します。
filter 以下に示すサブプロパティに応じて、ID、認定時間、または取り込み時間で、書き出しジョブに含めるセグメントを指定するオブジェクト。 空白の場合、すべてのデータが書き出しされます。
filter.segments 書き出すセグメントを指定します。 この値を省略すると、すべてのプロファイルのすべてのデータがエクスポートされます。次のフィールドを含むセグメントオブジェクトの配列を受け入れます。
  • segmentIdsegments を使用する場合は必須)​エクスポートするプロファイルのセグメント ID。
  • segmentNs (オプション)​指定した segmentID のセグメント名前空間。
  • status (オプション)segmentID のステータスフィルターを提供する文字列の配列。デフォルトでは、status は、現在の時刻にセグメントに含まれているすべてのプロファイルを表す値 ["realized", "existing"] を持ちます。"realized""existing""exited" などの値が使用されます。値が「realized」の場合は、プロファイルがセグメントに入っていることを意味します。 「既存」の値は、プロファイルが引き続きセグメント内にあることを意味します。 値が「exiting」の場合は、プロファイルがセグメントを終了していることを意味します。
filter.segmentQualificationTime セグメントクオリフィケーション時間に基づいてフィルターします。 開始時間および/または終了時間を指定できます。
filter.segmentQualificationTime.startTime 特定のステータスのセグメントIDに対するセグメントクオリフィケーション開始時間。 指定されていない場合、セグメント ID 認定の開始時間にフィルターは適用されません。タイムスタンプは RFC 3339 形式で指定する必要があります。
filter.segmentQualificationTime.endTime 特定のステータスのセグメントIDに対するセグメントクオリフィケーションの終了時間。 指定されていない場合、セグメント ID 認定の終了時間にフィルターは適用されません。タイムスタンプは RFC 3339 形式で指定する必要があります。
filter.fromIngestTimestamp 書き出したプロファイルを、このタイムスタンプの後に更新されたアイテムのみに制限します。 タイムスタンプは RFC 3339 形式で指定する必要があります。
  • プロファイル​の fromIngestTimestamp(指定されている場合):更新された結合タイムスタンプが指定タイムスタンプよりも大きいすべての結合プロファイルが含まれます。greater_than オペランドがサポートされます。
  • イベント​の fromIngestTimestamp:このタイムスタンプの後に取り込まれるすべてのイベントは、プロファイルの結果に応じてエクスポートされます。これは、イベント時間自体ではなく、イベントの取得時間です。
filter.emptyProfiles 空のプロファイルをフィルタリングするかどうかを示すboolean値です。 プロファイルには、プロファイルレコード、ExperienceEventレコード、またはその両方を含めることができます。 プロファイルレコードがなく、ExperienceEventレコードのみのプロファイルは、「emptyProfiles」と呼ばれます。 プロファイルストア内のすべてのプロファイル(「emptyProfiles」を含む)をエクスポートするには、emptyProfilesの値をtrueに設定します。 emptyProfilesfalseに設定した場合、ストア内のプロファイルレコードを持つプロファイルのみがエクスポートされます。 デフォルトでは、emptyProfiles属性が含まれていない場合、プロファイルレコードを含むプロファイルのみがエクスポートされます。
additionalFields.eventList 次の1つ以上の設定を指定して、子オブジェクトまたは関連オブジェクト用に書き出す時系列イベントフィールドを制御します。
  • fields:エクスポートするフィールドを制御します。
  • filter:関連オブジェクトから取得される結果を制限する基準を指定します。エクスポートに必要な最小値(通常は日付)が基準として予期されます。
  • filter.fromIngestTimestamp:指定されたタイムスタンプの後に取り込まれたものへの時系列イベントのフィルター。これは、イベント時間自体ではなく、イベントの取得時間です。
  • filter.toIngestTimestamp:指定したタイムスタンプより前に取り込まれたタイムスタンプにフィルターします。これは、イベント時間自体ではなく、イベントの取得時間です。
destination (必須)書き出されたデータに関する 情報:
  • datasetId(必須)​データのエクスポート先のデータセットの ID。
  • segmentPerBatch: (オプション) ブール値。指定しなかった場合のデフォルト値は「false」です。値が「false」の場合、すべてのセグメントIDが1つのバッチIDにエクスポートされます。 値が「true」の場合、1つのセグメントIDが1つのバッチIDにエクスポートされます。 値を「true」に設定すると、バッチエクスポートのパフォーマンスに影響する場合があります。
schema.name (必須)​データのエクスポート先のデータセットに関連付けられているスキーマの名前。
evaluationInfo.segmentation (オプション) boolean値。指定しない場合はデフォルトが falseです。trueの値は、セグメント化を書き出しジョブで行う必要があることを示します。

応答

正常な応答は、HTTP ステータス 200 と、新しく作成された書き出しジョブの詳細を返します。

{
    "id": 100,
    "jobType": "BATCH",
    "destination": {
        "datasetId": "5b7c86968f7b6501e21ba9df",
        "segmentPerBatch": false,
        "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
    },
    "fields": "identities.id,personalEmail.address",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "imsOrgId": "{IMS_ORG}",
    "status": "NEW",
    "filter": {
        "segments": [
            {
                "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
                "segmentNs": "ups",
                "status": [
                    "realized"
                ]
            }
        ],
        "segmentQualificationTime": {
            "startTime": "2018-01-01T00:00:00Z",
            "endTime": "2018-02-01T00:00:00Z"
        },
        "fromIngestTimestamp": "2018-01-01T00:00:00Z",
        "emptyProfiles": true
    },
    "additionalFields": {
        "eventList": {
            "fields": "_id, _experience",
            "filter": {
                "fromIngestTimestamp": "2018-01-01T00:00:00Z"
            }
        }
    },
    "mergePolicy": {
        "id": "timestampOrdered-none-mp",
        "version": 1
    },
    "profileInstanceId": "ups",
    "metrics": {
        "totalTime": {
            "startTimeInMs": 123456789000,
        }
    },
    "computeGatewayJobId": {
        "exportJob": ""    
    },
    "creationTime": 1538615973895,
    "updateTime": 1538616233239,
    "requestId": "d995479c-8a08-4240-903b-af469c67be1f"
}
プロパティ 説明
id 作成されたばかりの書き出しジョブを識別する、システム生成の読み取り専用の値です。

または、destination.segmentPerBatchtrueに設定されていた場合、上のdestinationオブジェクトは、次のようにbatches配列を持ちます。

    "destination": {
        "dataSetId" : "{DATASET_ID}",
        "segmentPerBatch": true,
        "batches" : [
            {
                "segmentId": "segment1",
                "segmentNs": "ups",
                "status": ["realized"],
                "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
            },
            {
                "segmentId": "segment2",
                "segmentNs": "AdCloud",
                "status": "exited",
                "batchId": "df4gssdfb93a09f7e37fa53ad52"
            }
        ]
    }

特定の書き出しジョブの取得

/export/jobsエンドポイントにGETリクエストを送信し、取得するエクスポートジョブのIDをリクエストパスに指定することで、特定のエクスポートジョブに関する詳細な情報を取得できます。

API 形式

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

リクエスト

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

応答

正常な応答は、HTTP ステータス 200 と、指定された書き出しジョブに関する詳細情報を返します。

{
    "id": 11037,
    "jobType": "BATCH",
    "destination": {
        "datasetId": "5b7c86968f7b6501e21ba9df",
        "segmentPerBatch": false,
        "batchId": "da5cfb4de32c4b93a09f7e37fa53ad52"
    },
    "fields": "identities.id,personalEmail.address",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "imsOrgId": "{IMS_ORG}",
    "status": "SUCCEEDED",
    "filter": {
        "segments": [
            {
                "segmentId": "52c26d0d-45f2-47a2-ab30-ed06abc981ff",
                "segmentNs": "ups",
                "status":[
                    "realized"
                ]
            }
        ]
    },
    "mergePolicy": {
        "id": "timestampOrdered-none-mp",
        "version": 1
    },
    "profileInstanceId": "ups",
    "metrics": {
        "totalTime": {
            "startTimeInMs": 123456789000,
            "endTimeInMs": 123456799000,
            "totalTimeInMs": 10000
        },
        "profileExportTime": {
            "startTimeInMs": 123456789000,
            "endTimeInMs": 123456799000,
            "totalTimeInMs": 10000
        },
        "totalExportedProfileCounter": 20,
        "exportedProfileByNamespaceCounter": {
            "namespace1": 10,
            "namespace2": 5
        }
    },
    "computeGatewayJobId": {
        "exportJob": "f3058161-7349-4ca9-807d-212cee2c2e94"
    },
    "creationTime": 1538615973895,
    "updateTime": 1538616233239,
    "requestId": "d995479c-8a08-4240-903b-af469c67be1f"
}
プロパティ 説明
destination エクスポートされたデータのエクスポート先情報:
  • datasetId:データがエクスポートされたデータセットのID。
  • segmentPerBatch:セグメントIDが統合されているかどうかを示すBoolean値。値falseは、すべてのセグメントIDが1つのバッチIDになったことを意味します。 trueという値は、1つのセグメントIDが1つのバッチIDにエクスポートされることを意味します。
fields コンマで区切った、書き出すフィールドのリスト。
schema.name データをエクスポートするデータセットに関連付けられているスキーマの名前。
filter.segments 書き出されるセグメント。 次のフィールドが含まれます。
  • segmentId:エクスポートするプロファイルのセグメントID。
  • segmentNs:指定したのセグメント名前空間 segmentID
  • status:のステータスフィルターを提供する文字列の配列で segmentIDす。デフォルトでは、status は、現在の時刻にセグメントに含まれているすべてのプロファイルを表す値 ["realized", "existing"] を持ちます。使用できる値は次のとおりです。「reliated」、「existing」および「exited」。 値が「realized」の場合は、プロファイルがセグメントに入っていることを意味します。 「既存」の値は、プロファイルが引き続きセグメント内にあることを意味します。 値が「exiting」の場合は、プロファイルがセグメントを終了していることを意味します。
mergePolicy エクスポートしたデータのポリシー情報をマージします。
metrics.totalTime 書き出しジョブの実行に要した合計時間を示すフィールドです。
metrics.profileExportTime プロファイルの書き出しに要した時間を示すフィールドです。
totalExportedProfileCounter すべてのバッチにエクスポートされたプロファイルの合計数です。

特定の書き出しジョブのキャンセルまたは削除

/export/jobsエンドポイントにDELETEリクエストを送信し、削除するエクスポートジョブのIDをリクエストパスに指定することで、指定したエクスポートジョブを削除するようにリクエストできます。

API 形式

DELETE /export/jobs/{EXPORT_JOB_ID}
パラメーター 説明
{EXPORT_JOB_ID} 削除するエクスポートジョブのid

リクエスト

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

応答

正常な応答は、HTTP ステータス 204 と次のメッセージを返します。

{
  "status": true,
  "message": "Export job has been marked for cancelling"
}

次の手順

このガイドを読むと、書き出しジョブの動作についての理解が深まります。

このページ