當您將項目提交至目錄時,您必須包含 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"
}
}
}
下表說明提交文件的內容:
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
modelVersion |
字串 | 否 | 提交文件的版本號碼。 預設值為 1.0.0.0。 |
sourcePortal |
整數 (int) | 否 | 識別此請求的來源。 預設為 526430005 PAC CLI。 對於其他來源,請使用 526430000。 函式會 mspcat_GetPowerCatalogDetails 傳回完整清單。 屬性會 mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions 列出可用的選項。 |
submissionId |
全球唯一識別碼 (GUID) | 否 | 識別提交的 Guid。 此值是外部索引鍵,可將要求鏈結至其他系統。 |
operation |
字串 | Yes | 為了未來的擴展,目前不受到尊重。 要使用的作業類型。 有效值: - CreateOrUpdate (預設)- Create- Update- Disabled |
businessJustification |
字串 | 否 | 描述提交給核准者的商業價值。 此值可以包含 HTML 或 RTF 格式 (RTF)。 此資訊會出現在製作者探索使用者體驗的計劃取用體驗中。 例如,用戶可能會說他們的提交有助於降低成本或生產力。 有些組織需要某些值類別,可以在此處輸入這些值。 |
publisherDetails |
Publisher | Yes | 與此項目提交相關聯的發行者。 |
catalogItemDefinition |
目錄項目定義 | Yes | 定義要提交的目錄項目。 |
Publisher
使用此資料來指定型錄提交項目 publisherDetails 內容。
建立可與一或多個 Microsoft Entra ID 群組相關聯的發行者記錄,其中包含授權使用者,這些使用者可以繼續更新目錄專案。
備註
請勿將此術語與 Solution Publisher 混淆。 目錄項目發行者不會與解決方案搭配使用。
您至少需要提供。publisherDisplayName
publisherId 可以是任何字串值。 系統會檢查該發行者是否存在,否則會建立它並指派 publisherId.
例如,開發人員的 HR IT 小組可以建立發行者,並使用 Microsoft Entra 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"
}
]
}
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
publisherId |
字串 | Yes | 此發行者的唯一識別碼。 當您為此發行者建立或更新目錄項目時,請使用此識別碼來識別此發行者。 目錄項目一次只能與一個發行者相關聯。 值可以是 GUID 或字串。 一旦設置,就必須維護。 |
publisherDisplayName |
字串 | Yes | 取用者會在目錄庫中看到此資料。 |
publisherUpnList |
目錄UPN操作[] | 否 | 可以以此發行者身分提交新目錄項目或更新目錄項目的人員。 在第一次建立發行者時,一律包含提交使用者。 |
publisherAADGroupOIDS |
目錄組操作[] | 否 | 允許其成員存取此發行者的 Entra ID 群組。 |
目錄UPN操作
使用此資料來指定 PublisherpublisherUpnList 屬性。
定義一個作業,以新增或移除可以提交新或更新目錄項目作為此發行者的人員。
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
action |
字串 | Yes | 使用此 UPN 要採取的動作。 有效值: Add 或 Remove。 |
upn |
字串 | Yes | 使用者的使用者主體名稱 (UPN)。 |
userOid |
全球唯一識別碼 (GUID) | Yes | 使用者的物件識別碼。 |
CatalogGroup作業
使用此資料來指定 PublisherpublisherAADGroupOIDS 屬性。
定義新增或移除可存取此發行者的 Entra ID 群組的作業。
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
action |
字串 | Yes | 使用此 UPN 要採取的動作。 有效值: Add 或 Remove。 |
groupName |
字串 | Yes | 群組名稱。 |
groupOid |
全球唯一識別碼 (GUID) | Yes | 群組的物件識別碼。 |
groupType |
字串 | Yes | 要處理的群組類型。 有效值為 Security 和 Modern。 |
目錄項目定義
使用此資料來指定型錄提交項目 catalogItemDefinition 內容。
這些內容會定義要提交的型錄項目。 這是實際的 Power Platform 解決方案。 套件是儲存在型錄中的內容。
以下是目錄項目的範例,包括其engineeringNamesupportName和必填的連絡人。
"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"
}
}
}
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
id |
全球唯一識別碼 (GUID) | Yes | 目錄項目的唯一 ID。 更新或安裝目錄項目時,請使用此識別碼。 |
displayName |
字串 | Yes | 在目錄圖庫中向取用者顯示的名稱。 |
description |
字串 | 否 | 在目錄圖庫中向消費者顯示的說明。 |
offer |
優惠詳情 | Yes | 目錄項目提交的詳細資料。 |
packageFile |
目錄檔案資產 | Yes | 描述從何處取得提交的目錄套件檔案。 |
優惠詳情
使用此資料來指定 CatalogItemDefinitionoffer 屬性。
這些內容會定義型錄項目提交的詳細資料。
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
businessCategories |
int[] | 否 | 目標型錄所遵循的選擇選項值清單。 識別要與此目錄項目相關聯的業務類別。 請參閱 商務類別 以取得要使用的有效值。 |
type |
字串 | Yes | 目錄項目的類型。 有效值: - Application- Component_Collection |
supportsApplicationTypes |
字串[] | 否 | 支援的應用程式類型清單。 有效值: - CanvasApps- ModelApps- PowerPortals- PowerAutomate |
deploymentType |
字串 | Yes | 指出部署此目錄項目的部署類型。 有效值: - Normal 代表 受管理項目。- Template 非受控解決方案的複本,其他製作者可以隨心所欲地編輯。 進一步了解目錄項目類型 |
searchKeywords |
字串[] | 否 | 人們可能用來尋找此目錄項目的詞語。 |
small48x48Image |
目錄檔案資產 | 否 | 圖庫視圖的圖像。 如果您未提供此映像,則會使用系統預設圖示。 |
large216x216Image |
目錄檔案資產 | 否 | 圖片為詳細視圖。 提供要在製作者或其他探索UI中顯示的圖示。 某些使用者體驗會使用較大的圖示來轉譯卡片以供探索。 |
useCaseDocument |
目錄檔案資產 | 否 | 使用案例描述和對核准者的說明。 |
videos |
目錄文件資產[] | 否 | 詳細資料檢視會顯示這些視訊/gif檔案的連結。 |
documents |
目錄文件資產[] | 否 | 詳細資料檢視會顯示這些檔案的連結。 |
screenshots |
目錄文件資產[] | 否 | 詳細視圖顯示這些影像。 您可以在此處傳遞應用程式的螢幕擷取畫面,以協助製作者識別此應用程式是否提供他們正在尋找的功能或能力。 人們在下載應用程式或範本之前最常做的事情是查看其圖像和螢幕截圖以了解功能,而不是閱讀說明。 |
helpLink |
統一資源識別碼 (URI) | 否 | 文件連結。 這些 URL 可以是內部文件或 SharePoint 資源的連結。 |
privacyPolicyLink |
統一資源識別碼 (URI) | 否 | 隱私文件的連結。 有關謹慎使用正在提交的元件或應用程式的政策。 |
legalTermsLink |
統一資源識別碼 (URI) | 否 | 連結至條款與條件文件。 評估目錄項目消費者的任何法律條款或內部指南。 |
legalTerms |
字串 | 否 | 條款和條件文件的 Markdown、HTML 或文字版本。 評估目錄項目消費者的任何法律條款或內部指南。 |
sourceCodeRepositoryLink |
統一資源識別碼 (URI) | 否 | 連結至原始碼存放庫 |
engineeringName |
人員聯絡資訊 | Yes | 開發此目錄項目的工程師或小組的聯絡資訊。 |
supportName |
人員聯絡資訊 | 否 | 支援此目錄項目的支援或群組的聯絡資訊。 可以與目錄項目的取用者在遇到應用程式問題時可以聯絡的工程連絡人相同。 |
業務類別
將 OfferDetailsbusinessCategories 屬性設定為下列一或多個業務類別:
| Code | Description |
|---|---|
526430000 |
顧客服務 |
526430001 |
專案管理 |
526430002 |
日曆管理和日程安排 |
526430003 |
電子郵件管理 |
526430004 |
文件和文檔 |
526430005 |
通知和提醒 |
526430006 |
Analytics |
526430007 |
協作 |
526430008 |
Commerce |
526430009 |
金融 |
526430010 |
合規性與法律 |
526430011 |
Sales |
526430012 |
IT工具 |
526430013 |
Marketing |
526430014 |
作業和供應鏈 |
526430015 |
物聯網 |
526430016 |
人工智慧機器學習 |
526430017 |
地理位置 |
526430018 |
人力資源 |
目前無法設定新的業務類別,但可以從目錄業務類別 (mspcat_catalogbusinesscategory) 全域選項中擷取。
目錄檔案資產
這些屬性會定義 CatalogItemDefinitionpackageFile 和 OfferDetailssmall48x48Image、large216x216Image、useCaseDocumentvideosdocuments、 和screenshots屬性中參考的檔案。
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
name |
字串 | Yes | 檔案名稱。 |
filesaslink |
統一資源識別碼 (URI) | Yes | 下載檔案的連結。 如果連結需要驗證,請提供 共用存取簽章 (SAS) URL。 |
人員聯絡資訊
這些屬性會定義目錄項目 OfferDetailsengineeringName 和 supportName 屬性中的人員。
| 房產 | 類型 | 為必填項目 | Description |
|---|---|---|---|
firstName |
字串 | 否 | 人名。 |
lastName |
字串 | Yes | 個人姓氏。 |
email |
字串 | Yes | 人員電子郵件地址。 |
phoneNumber |
字串 | 否 | 人員電話號碼。 |