Tham chiếu tài liệu gửi mục ca-ta-lô

Bạn phải bao gồm dữ liệu ở định dạng JSON khi gửi một mục đến ca-ta-lô. Bài viết này mô tả các thuộc tính hợp lệ cho tài liệu đó. JSON này là một ví dụ:

{
  "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"
      }
  }
}

Bảng này mô tả các thuộc tính cho tài liệu gửi:

Tài sản Kiểu Bắt buộc Sự miêu tả
modelVersion chuỗi Không Số phiên bản của tài liệu gửi. Mặc định là 1.0.0.0.
sourcePortal int Không Xác định nguồn của yêu cầu này. Mặc định là 526430005 PAC CLI. Đối với các nguồn khác, hãy sử dụng 526430000. Hàm trả mspcat_GetPowerCatalogDetails về danh sách đầy đủ. Thuộc tính mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions liệt kê các tùy chọn có sẵn.
submissionId guid Không Guid để xác định việc gửi. Giá trị này là khóa ngoại để cho phép liên kết yêu cầu với các hệ thống khác.
operation chuỗi Có Để mở rộng trong tương lai và hiện không được tôn trọng. Loại thao tác sẽ được sử dụng. Giá trị hợp lệ:
- CreateOrUpdate (Mặc định)
- Create
- Update
- Disabled
businessJustification chuỗi Không Mô tả giá trị doanh nghiệp của bản đệ trình cho người phê duyệt. Giá trị này có thể chứa HTML hoặc Văn bản có Định dạng (RTF). Thông tin này xuất hiện trong trải nghiệm tiêu thụ theo kế hoạch trong trải nghiệm người dùng khám phá nhà sản xuất. Người dùng có thể nói rằng việc gửi của họ giúp giảm chi phí hoặc năng suất chẳng hạn. Một số tổ chức yêu cầu một số lớp giá trị nhất định và các giá trị đó có thể được nhập ở đây.
publisherDetails Nhà xuất bản Có Nhà phát hành đã liên kết với bản gửi mục này.
catalogItemDefinition CatalogItemDefinition Có Xác định mục ca-ta-lô đang được gửi.

Nhà phát hành

Sử dụng dữ liệu này để xác định thuộc tính mục gửi ca-ta-lô publisherDetails .

Tạo một bản ghi nhà phát hành có thể được liên kết với một hoặc nhiều nhóm ID Microsoft Entra chứa người dùng được ủy quyền, những người có thể cập nhật mục ca-ta-lô từ giờ trở đi.

Lưu ý

Đừng nhầm lẫn thuật ngữ này với Nhà phát hành Giải pháp. Người phát hành mục ca-ta-lô không được dùng với các giải pháp.

Bạn cần cung cấp ở publisherDisplayName mức tối thiểu. publisherId có thể là bất kỳ giá trị chuỗi nào. Hệ thống sẽ kiểm tra xem nhà phát hành đó có tồn tại hay không, nếu không sẽ tạo và gán .publisherId

Ví dụ: nhóm nhà phát triển CNTT nhân sự có thể tạo nhà phát hành và ID nhà phát triển bằng cách sử dụng nhóm Microsoft Entra ID.

Đây là mẫu bản ghi nhà phát hành bao gồm các thao tác để thêm người và nhóm ID Entra

{
   "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"
      }
   ]
}
Tài sản Kiểu Bắt buộc Sự miêu tả
publisherId chuỗi Có ID duy nhất cho nhà phát hành này. Sử dụng ID này để xác định nhà phát hành này bất cứ khi nào bạn tạo hoặc cập nhật mục ca-ta-lô cho nhà phát hành này. Mục Ca-ta-lô chỉ có thể được liên kết với một nhà phát hành tại một thời điểm. Giá trị có thể là GUID hoặc chuỗi. Sau khi thiết lập, nó phải được duy trì.
publisherDisplayName chuỗi Có Người tiêu dùng nhìn thấy dữ liệu này trong bộ sưu tập danh mục.
publisherUpnList CatalogUPNOperation[] Không Những người có thể gửi mục ca-ta-lô mới hoặc cập nhật như nhà phát hành này. Luôn bao gồm người dùng gửi vào lần đầu tiên nhà xuất bản được tạo.
publisherAADGroupOIDS CatalogGroupOperation[] Không Nhóm ID Entra có thành viên được phép truy nhập nhà phát hành này.

Ca-ta-lôUPNOperation

