การอ้างอิงเอกสารการส่งรายการแค็ตตาล็อก

คุณต้องรวมข้อมูลในรูปแบบ 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"
      }
  }
}

ตารางนี้จะอธิบายเกี่ยวกับคุณสมบัติสําหรับเอกสารการส่ง:

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
modelVersion	สตริง	ไม่ใช่	หมายเลขรุ่นของเอกสารการส่ง ค่าเริ่มต้นคือ 1.0.0.0
sourcePortal	int	ไม่ใช่	ระบุแหล่งที่มาของคําขอนี้ ค่าเริ่มต้น 526430005 คือ PAC CLI สําหรับแหล่งข้อมูลอื่น ให้ใช้526430000 ฟังก์ชัน mspcat_GetPowerCatalogDetails จะส่งกลับรายการทั้งหมด คุณสมบัติ mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions จะแสดงรายการตัวเลือกที่พร้อมใช้งาน
submissionId	guid	ไม่ใช่	Guid เพื่อระบุการส่ง ค่านี้เป็น Foreign Key ที่อนุญาตให้เชื่อมโยงคําขอกับระบบอื่น
operation	สตริง	ใช่	สําหรับการขยายในอนาคตและยังไม่ได้ปฏิบัติตามในขณะนี้ ชนิดของการดําเนินงานที่จะใช้ ค่าที่ถูกต้อง: - CreateOrUpdate (ค่าเริ่มต้น) - Create - Update - Disabled
businessJustification	สตริง	ไม่ใช่	อธิบายค่าทางธุรกิจของการส่งให้กับผู้อนุมัติ ค่านี้สามารถประกอบด้วย HTML หรือ Rich Text Format (RTF) ข้อมูลนี้ปรากฏในประสบการณ์การใช้งานที่วางแผนไว้ในประสบการณ์ของผู้ใช้ในการค้นหาผู้สร้าง ตัวอย่างเช่น ผู้ใช้อาจกล่าวว่าการส่งของพวกเขาจะช่วยในการลดต้นทุนหรือประสิทธิภาพการทํางาน บางองค์กรจําเป็นต้องมีบางระดับชั้นของค่าและค่าเหล่านั้นสามารถป้อนได้ที่นี่
publisherDetails	ผู้เผยแพร่	ใช่	ผู้เผยแพร่ที่เกี่ยวข้องกับการส่งรายการนี้
catalogItemDefinition	CatalogItemDefinition	ใช่	กําหนดรายการแค็ตตาล็อกที่กําลังส่ง

ผู้เผยแพร่

ใช้ข้อมูลนี้เพื่อระบุคุณสมบัติรายการ publisherDetails การส่งแค็ตตาล็อก

สร้างระเบียนผู้เผยแพร่ที่สามารถเชื่อมโยงกับกลุ่ม Microsoft Entra ID อย่างน้อยหนึ่งกลุ่มที่มีผู้ใช้ที่ได้รับอนุญาตซึ่งสามารถทําการอัปเดตรายการแค็ตตาล็อกนับไปข้างหน้า

Note

อย่าสับสนคําศัพท์นี้กับผู้เผยแพร่โซลูชัน ตัวเผยแพร่รายการแค็ตตาล็อกไม่ได้ใช้กับโซลูชัน

คุณต้องระบุ publisherDisplayName อย่างน้อย publisherId อาจเป็นค่าสตริงใด ๆ ระบบจะตรวจสอบว่ามีผู้เผยแพร่นั้นอยู่หรือไม่ ให้สร้างและกําหนดpublisherId

ตัวอย่างเช่น ทีมไอทีของนักพัฒนาสามารถสร้างผู้เผยแพร่และ ID ที่นักพัฒนาใช้กลุ่ม Microsoft Entra ID ได้

