カタログ アイテム送信ドキュメント参照

カタログにアイテムを送信するときは、JSON 形式でデータを含める必要があります。 この記事では、そのドキュメントの有効なプロパティについて説明します。 この JSON が一例です:

{
  "modelVersion": "1.0.0.0",
  "operation": "CreateOrUpdate",
  "sourcePortal": 526430005,
  "businessJustification": "Power Platform custom connector for Conference API",
  "publisherDetails": {
    "publisherId": "ContosoConferencesTeam",
    "publisherDisplayName": "Catalog Conferences Team"
  },
  "catalogItemDefinition": {
    "id": "ContosoConferencesCustomConnector",
    "displayName": "Contoso Conference Custom Connector",
    "description": "Demo Custom connector to query Conference Speakers & Sessions",
    "offer": {
      "type": "Component_Collection",
      "deploymentType": "Normal",
      "engineeringName": {
        "firstName": "Jennifer",
        "lastName": "Wilkins",
        "email": "jwilkins@contoso.com",
        "phoneNumber": "555-111-1234"
      },
      "supportName": {
        "firstName": "Aidan",
        "lastName": "Hunt",
        "email": "ahunt@contoso.com",
        "phoneNumber": "555-111-1234"
      }
    },
      "packageFile": {
         "name": "packageFileName.zip",
         "filesaslink": "https://Contoso.blob.core.windows.net/ContosoConferencesCustomConnector/packageFileName.zip"
      }
  }
}

次の表では、送信ドキュメントについて説明します。

発行者

このデータを使用して、カタログ送信アイテム publisherDetails プロパティを指定します。

カタログ アイテムを今後更新できる許可されているユーザーを含む 1 つ以上の Microsoft Entra ID グループに関連付けることができる発行者レコードを作成します。

少なくとも、publisherDisplayName を提供する必要があります。 publisherId は任意の文字列にできます。 システムはその発行者が存在するかどうかを確認し、存在しない場合は発行者を作成して publisherId を割り当てます。

たとえば、開発者の HR IT チームは発行者を作成し、Microsoft Entra ID グループを使用して開発者を ID 化できます。

以下は、人物とEntra IDグループを追加する操作を含むパブリッシャーレコードのサンプルです。

{
   "publisherId": "MyPublisherId",
   "publisherDisplayName": "Contoso Publishing",
   "publisherUpnList": [
      {
         "action": "Add",
         "upn": "john.doe@contoso.com"
      }
   ],
   "publisherAADGroupOIDS": [
      {
         "action": "Add",
         "groupName": "PowerCatalogSubmitters",
         "groupOID": "2ded6de9-ab44-4478-9bd4-e609947daa2e",
         "groupType": "Security"
      }
   ]
}

CatalogUPNOperation

このデータを使用して、 PublisherpublisherUpnList プロパティを指定します。

この発行者として新しいカタログ項目を送信したり、カタログ項目を更新したりできるユーザーを追加または削除する操作を定義します。

カタロググループ操作

このデータを使用して、 PublisherpublisherAADGroupOIDS プロパティを指定します。

このパブリッシャーにアクセスできるEntra IDグループを追加または削除する操作を定義します。

カタログ項目定義

このデータを使用して、カタログ送信アイテム catalogItemDefinition プロパティを指定します。

これらのプロパティは、送信されるカタログ項目を定義します。 これは、実際の Power Platform ソリューションです。 パッケージとは、カタログに格納されているものです。

以下は、その engineeringName と supportName 連絡先が必須であることを含むカタログ アイテムの例です。

"catalogItemDefinition": {
   "id": "ContosoTravelsApp",
   "displayName": "Contoso Travel Expense App",
   "description": "Submit expenses on the go!",
   "offer": {
   "businessCategories": [526430000, 526430001, 526430002],
   "type": "Component_Collection",
   "deploymentType": "Normal",
   "small48x48Image": {
      "name": "Small48Image",
      "fileSasLink": "https://www.contoso.com/icon48.jpg"      
   },
   "large216x216Image": {
      "name": "Large216image2",
      "fileSasLink": "https://www.contoso.com/icon216.jpg"
   },
   "documents": [
      {
         "name": "ImaNewfile",
         "fileSasLink": "https://www.contoso.com/screenshot1.jpg"
      },
      {
         "name": "ImaNewfile2",
         "fileSasLink": "https://www.contoso.com/screenshot2.jpg"
      }
   ],
   "helpLink": "https://www.contoso.com/help.html",
   "privacyPolicyLink": "https://www.contoso.com/privacy.html",
   "legalTerms": "https://www.contoso.com/legal.html",
   "engineeringName": {
      "firstName": "John",
      "lastName": "Roon",
      "email": "john@contoso.com",
      "phoneNumber": "999-111-1234"
   },
   "supportName": {
      "firstName": "Jane",
      "lastName": "Drill",
      "email": "jane@contoso.com",
      "phoneNumber": "999-111-1234"
   }
   }
}

オファー詳細

このデータを使用して、CatalogItemDefinitionoffer プロパティを設定します。

これらのプロパティは、カタログ アイテムの送信の詳細を定義します。

ビジネス カテゴリ

OfferDetailsbusinessCategories プロパティには、これらのビジネス カテゴリの 1 つ以上を設定します。

現在、新しいビジネスカテゴリを設定することはできませんが、カタログビジネスカテゴリ (mspcat_catalogbusinesscategory) グローバル チョイスから取得することができます。

カタログファイルアセット

これらのプロパティは、CatalogItemDefinitionpackageFile および OfferDetailssmall48x48Image、 large216x216Image、 useCaseDocument、 videos、 documents、そして screenshots プロパティで参照されるファイルを定義します。

PersonContactInformation

これらのプロパティは、カタログ項目の人物を OfferDetailsengineeringName および supportName プロパティで定義します。