擷取目的地發佈請求

IMPORTANT
如果您要提交產品化(公用)目的地以供其他Experience Platform客戶使用,則只需使用此API端點即可。 如果您要建立私人目的地以供您自用,則不需要使用發佈API正式提交目的地。
IMPORTANT
API端點platform.adobe.io/data/core/activation/authoring/destinations/publish

設定並測試目的地後,您就可以將其提交至Adobe以供稽核和發佈。 讀取 提交以Destination SDK撰寫的目的地,以供複查 您必須在目的地提交程式中執行的所有其他步驟。

發生下列情況時,請使用發佈目的地API端點提交發佈請求:

  • 身為Destination SDK合作夥伴,您想要讓所有Experience Platform組織都能使用已生產化的目的地,以供所有Experience Platform客戶使用;
  • 您製作 任何更新 至您的設定。 只有在您提交經Experience Platform團隊核准的新發佈請求後,設定更新才會反映在目的地中。
IMPORTANT
Destination SDK支援的所有引數名稱和值如下 區分大小寫. 為避免區分大小寫錯誤,請完全依照檔案中所示使用引數名稱和值。

Destination Publishing API操作快速入門 get-started

在繼續之前,請檢閱 快速入門手冊 如需您成功呼叫API所需的重要資訊,包括如何取得必要的目的地撰寫許可權和必要的標頭。

列出目的地發佈請求 retrieve-list

您可以透過向以下網站發出GET請求,擷取為您的IMS組織提交的所有目的地清單: /authoring/destinations/publish 端點。

API格式

使用下列API格式來擷取您帳戶的所有發佈請求。

GET /authoring/destinations/publish

使用下列API格式來擷取特定的發佈請求,定義由 {DESTINATION_ID} 引數。

GET /authoring/destinations/publish/{DESTINATION_ID}

要求

以下兩個請求會擷取您IMS組織的所有發佈請求或特定發佈請求,具體取決於您是否傳遞 DESTINATION_ID 請求中的引數。

選取下方的每個索引標籤以檢視對應的裝載。

擷取所有發佈請求
accordion
請求

下列請求將依據以下內容擷取您提交的發佈請求清單 IMS Org ID 和沙箱設定。

code language-shell
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}'
accordion
回應

以下回應會根據您使用的IMS組織ID和沙箱名稱,傳回HTTP狀態200,其中包含您有權存取的提交以進行發佈的所有目的地清單。 一 configId 對應至一個目的地的發佈要求。

code language-json
{
   "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
      }
   ]
}
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 layout-auto
參數 類型 說明
destinationId 字串 您已提交發佈的目的地組態目的地ID。
publishDetailsList.configId 字串 您提交之目的地的目的地發佈要求唯一ID。
publishDetailsList.allowedOrgs 字串

傳回目的地可用的Experience Platform組織。

  • "destinationType": "PUBLIC",此引數會傳回 "*",表示所有Experience Platform組織都可使用目的地。
  • "destinationType": "DEV",此引數會傳回您用來製作及測試目的地的組織ID。
publishDetailsList.status 字串 目的地發佈要求的狀態。 可能的值包括 TESTREVIEWAPPROVEDPUBLISHEDDENIEDREVOKEDDEPRECATED. 具有值的目的地 PUBLISHED 是即時的,可供Experience Platform客戶使用。
publishDetailsList.destinationType 字串 目的地的型別。 值可以是 DEVPUBLIC. DEV 對應至您Experience Platform組織中的目的地。 PUBLIC 對應至您已提交發佈的目的地。 以Git術語來思考這兩個選項,其中 DEV 版本代表您的本機編寫分支,而 PUBLIC 版本代表遠端主要分支。
publishDetailsList.publishedDate 字串 以紀元時間提交目的地以供發佈的日期。
擷取特定發佈請求
accordion
請求
code language-shell
curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/publish/{DESTINATION_ID} \
 -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}'
table 0-row-2 1-row-2
參數 說明
{DESTINATION_ID} 您要擷取發佈狀態之目的地的ID。
accordion
回應

如果您傳入 DESTINATION_ID 在API呼叫中,回應會傳回HTTP狀態200,其中包含指定之目的地發佈要求的詳細資訊。

code language-json
{
   "destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
   "publishDetailsList":[
      {
         "configId":"123cs780-ce29-434f-921e-4ed6ec2a6c35",
         "allowedOrgs": [
            "*"
         ],
         "status":"PUBLISHED",
         "destinationType": "PUBLIC",
         "publishedDate":"1630617746"
      }
   ]
}
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 layout-auto
參數 類型 說明
destinationId 字串 您已提交發佈的目的地組態目的地ID。
publishDetailsList.configId 字串 您提交之目的地的目的地發佈要求唯一ID。
publishDetailsList.allowedOrgs 字串

傳回目的地可用的Experience Platform組織。

  • "destinationType": "PUBLIC",此引數會傳回 "*",表示所有Experience Platform組織都可使用目的地。
  • "destinationType": "DEV",此引數會傳回您用來製作及測試目的地的組織ID。
publishDetailsList.status 字串 目的地發佈要求的狀態。 可能的值包括 TESTREVIEWAPPROVEDPUBLISHEDDENIEDREVOKEDDEPRECATED. 具有值的目的地 PUBLISHED 是即時的,可供Experience Platform客戶使用。
publishDetailsList.destinationType 字串 目的地的型別。 值可以是 DEVPUBLIC. DEV 對應至您Experience Platform組織中的目的地。 PUBLIC 對應至您已提交發佈的目的地。 以Git術語來思考這兩個選項,其中 DEV 版本代表您的本機編寫分支,而 PUBLIC 版本代表遠端主要分支。
publishDetailsList.publishedDate 字串 以紀元時間提交目的地以供發佈的日期。

API錯誤處理

Destination SDK API端點遵循一般Experience Platform API錯誤訊息原則。 請參閱 API狀態代碼請求標頭錯誤 (位於平台疑難排解指南中)。

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6