Sử dụng dữ liệu này để xác định thuộc tính PublisherpublisherUpnList .

Xác định một thao tác để thêm hoặc loại bỏ những người có thể gửi mục ca-ta-lô mới hoặc cập nhật như nhà phát hành này.

Tài sản Kiểu Bắt buộc Sự miêu tả
action chuỗi Có Hành động cần thực hiện với UPN này. Giá trị hợp lệ: Add hoặc Remove.
upn chuỗi Có Tên Chính của Người dùng (UPN) của người dùng.
userOid guid Có Mã định danh Đối tượng cho người dùng.

CatalogGroupOperation

Sử dụng dữ liệu này để xác định thuộc tính PublisherpublisherAADGroupOIDS .

Xác định một thao tác để thêm hoặc loại bỏ Nhóm ID Entra có thể truy nhập nhà phát hành này.

Tài sản Kiểu Bắt buộc Sự miêu tả
action chuỗi Có Hành động cần thực hiện với UPN này. Giá trị hợp lệ: Add hoặc Remove.
groupName chuỗi Có Tên của nhóm.
groupOid guid Có Mã định danh đối tượng cho nhóm.
groupType chuỗi Có Loại Nhóm đang được giải quyết. Giá trị hợp lệ là Security và Modern.

CatalogItemDefinition

Sử dụng dữ liệu này để xác định thuộc tính mục gửi ca-ta-lô catalogItemDefinition .

Những thuộc tính này xác định mục ca-ta-lô đang được gửi. Đây là giải pháp Power Platform thực tế. Gói là những gì được lưu trữ trong ca-ta-lô.

Dưới đây là ví dụ về mục ca-ta-lô bao gồm các engineeringName liên hệ supportName và mục đó là bắt buộc.

"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"
   }
   }
}
Tài sản Kiểu Bắt buộc Sự miêu tả
id guid Có ID duy nhất của mục ca-ta-lô. Sử dụng ID này khi cập nhật hoặc cài đặt mục ca-ta-lô.
displayName chuỗi Có Tên hiển thị cho người tiêu dùng trong bộ sưu tập ca-ta-lô.
description chuỗi Không Mô tả được hiển thị cho người tiêu dùng trong bộ sưu tập danh mục.
offer OfferDetails Có Chi tiết về việc gửi mục ca-ta-lô.
packageFile CatalogFileAsset Có Mô tả nơi nhận tệp gói ca-ta-lô cho việc gửi.

OfferDetails

Sử dụng dữ liệu này để xác định thuộc tính CatalogItemDefinitionoffer .

Các thuộc tính này xác định chi tiết của việc gửi mục ca-ta-lô.