นี่คือตัวอย่างของบันทึกผู้เผยแพร่ที่มีการดําเนินการเพื่อเพิ่มบุคคลและกลุ่ม 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"
      }
   ]
}

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
publisherId	สตริง	ใช่	ID เฉพาะสําหรับผู้เผยแพร่นี้ ใช้ ID นี้เพื่อระบุผู้เผยแพร่นี้ทุกครั้งที่คุณกําลังสร้างหรืออัปเดตรายการแค็ตตาล็อกสําหรับผู้เผยแพร่นี้ รายการแค็ตตาล็อกสามารถเชื่อมโยงกับผู้เผยแพร่เดียวเท่านั้นในแต่ละครั้ง ค่าสามารถเป็น GUID หรือสตริงได้ เมื่อตั้งค่าแล้ว จะต้องได้รับการเก็บรักษาไว้
publisherDisplayName	สตริง	ใช่	ลูกค้าจะเห็นข้อมูลนี้ในแกลเลอรีแค็ตตาล็อก
publisherUpnList	CatalogUPNOperation []	ไม่ใช่	บุคคลที่สามารถส่งใหม่หรืออัปเดตรายการแค็ตตาล็อกในฐานะผู้เผยแพร่นี้ได้ รวมผู้ใช้ที่ส่งเมื่อสร้างผู้เผยแพร่ครั้งแรกเสมอ
publisherAADGroupOIDS	CatalogGroupOperation[]	ไม่ใช่	กลุ่ม ID รายการที่มีสมาชิกที่ได้รับอนุญาตให้เข้าถึงผู้เผยแพร่นี้

CatalogUPNOperation

ใช้ข้อมูลนี้เพื่อระบุคุณสมบัติ PublisherpublisherUpnList

กําหนดการดําเนินการเพื่อเพิ่มหรือลบบุคคลที่สามารถส่งรายการแค็ตตาล็อกใหม่หรืออัปเดตรายการแค็ตตาล็อกในฐานะผู้เผยแพร่นี้

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
action	สตริง	ใช่	การดําเนินการที่จะใช้กับ UPN นี้ ค่าที่ถูกต้อง: Add หรือRemove
upn	สตริง	ใช่	ชื่อผู้ใช้หลัก (UPN) ของผู้ใช้
userOid	guid	ใช่	ตัวระบุวัตถุสําหรับผู้ใช้

CatalogGroupOperation

ใช้ข้อมูลนี้เพื่อระบุคุณสมบัติ PublisherpublisherAADGroupOIDS

กําหนดการดําเนินการเพื่อเพิ่มหรือลบกลุ่ม ID รายการข้อมูลที่สามารถเข้าถึงผู้เผยแพร่นี้ได้

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
action	สตริง	ใช่	การดําเนินการที่จะใช้กับ UPN นี้ ค่าที่ถูกต้อง: Add หรือRemove
groupName	สตริง	ใช่	ชื่อของกลุ่ม
groupOid	guid	ใช่	ตัวระบุวัตถุสําหรับกลุ่ม
groupType	สตริง	ใช่	ชนิดของกลุ่มที่กําลังได้รับการแก้ไข ค่าที่ถูกต้องคือ Security และModern

CatalogItemDefinition

ใช้ข้อมูลนี้เพื่อระบุคุณสมบัติรายการ 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"
   }
   }
}

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
id	guid	ใช่	ID เฉพาะของสินค้าในแค็ตตาล็อก ใช้ ID นี้เมื่อปรับปรุงหรือติดตั้งรายการแค็ตตาล็อก
displayName	สตริง	ใช่	ชื่อที่แสดงให้ผู้บริโภคในแกลเลอรีแค็ตตาล็อก
description	สตริง	ไม่ใช่	คําอธิบายที่แสดงให้กับผู้บริโภคในแกลเลอรีแค็ตตาล็อก
offer	OfferDetails	ใช่	รายละเอียดของการส่งรายการแค็ตตาล็อก
packageFile	CatalogFileAsset	ใช่	อธิบายตําแหน่งที่จะรับไฟล์แพคเกจแค็ตตาล็อกสําหรับการส่ง

OfferDetails

ใช้ข้อมูลนี้เพื่อระบุคุณสมบัติ CatalogItemDefinitionoffer

