仅当您提交的是要供其他Experience Platform客户使用的产品化(公共)目标时,才需要使用此API端点。 如果您创建供自己使用的专用目标,则无需使用发布API正式提交该目标。
API端点: platform.adobe.io/data/core/activation/authoring/destinations/publish
本页列出并介绍了您可以使用 /authoring/destinations/publish
API端点。
配置并测试目标后,您可以将其提交到Adobe以进行审核和发布。 读取 提交以供审核在Destination SDK中创作的目标 在目标提交流程中,您必须执行所有其他步骤。
在以下情况下,使用发布目标API端点提交发布请求:
在继续之前,请查看 入门指南 有关成功调用API所需的重要信息,包括如何获取所需的目标创作权限和所需标头。
您可以通过向发布POST请求,提交要发布的目标配置 /authoring/destinations/publish
端点。
API格式
POST /authoring/destinations/publish
请求
以下请求会提交一个目标,以便在有效负载中提供的参数配置的组织之间进行发布。 以下负载包括接受的所有参数 /authoring/destinations/publish
端点。
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations/publish \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
"destinationAccess":"ALL"
}
参数 | 类型 | 描述 |
---|---|---|
destinationId |
字符串 | 您要提交以进行发布的目标配置的目标ID。 使用 目标配置API引用. |
destinationAccess |
字符串 | 使用 ALL ,以便您的目标显示在所有Experience Platform客户的目录中。 |
响应
成功响应会返回HTTP状态201,其中包含目标发布请求的详细信息。
您可以通过向 /authoring/destinations/publish
端点。
API格式
GET /authoring/destinations/publish
请求
以下请求会根据IMS组织和沙盒配置,检索您有权访问的用于发布的已提交目标列表。
curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/publish \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
响应
以下响应会根据您使用的IMS组织ID和沙盒名称,返回HTTP状态200,其中包含已提交以供发布的目标列表,您有权访问这些目标。 一个 configId
对应于一个目标的发布请求。
{
"destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
"publishDetailsList":[
{
"configId":"123cs780-ce29-434f-921e-4ed6ec2a6c35",
"allowedOrgs": [
"*"
],
"status":"PUBLISHED",
"destinationType": "PUBLIC",
"publishedDate":"1630617746"
}
]
}
参数 | 类型 | 描述 |
---|---|---|
destinationId |
字符串 | 您为发布而提交的目标配置的目标ID。 |
publishDetailsList.configId |
字符串 | 您提交的目标的目标发布请求的唯一ID。 |
publishDetailsList.allowedOrgs |
字符串 | 返回目标可用的Experience Platform组织。
|
publishDetailsList.status |
字符串 | 目标发布请求的状态。 可能的值为 TEST , REVIEW , APPROVED , PUBLISHED , DENIED , REVOKED , DEPRECATED . 具有值的目标 PUBLISHED 是实时的,可供Experience Platform客户使用。 |
publishDetailsList.destinationType |
字符串 | 目标的类型。 值可以是 DEV 和 PUBLIC . DEV 对应于您的Experience Platform组织中的目标。 PUBLIC 对应于您提交以进行发布的目标。 请用Git术语来考虑这两个选项,其中 DEV 版本表示您的本地创作分支,并且 PUBLIC 版本表示远程主分支。 |
publishDetailsList.publishedDate |
字符串 | 提交目标以进行发布的日期(以纪元时间表示)。 |
您可以通过向 /authoring/destinations/publish
端点和提供要检索发布状态的目标ID。
API格式
GET /authoring/destinations/publish/{DESTINATION_ID}
参数 | 描述 |
---|---|
{DESTINATION_ID} |
要检索其发布状态的目标ID。 |
请求
curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/publish/1230e5e4-4ab8-4655-ae1e-a6296b30f2ec \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
响应
成功响应会返回HTTP状态200,其中包含有关指定目标发布请求的详细信息。
{
"destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
"publishDetailsList":[
{
"configId":"ab41387c0-4772-4709-a3ce-6d5fee654520",
"allowedOrgs":[
"716543205DB85F7F0A495E5B@AdobeOrg"
],
"status":"TEST",
"destinationType":"DEV"
},
{
"configId":"cd568c67-f25e-47e4-b9a2-d79297a20b27",
"allowedOrgs":[
"*"
],
"status":"DEPRECATED",
"destinationType":"PUBLIC",
"publishedDate":1630525501009
},
{
"configId":"ef6f07154-09bc-4bee-8baf-828ea9c92fba",
"allowedOrgs":[
"*"
],
"status":"PUBLISHED",
"destinationType":"PUBLIC",
"publishedDate":1630531586002
}
]
}
Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码 和 请求标头错误 平台疑难解答指南中。
阅读本文档后,您现在知道如何提交目标的发布请求。 Adobe Experience Platform团队将审核您的发布请求,并在5个工作日内回复给您。