Tài sản Kiểu Bắt buộc Sự miêu tả
businessCategories int[] Không Danh sách các giá trị tùy chọn lựa chọn được tôn trọng bởi danh mục đích. Xác định thể loại kinh doanh để liên kết với mục ca-ta-lô này. Hãy xem Danh mục doanh nghiệp để biết các giá trị hợp lệ cần sử dụng.
type chuỗi Có Loại mục ca-ta-lô. Giá trị hợp lệ:
- Application
- Component_Collection
supportsApplicationTypes chuỗi[] Không Danh sách các loại ứng dụng được hỗ trợ. Giá trị hợp lệ:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType chuỗi Có Cho biết loại triển khai để triển khai mục ca-ta-lô này. Giá trị hợp lệ:
- Normal đại diện cho một mục được quản lý.
- Template Bản sao giải pháp không được quản lý của bạn mà các nhà sản xuất khác có thể chỉnh sửa tuy nhiên họ chọn.
Tìm hiểu thêm về loại mục ca-ta-lô
searchKeywords chuỗi[] Không Từ mọi người có thể dùng để tìm mục ca-ta-lô này.
small48x48Image CatalogFileAsset Không Hình ảnh cho dạng xem bộ sưu tập. Nếu bạn không cung cấp hình ảnh này, biểu tượng mặc định của hệ thống sẽ được sử dụng.
large216x216Image CatalogFileAsset Không Hình ảnh cho dạng xem chi tiết. Cung cấp một biểu tượng sẽ được hiển thị trong trình tạo hoặc giao diện người dùng khám phá khác. Một số trải nghiệm người dùng sử dụng các biểu tượng lớn hơn để hiển thị thẻ để khám phá.
useCaseDocument CatalogFileAsset Không Sử dụng mô tả trường hợp và giải thích cho người phê duyệt.
videos CatalogFileAsset[] Không Dạng xem chi tiết hiển thị liên kết đến các tệp video/gif này.
documents CatalogFileAsset[] Không Dạng xem chi tiết hiển thị nối kết đến các tệp này.
screenshots CatalogFileAsset[] Không Dạng xem chi tiết hiển thị những hình ảnh này. Bạn có thể chuyển ảnh chụp màn hình tại đây về ứng dụng của mình để giúp các nhà sản xuất xác định xem ứng dụng này có cung cấp chức năng hoặc chức năng mà họ đang tìm kiếm hay không. Điều phổ biến nhất mọi người làm trước khi tải xuống một ứng dụng hoặc mẫu là xem hình ảnh và ảnh chụp màn hình của ứng dụng hoặc mẫu đó để hiểu rõ các chức năng thay vì đọc mô tả.
helpLink Uri Không Liên kết đến tài liệu. Các URL này có thể là liên kết đến tài liệu nội bộ hoặc tài nguyên sharepoint.
privacyPolicyLink Uri Không Liên kết đến tài liệu về quyền riêng tư. Chính sách về việc sử dụng cẩn thận cấu phần hoặc ứng dụng đang được gửi.
legalTermsLink Uri Không Liên kết đến tài liệu Điều khoản và Điều kiện. Bất kỳ điều khoản pháp lý hoặc hướng dẫn nội bộ nào để đánh giá người tiêu dùng của mục ca-ta-lô.
legalTerms chuỗi Không Markdown, HTML hoặc phiên bản văn bản của tài liệu Điều khoản và Điều kiện. Bất kỳ điều khoản pháp lý hoặc hướng dẫn nội bộ nào để đánh giá người tiêu dùng của mục ca-ta-lô.
sourceCodeRepositoryLink Uri Không Liên kết đến kho mã nguồn
engineeringName PersonContactInformation Có Thông tin liên hệ cho kỹ sư hoặc nhóm đã phát triển mục ca-ta-lô này.
supportName PersonContactInformation Không Thông tin liên hệ cho bộ phận hỗ trợ hoặc nhóm hỗ trợ mục ca-ta-lô này. Có thể giống như liên hệ kỹ thuật mà người tiêu dùng của mục ca-ta-lô có thể liên hệ nếu họ gặp sự cố với ứng dụng.

Danh mục doanh nghiệp

Đặt thuộc tính OfferDetailsbusinessCategories thành một hoặc nhiều danh mục kinh doanh sau:

Mã Sự miêu tả
526430000 Dịch vụ Khách hàng
526430001 Quản lý dự án
526430002 Quản lý Lịch & Lập lịch biểu
526430003 Quản lý Email
526430004 Tệp & Tài liệu
526430005 Thông báo & Nhắc nhở
526430006 Phân tích
526430007 Cộng tác
526430008 Thương mại
526430009 Tài chính
526430010 Tuân thủ & Pháp lý
526430011 Sales
526430012 Công cụ IT
526430013 Marketing
526430014 Hoạt động & Chuỗi cung ứng
526430015 Vật dụng kết nối Internet
526430016 AI Machine Learning
526430017 Vị trí địa lý
526430018 Nhân sự

Hiện tại, các thể loại kinh doanh mới không thể được cấu hình, nhưng chúng có thể được truy xuất từ lựa chọn toàn cầu Thể loại Kinh doanh Ca-ta-lô (mspcat_catalogbusinesscategory).

CatalogFileAsset

Các thuộc tính này xác định một tệp được tham chiếu trong CatalogItemDefinitionpackageFile và OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsvà thuộc screenshots tính.

Tài sản Kiểu Bắt buộc Sự miêu tả
name chuỗi Có Tên tệp.
filesaslink Uri Có Liên kết để tải xuống tệp. Nếu liên kết yêu cầu xác thực, hãy cung cấp URL chữ ký truy nhập dùng chung (SAS).

PersonContactInformation

Những thuộc tính này xác định những người trong mục ca-ta-lô OfferDetailsengineeringName và thuộc supportName tính.

Tài sản Kiểu Bắt buộc Sự miêu tả
firstName chuỗi Không Tên của người.
lastName chuỗi Có Tên gia đình của người.
email chuỗi Có Địa chỉ email của người.
phoneNumber chuỗi Không Số điện thoại của người.
  • Last updated on