คุณสมบัติเหล่านี้กําหนดรายละเอียดของการส่งรายการแค็ตตาล็อก

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
businessCategories	int[]	ไม่ใช่	รายการค่าตัวเลือกที่ยึดตามแค็ตตาล็อกเป้าหมาย ระบุประเภทธุรกิจที่สัมพันธ์กับสินค้าแค็ตตาล็อกนี้ ดู ที่ ประเภทธุรกิจ สําหรับค่าที่ถูกต้องที่จะใช้
type	สตริง	ใช่	ชนิดของสินค้าในแค็ตตาล็อก ค่าที่ถูกต้อง: - Application - Component_Collection
supportsApplicationTypes	string[]	ไม่ใช่	รายการของชนิดแอปพลิเคชันที่ได้รับการสนับสนุน ค่าที่ถูกต้อง: - CanvasApps - ModelApps - PowerPortals - PowerAutomate
deploymentType	สตริง	ใช่	ระบุชนิดของการปรับใช้เพื่อปรับใช้รายการแค็ตตาล็อกนี้ ค่าที่ถูกต้อง: - Normalแสดงรายการที่มีการจัดการ - Template สําเนาของโซลูชันที่ไม่มีการจัดการของคุณที่ผู้สร้างรายอื่นสามารถแก้ไขตามที่พวกเขาเลือก เรียนรู้เพิ่มเติมเกี่ยวกับชนิดสินค้าในแค็ตตาล็อก
searchKeywords	string[]	ไม่ใช่	คําที่ผู้คนอาจใช้ในการค้นหารายการแค็ตตาล็อกนี้
small48x48Image	CatalogFileAsset	ไม่ใช่	รูปภาพสําหรับมุมมองแกลเลอรี ถ้าคุณไม่ระบุรูปภาพนี้ ระบบจะใช้ไอคอนค่าเริ่มต้นของระบบ
large216x216Image	CatalogFileAsset	ไม่ใช่	รูปภาพสําหรับมุมมองรายละเอียด มีไอคอนที่จะแสดงในตัวสร้างหรือ UI การค้นพบอื่นๆ ประสบการณ์ของผู้ใช้บางอย่างใช้ไอคอนขนาดใหญ่เพื่อแสดงการ์ดสําหรับการค้นพบ
useCaseDocument	CatalogFileAsset	ไม่ใช่	ใช้คําอธิบายกรณีและคําอธิบายถึงผู้อนุมัติ
videos	CatalogFileAsset[]	ไม่ใช่	มุมมองรายละเอียดจะแสดงลิงก์ไปยังไฟล์วิดีโอ/gif เหล่านี้
documents	CatalogFileAsset[]	ไม่ใช่	มุมมองรายละเอียดจะแสดงลิงก์ไปยังไฟล์เหล่านี้
screenshots	CatalogFileAsset[]	ไม่ใช่	มุมมองรายละเอียดจะแสดงรูปภาพเหล่านี้ คุณสามารถส่งสกรีนช็อตของแอปพลิเคชันของคุณที่นี่เพื่อช่วยผู้สร้างระบุว่าแอปนี้มีฟังก์ชันการทํางานหรือความสามารถที่พวกเขากําลังมองหาอยู่หรือไม่ สิ่งที่ผู้คนทําบ่อยที่สุดก่อนที่จะดาวน์โหลดแอปหรือเทมเพลตจะดูรูปภาพและภาพหน้าจอเพื่อทําความเข้าใจความสามารถแทนที่จะอ่านคําอธิบาย
helpLink	uri	ไม่ใช่	ลิงก์ไปยังเอกสารประกอบ URL เหล่านี้สามารถเชื่อมโยงไปยังเอกสารภายในหรือแหล่งข้อมูล Sharepoint ได้
privacyPolicyLink	uri	ไม่ใช่	ลิงก์ไปยังเอกสารความเป็นส่วนตัว นโยบายเกี่ยวกับการใช้คอมโพเนนต์หรือแอปพลิเคชันที่ส่งอย่างรอบคอบ
legalTermsLink	uri	ไม่ใช่	ลิงก์ไปยังเอกสารข้อตกลงและเงื่อนไข ข้อกําหนดทางกฎหมายหรือคําแนะนําภายในใด ๆ สําหรับการประเมินผู้บริโภคของรายการแค็ตตาล็อก
legalTerms	สตริง	ไม่ใช่	เอกสาร Markdown, HTML หรือข้อความของข้อกําหนดและเงื่อนไข ข้อกําหนดทางกฎหมายหรือคําแนะนําภายในใด ๆ สําหรับการประเมินผู้บริโภคของรายการแค็ตตาล็อก
sourceCodeRepositoryLink	uri	ไม่ใช่	ลิงก์ไปยังที่เก็บโค้ดต้นทาง
engineeringName	PersonContactInformation	ใช่	ข้อมูลการติดต่อสําหรับวิศวกรหรือกลุ่มที่พัฒนาสินค้าแค็ตตาล็อกนี้
supportName	PersonContactInformation	ไม่ใช่	ข้อมูลที่ติดต่อสําหรับการสนับสนุนหรือกลุ่มที่สนับสนุนรายการแค็ตตาล็อกนี้ อาจเหมือนกับผู้ติดต่อทางวิศวกรรมที่ผู้บริโภครายการแค็ตตาล็อกสามารถเข้าถึงได้หากพวกเขาประสบปัญหากับแอปพลิเคชัน

