此 OneTrust Integration 源仅支持获取同意和偏好设置数据,而不支持Cookie。
以下教程将指导您完成创建源连接和数据流的步骤,以便从中获取历史同意数据和计划同意数据 OneTrust Integration 到Adobe Experience Platform,使用 Flow Service API.
此 OneTrust Integration 源连接器和文档由创建 OneTrust Integration 团队。 如有任何查询或更新请求,请联系 OneTrust 团队 直接。
连接之前 OneTrust Integration 到Platform,您必须首先检索您的访问令牌。 有关查找访问令牌的详细说明,请参阅 OneTrust Integration OAuth 2指南.
访问令牌过期后不会自动刷新,因为系统到系统刷新令牌不受支持 OneTrust. 因此,在访问令牌过期之前,必须确保连接中的访问令牌已更新。 访问令牌的最长可配置生命周期为一年。 要了解有关更新访问令牌的更多信息,请参阅 OneTrust 有关管理OAuth 2.0客户端凭据的文档.
此 OneTrust Integration 正在与Adobe共享API规范以进行数据摄取。
以下教程将指导您完成创建 OneTrust Integration 源连接并创建数据流以引入 OneTrust Integration 使用将数据发送到平台 Flow Service API.
基本连接会保留源和平台之间的信息,包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
POST要创建基本连接ID,请向 /connections
端点同时提供 OneTrust Integration 作为请求正文一部分的身份验证凭据。
API格式
POST /connections
请求
以下请求创建基本连接 OneTrust Integration :
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "ONETRUST base connection",
"description": "ONETRUST base connection to authenticate to Platform",
"connectionSpec": {
"id": "cf16d886-c627-4872-9936-fb08d6cba8cc",
"version": "1.0"
},
"auth": {
"specName": "OAuth2 Refresh Code",
"params": {
"accessToken": "{ACCESS_TOKEN}"
}
}
}'
属性 | 描述 |
---|---|
name |
基本连接的名称。 确保基本连接的名称是描述性的,因为您可以使用此名称查找基本连接上的信息。 |
description |
可包含的可选值,用于提供有关基本连接的更多信息。 |
connectionSpec.id |
源的连接规范ID。 在您的源通过注册和批准后,可以检索此ID Flow Service API。 |
auth.specName |
用于向Platform验证源的身份验证类型。 |
auth.params. |
包含对源进行身份验证所需的凭据,包括用于连接到API的访问令牌。 |
auth.params.accessToken |
与您的对应的访问令牌 OneTrust Integration 帐户。 |
响应
成功响应将返回新创建的基本连接,包括其唯一连接标识符(id
)。 在下一步中浏览源的文件结构和内容时,需要此ID。
{
"id": "622124ca-6d18-47f7-999c-66f599955309",
"etag": "\"2e026443-0000-0200-0000-621f1af80000\""
}
使用上一步中生成的基本连接ID,您可以通过执行GET请求来浏览文件和目录。
使用以下调用查找要引入的文件的路径 Platform:
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}
执行GET请求以浏览源的文件结构和内容时,必须包括下表列出的查询参数:
参数 | 描述 |
---|---|
{BASE_CONNECTION_ID} |
上一步中生成的基本连接ID。 |
objectType=rest |
您希望浏览的对象类型。 目前,此值始终设置为 rest . |
{OBJECT} |
只有在查看特定目录时才需要此参数。 其值表示您希望浏览的目录的路径。 |
fileType=json |
要带到Platform的文件类型。 目前, json 是唯一支持的文件类型。 |
{PREVIEW} |
一个布尔值,定义连接的内容是否支持预览。 |
请求
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/622124ca-6d18-47f7-999c-66f599955309/explore?objectType=rest&object=json&fileType=json&preview=true' \
-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}'
响应
成功响应将返回查询文件的结构。
为简短起见,以下JSON响应有效负载已隐藏。 选择单击我以查看响应有效负载。
{
"format": "hierarchical",
"schema": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"size": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"numberOfElements": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"last": {
"type": "boolean"
},
"pageable": {
"type": "object",
"properties": {
"paged": {
"type": "boolean"
},
"pageNumber": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"offset": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"tokenId": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"pageSize": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"unpaged": {
"type": "boolean"
},
"sort": {
"type": "object",
"properties": {
"unsorted": {
"type": "boolean"
},
"sorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
}
},
"sort": {
"type": "object",
"properties": {
"unsorted": {
"type": "boolean"
},
"sorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
},
"content": {
"type": "object",
"properties": {
"LastUpdatedDate": {
"type": "string"
},
"Identifier": {
"type": "string"
},
"Language": {
"type": "string"
},
"TestDataSubject": {
"type": "boolean"
},
"CreatedDate": {
"type": "string"
},
"DataElements": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"Id": {
"type": "string"
},
"Purposes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Status": {
"type": "string"
},
"LastTransactionDate": {
"type": "string"
},
"CustomPreferences": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"LastUpdatedDate": {},
"ExpiryDate": {},
"Topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"IsConsented": {
"type": "boolean"
},
"Id": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
},
"TotalTransactionCount": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"LastReceiptId": {},
"ConsentDate": {
"type": "string"
},
"LastInteractionDate": {},
"Name": {
"type": "string"
},
"FirstTransactionDate": {
"type": "string"
},
"LastTransactionCollectionPointId": {
"type": "string"
},
"LastTransactionCollectionPointVersion": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"Version": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"attributes": {
"type": "object",
"properties": {}
},
"Id": {
"type": "string"
},
"PurposeNote": {},
"WithdrawalDate": {
"type": "string"
}
}
}
}
}
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
},
"data": [
{
"number": 0,
"size": 100,
"numberOfElements": 100,
"last": false,
"pageable": {
"limit": 100,
"offset": 0,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"tokenId": 100,
"pageSize": 100,
"pageNumber": 0,
"unpaged": false,
"paged": true
},
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"content": {
"Id": "de1ab4d2-6ccf-42bd-b363-2d8cac60c88c",
"Language": "en-us",
"Identifier": "gkumar@onetrust.com",
"LastUpdatedDate": "2019-06-05T12:02:07Z",
"CreatedDate": "2018-05-02T03:14:28Z",
"Purposes": [
{
"Id": "9edf57bb-0449-4c15-98e4-8641522e5ff4",
"Name": "Purpose_UAT",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2018-05-02T03:14:27Z",
"LastTransactionDate": "2019-05-29T11:08:26Z",
"WithdrawalDate": "2019-05-29T11:05:30Z",
"ConsentDate": "2018-05-02T03:14:27Z",
"TotalTransactionCount": 5,
"Topics": [
{
"Id": "d6e3d675-3d6f-4f4e-a157-bd93829ee632",
"Name": "Topic_UAT",
"IsConsented": true
}
],
"LastTransactionCollectionPointId": "735c85c8-c69c-44bc-8bad-ec0e806090bd",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "814c073a-95f1-4fc9-8263-1ec62225c5e9",
"Name": "Multi Pur_UAT",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2018-05-02T03:17:33Z",
"LastTransactionDate": "2018-05-02T03:19:49Z",
"ConsentDate": "2018-05-02T03:17:33Z",
"TotalTransactionCount": 4,
"LastTransactionCollectionPointId": "9a5b7375-bc13-47e8-8a58-1ca7d9c06c8e",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "4d52dcc4-82bf-44bf-ac49-854eba6ff8f3",
"Name": "Eloqua_UAT",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2018-05-02T03:26:36Z",
"LastTransactionDate": "2019-03-07T03:23:25Z",
"ConsentDate": "2018-05-02T03:26:36Z",
"TotalTransactionCount": 3,
"Topics": [
{
"Id": "690ad782-6280-4ea4-b62a-1514c39fc838",
"Name": "Eloqua_topic",
"IsConsented": true
}
],
"LastTransactionCollectionPointId": "f8886377-e4b1-45e4-b1c0-d7dacb744db8",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "723300e3-96cb-4da4-abdd-4913c05be215",
"Name": "Purpose 1",
"Version": 2,
"Status": "EXPIRED",
"FirstTransactionDate": "2019-02-27T06:29:48Z",
"LastTransactionDate": "2019-02-28T12:00:45Z",
"ConsentDate": "2019-02-27T06:29:48Z",
"ExpiryDate": "2019-02-28T12:00:45Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "3dbfb978-10f9-44a9-9669-d699674edd9d",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "4a5e6278-17f1-4283-beee-29f81cde2bd0",
"Name": "kbpurpose1",
"Version": 1,
"Status": "NO_CONSENT",
"FirstTransactionDate": "2019-03-07T03:21:58Z",
"LastTransactionDate": "2019-05-29T03:56:37Z",
"TotalTransactionCount": 6,
"LastTransactionCollectionPointId": "cea42a12-5de4-421a-b429-092e8d523948",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a36f98d0-c662-4f61-a2a1-8bdab69e3c3a",
"Name": "Pur 1",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2019-03-07T03:23:25Z",
"LastTransactionDate": "2019-03-07T03:23:27Z",
"ConsentDate": "2019-03-07T03:23:25Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "f8886377-e4b1-45e4-b1c0-d7dacb744db8",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "41ebdf32-068b-4239-89ac-42e20262c5a9",
"Name": "Send Notifications about Changes to Preferences",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2019-03-07T03:24:11Z",
"LastTransactionDate": "2019-03-07T03:27:29Z",
"ConsentDate": "2019-03-07T03:24:11Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "c29a99a9-de4d-4367-973b-95b0217d0640",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "759d8b24-e4c0-4107-86e2-3a408db13e6b",
"Name": "GJ Purpose 07",
"Version": 2,
"Status": "WITHDRAWN",
"FirstTransactionDate": "2019-03-07T03:27:29Z",
"LastTransactionDate": "2019-05-29T11:09:03Z",
"WithdrawalDate": "2019-05-29T11:09:03Z",
"ConsentDate": "2019-03-07T03:27:29Z",
"TotalTransactionCount": 18,
"LastTransactionCollectionPointId": "cea42a12-5de4-421a-b429-092e8d523948",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a57ee9da-b494-49e2-b562-6dfa31f190df",
"Name": "kbpurpose2",
"Version": 1,
"Status": "WITHDRAWN",
"FirstTransactionDate": "2019-03-28T03:23:44Z",
"LastTransactionDate": "2019-03-28T03:24:29Z",
"WithdrawalDate": "2019-03-28T03:24:29Z",
"ConsentDate": "2019-03-28T03:23:44Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "c29a99a9-de4d-4367-973b-95b0217d0640",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a1ccd810-94a0-4b58-946b-6705eae15c5b",
"Name": "Purpose01 v2",
"Version": 2,
"Status": "EXPIRED",
"FirstTransactionDate": "2019-05-29T04:05:42Z",
"LastTransactionDate": "2019-06-05T12:02:06Z",
"WithdrawalDate": "2019-05-29T11:09:12Z",
"ConsentDate": "2019-05-29T04:05:42Z",
"ExpiryDate": "2019-06-05T12:02:06Z",
"TotalTransactionCount": 8,
"Topics": [
{
"Id": "af7bf604-2058-4089-985c-c84083e3e3e3",
"Name": "New_Topic",
"IsConsented": true
}
],
"LastTransactionCollectionPointId": "735c85c8-c69c-44bc-8bad-ec0e806090bd",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a313353a-e13b-4554-be08-22cf4a78a31c",
"Name": "Purpose_1804 v2",
"Version": 2,
"Status": "ACTIVE",
"FirstTransactionDate": "2019-05-29T04:05:42Z",
"LastTransactionDate": "2019-05-29T11:09:30Z",
"WithdrawalDate": "2019-05-29T11:05:30Z",
"ConsentDate": "2019-05-29T04:05:42Z",
"TotalTransactionCount": 4,
"CustomPreferences": [
{
"Id": "4935d35a-7216-480d-9da9-1aef0e078b89",
"Name": "Custom_S",
"Options": [
{
"Id": "8acc2f9f-37f8-4ace-a513-fae6b7dd0aa9",
"Name": "Option2",
"IsConsented": true
}
]
}
],
"LastTransactionCollectionPointId": "735c85c8-c69c-44bc-8bad-ec0e806090bd",
"LastTransactionCollectionPointVersion": 1
}
],
"TestDataSubject": false
},
"first": true,
"empty": false
}
]
}
您可以通过对以下对象发出POST请求来创建源连接: Flow Service API。 源连接由连接ID、源数据文件的路径以及连接规范ID组成。
API格式
POST /sourceConnections
请求
以下请求创建源连接 OneTrust Integration :
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "ONETRUST Source Connection",
"description": "ONETRUST Source Connection",
"baseConnectionId": "622124ca-6d18-47f7-999c-66f599955309",
"connectionSpec": {
"id": "cf16d886-c627-4872-9936-fb08d6cba8cc",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {}
}'
属性 | 描述 |
---|---|
name |
源连接的名称。 确保源连接的名称是描述性的,因为您可以使用此名称查找源连接的信息。 |
description |
可包含的可选值,用于提供有关源连接的更多信息。 |
baseConnectionId |
的基本连接ID OneTrust Integration. 此ID是在前面的步骤中生成的。 |
connectionSpec.id |
与源对应的连接规范ID。 |
data.format |
的格式 OneTrust Integration 要摄取的数据。 目前,唯一支持的数据格式为 json . |
响应
成功响应将返回唯一标识符(id
)。 此ID在后续步骤中是创建数据流所必需的。
{
"id": "eb5833d3-230d-4700-80cc-bda396e7af8a",
"etag": "\"da04c07f-0000-0200-0000-621f1afc0000\""
}
为了在Platform中使用源数据,必须创建一个目标架构,以根据您的需求构建源数据。 然后,使用目标架构创建包含源数据的Platform数据集。
可以通过向以下对象执行POST请求来创建目标XDM架构 架构注册表API.
有关如何创建目标XDM架构的详细步骤,请参阅关于的教程 使用API创建架构.
可以通过向执行POST请求来创建目标数据集 目录服务API,在有效负载中提供目标架构的ID。
有关如何创建目标数据集的详细步骤,请参阅关于的教程 使用API创建数据集.
目标连接表示与要存储所摄取数据的目标的连接。 要创建目标连接,您必须提供对应于目标连接的固定连接规范ID。 Data Lake. 此ID为: c604ff05-7f1a-43c0-8e18-33bf874cb11c
.
现在,目标架构和目标数据集的连接规范ID均为唯一标识符 Data Lake. 使用这些标识符,您可以使用 Flow Service 用于指定将包含入站源数据的数据集的API。
API格式
POST /targetConnections
请求
以下请求创建目标连接 OneTrust Integration :
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "ONETRUST Target Connection",
"description": "ONETRUST Target Connection",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {
"dataSetId": "61f6ca3f33978c19486bb463"
}
}'
属性 | 描述 |
---|---|
name |
目标连接的名称。 确保目标连接的名称是描述性的,因为您可以使用此名称查找有关目标连接的信息。 |
description |
可包含的可选值,用于提供有关目标连接的更多信息。 |
connectionSpec.id |
与对应的连接规范ID Data Lake. 此固定ID为: c604ff05-7f1a-43c0-8e18-33bf874cb11c . |
data.format |
的格式 OneTrust Integration 要带到Platform的数据。 |
params.dataSetId |
在上一步中检索的目标数据集ID。 |
响应
成功响应将返回新目标连接的唯一标识符(id
)。 此ID在后续步骤中是必需的。
{
"id": "495f761f-310a-4a7b-ae78-5b1152d74b38",
"etag": "\"410a7b0c-0000-0200-0000-621f1afd0000\""
}
为了将源数据引入目标数据集,必须首先将其映射到目标数据集所遵循的目标架构。 这可以通过向以下对象执行POST请求来实现 Data Prep API 在请求有效负载中定义数据映射。
API格式
POST /conversion/mappingSets
请求
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"version": 0,
"xdmSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/cfc8cee182e546c1fb35071185524b465e06bf1acb74f30d",
"xdmVersion": "1.0",
"id": null,
"mappings": [{
"sourceType": "ATTRIBUTE",
"source": "content.Identifier",
"destination": "_id",
"name": "id",
"description": "Identifier field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.Identifier",
"destination": "_exchangesandboxbravo.Identifier"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.Language",
"destination": "_exchangesandboxbravo.Language",
"description": "Language field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.CreatedDate",
"destination": "_exchangesandboxbravo.CreatedDate",
"description": "Created Date field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.LastUpdatedDate",
"destination": "_exchangesandboxbravo.LastUpdatedDate",
"description": "Created Date field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.DataElements",
"destination": "_exchangesandboxbravo.DataElements"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.Purposes",
"destination": "_exchangesandboxbravo.Purposes"
}
]
}'
属性 | 描述 |
---|---|
xdmSchema |
的ID 目标XDM架构 在之前的步骤中生成。 |
mappings.destinationXdmPath |
源属性将映射到的目标XDM路径。 |
mappings.sourceAttribute |
需要映射到目标XDM路径的源属性。 |
响应
成功响应将返回新创建映射的详细信息,包括其唯一标识符(id
)。 在后续步骤中需要使用此值来创建数据流。
{
"id": "a87f130e82f04d5188da01f087805c4b",
"version": 0,
"createdDate": 1646205694395,
"modifiedDate": 1646205694395,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
从以下来源获取数据的最后一步 OneTrust Integration 到Platform就是创建数据流。 现在,您已准备以下必需值:
数据流负责从源中计划和收集数据。 您可以通过在有效负载中提供上述值时执行POST请求来创建数据流。
要计划摄取,您必须先将开始时间值设置为纪元时间(以秒为单位)。 然后,必须将频率值设置为五个选项之一: once
, minute
, hour
, day
,或 week
. 间隔值用于指定两次连续摄取之间的时间段,但是,创建一次性摄取不需要设置间隔。 对于所有其他频率,间隔值必须设置为等于或大于 15
.
API格式
POST /flows
请求
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "ONETRUST dataflow",
"description": "ONETRUST dataflow",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"eb5833d3-230d-4700-80cc-bda396e7af8a"
],
"targetConnectionIds": [
"495f761f-310a-4a7b-ae78-5b1152d74b38"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "a87f130e82f04d5188da01f087805c4b",
"mappingVersion": 0
}
}
],
"scheduleParams": {
"startTime": "1625040887",
"frequency": "minute",
"interval": 15
}
}'
属性 | 描述 |
---|---|
name |
数据流的名称。 确保数据流的名称是描述性的,因为您可以使用此名称查找数据流上的信息。 |
description |
可包含的可选值,用于提供有关数据流的更多信息。 |
flowSpec.id |
创建数据流所需的流规范ID。 此固定ID为: 6499120c-0b15-42dc-936e-847ea3c24d72 . |
flowSpec.version |
流规范ID的相应版本。 此值默认为 1.0 . |
sourceConnectionIds |
此 源连接ID 在之前的步骤中生成。 |
targetConnectionIds |
此 目标连接Id 在之前的步骤中生成。 |
transformations |
此属性包含需要应用于数据的各种转换。 将不符合XDM的数据引入到Platform时需要此属性。 |
transformations.name |
分配给转换的名称。 |
transformations.params.mappingId |
此 映射Id 在之前的步骤中生成。 |
transformations.params.mappingVersion |
映射ID的相应版本。 此值默认为 0 . |
scheduleParams.startTime |
此属性包含有关数据流的摄取调度的信息。 |
scheduleParams.frequency |
数据流收集数据的频率。 可接受的值包括: once , minute , hour , day ,或 week . |
scheduleParams.interval |
间隔指定两次连续流运行之间的周期。 间隔值应为非零整数。 当频率设置为时,不需要间隔 once 和应大于或等于 15 其他频率值。 |
响应
成功的响应会返回ID (id
)。 您可以使用此ID监视、更新或删除数据流。
{
"id": "70045189-42f0-493d-9b9e-be1045a9f4fa",
"etag": "\"1601e900-0000-0200-0000-621f1b080000\""
}
以下部分提供了有关监视、更新和删除数据流的步骤的信息。
创建数据流后,您可以监视通过它摄取的数据,以查看有关流运行、完成状态和错误的信息。 有关完整的API示例,请阅读以下指南: 使用API监控源数据流.
通过向发出PATCH请求,更新数据流的详细信息,例如其名称和描述,以及其运行计划和关联的映射集。 /flows
端点 Flow Service API,同时提供数据流的ID。 发出PATCH请求时,必须提供数据流的唯一值 etag
在 If-Match
标头。 有关完整的API示例,请阅读以下指南: 使用API更新源数据流.
PATCH通过向 Flow Service API,同时将基本连接ID作为查询参数提供。 在提出PATCH请求时,您必须提供源帐户的唯一 etag
在 If-Match
标头。 有关完整的API示例,请阅读以下指南: 使用API更新源帐户.
通过向以下对象执行DELETE请求来删除您的数据流: Flow Service API,以便在查询参数中提供要删除的数据流的ID。 有关完整的API示例,请阅读以下指南: 使用API删除数据流.
向以下人员发出DELETE请求以删除您的帐户: Flow Service 提供要删除的帐户的基本连接ID时的API。 有关完整的API示例,请阅读以下指南: 使用API删除源帐户.