宛先を公開エンドポイント API の操作

重要

この API エンドポイントを使用する必要があるのは、製品化された(公開)宛先を送信し、他のExperience Platformのお客様が使用できるようにする場合のみです。 独自の用途で非公開の宛先を作成する場合は、公開 API を使用して正式に宛先を送信する必要はありません。

重要

API エンドポイントplatform.adobe.io/data/core/activation/authoring/destinations/publish

このページでは、/authoring/destinations/publish API エンドポイントを使用して実行できるすべての API の操作について説明します。

宛先を設定およびテストしたら、レビューおよび公開用にアドビへと送信できます。読み取り 送信してレビュー用に、Destination SDKで作成した宛先を送信 宛先の送信プロセスの一環として実行する必要があるその他のすべての手順については、を参照してください。

公開リクエストを送信するには、次の場合に Publish Destinations API エンドポイントを使用します。

  • Destination SDK パートナーとして、すべての Experience Platform 組織をまたいですべての Experience Platform の顧客がすべての Experience Platform の顧客が製品化された宛先を利用できるようにする場合。
  • あなたは 更新の有無 を設定に追加します。 設定の更新は、新しい公開リクエストを送信した後にのみ、宛先に反映されます。このリクエストはExperience Platformチームが承認します。

宛先公開 API 操作の概要

続行する前に、はじめる前にの重要情報を参照してください。これは、必要な宛先オーサリング権限および必要なヘッダーを取得する方法を含む、API への呼び出しに成功するために確認する必要があります。

公開用の宛先設定を送信

公開用の宛先設定を送信するには、/authoring/destinations/publish エンドポイントへの POST リクエストを作成します。

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。Destination Configuration API リファレンスを使用して、宛先設定の宛先 ID を取得します。
destinationAccess 文字列 用途 ALL を設定します。

応答

応答が成功すると、HTTP ステータス 201 と共に、宛先公開リクエストの詳細が返されます。

宛先の公開リクエストのリスト

IMS 組織のすべての宛先のリストを取得するには、/authoring/destinations/publish エンドポイントに GET リクエストを作成します。

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 と、自身がアクセス権を持つ、公開用に送信された宛先のリストを返します。1 つの configId は、1 つの宛先の公開リクエストに対応します。

{
   "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組織を返します。
  • の場合 "destinationType": "PUBLIC"の場合、このパラメーターは "*":宛先は、すべてのExperience Platform組織で使用できます。
  • の場合 "destinationType": "DEV"の場合、このパラメーターは宛先の作成およびテストに使用した組織の組織 ID を返します。
publishDetailsList.status 文字列 宛先の公開リクエストのステータス。使用可能な値は TESTREVIEWAPPROVEDPUBLISHEDDENIEDREVOKEDDEPRECATED です。値を持つ宛先 PUBLISHED は実稼動環境であり、Experience Platformのお客様が使用できます。
publishDetailsList.destinationType 文字列 宛先のタイプ。 値は DEV および PUBLIC. DEV は、Experience Platform組織の宛先に対応します。 PUBLIC は、公開用に送信した宛先に対応します。 Git では、これら 2 つのオプションを考えて、 DEV バージョンは、ローカルのオーサリングブランチを表し、 PUBLIC version は、リモートメインブランチを表します。
publishDetailsList.publishedDate 文字列 宛先が公開用に送信された日付(エポック時間)。

特定の宛先の公開リクエストのステータスの取得

特定の宛先の公開リクエストに関する詳細な情報を取得するには、/authoring/destinations/publish エンドポイントに GET リクエストを行い、公開ステータスを取得したい宛先の 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
      }
   ]
}

API エラー処理

Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。

次の手順

このドキュメントでは、宛先へ公開リクエストを送信する方法を確認しました。Adobe Experience Platform チームが公開リクエストを確認し、5 営業日以内に連絡します。

このページ