ประเภทธุรกิจ

ตั้งค่าคุณสมบัติ OfferDetailsbusinessCategories เป็นหมวดหมู่ธุรกิจเหล่านี้อย่างน้อยหนึ่งหมวดหมู่:

โค้ด	คำอธิบาย
526430000	ส่วนบริการลูกค้า
526430001	การจัดการโครงการ
526430002	การจัดการปฏิทิน & การจัดกําหนดการ
526430003	การจัดการอีเมล
526430004	แฟ้มและเอกสารประกอบ
526430005	การแจ้งเตือนและเตือนความจํา
526430006	การวิเคราะห์
526430007	การทำงานร่วมกัน
526430008	Commerce
526430009	การเงิน
526430010	การปฏิบัติตามกฎระเบียบและกฎหมาย
526430011	Sales
526430012	เครื่องมือ IT
526430013	Marketing
526430014	การปฏิบัติงานและห่วงโซ่อุปทาน
526430015	อินเทอร์เน็ตในทุกสิ่ง
526430016	การเรียนรู้ของเครื่อง AI
526430017	ตําแหน่งที่ตั้งทางภูมิศาสตร์
526430018	ทรัพยากรบุคคล

ในปัจจุบัน ประเภทธุรกิจใหม่ไม่สามารถกําหนดค่าได้ แต่สามารถเรียกใช้ได้จากตัวเลือกส่วนกลางประเภทธุรกิจแค็ตตาล็อก (mspcat_catalogbusinesscategory)

CatalogFileAsset

คุณสมบัติเหล่านี้กําหนดไฟล์ที่อ้างอิงในคุณสมบัติ CatalogItemDefinitionpackageFile และ OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsและscreenshots

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
name	สตริง	ใช่	ชื่อของไฟล์
filesaslink	uri	ใช่	ลิงก์เพื่อดาวน์โหลดไฟล์ ถ้าลิงก์จําเป็นต้องรับรองความถูกต้อง ใส่ URL ลายเซ็นการเข้าถึงที่ใช้ร่วมกัน (SAS)

PersonContactInformation

คุณสมบัติเหล่านี้กําหนดบุคคลในรายการแค็ตตาล็อก OfferDetailsengineeringName และ supportName คุณสมบัติ

ทรัพย์สิน	ประเภท	ต้องมี	คำอธิบาย
firstName	สตริง	ไม่ใช่	ชื่อบุคคล
lastName	สตริง	ใช่	ชื่อครอบครัวของบุคคล
email	สตริง	ใช่	ที่อยู่อีเมลของบุคคล
phoneNumber	สตริง	ไม่ใช่	หมายเลขโทรศัพท์ของบุคคล