कैटलॉग आइटम सबमिशन दस्तावेज़ संदर्भ

जब आप कैटलॉग में कोई आइटम सबमिट करते हैं तो आपको 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"
      }
  }
}

यह तालिका सबमिशन दस्तावेज़ के गुणों का वर्णन करती है:

गुण	Type	आवश्य	वर्णन
modelVersion	स्ट्रिंग	No	सबमिशन दस्तावेज़ की संस्करण संख्या। डिफ़ॉल्ट 1.0.0.0 है।
sourcePortal	int	No	इस अनुरोध के स्रोत की पहचान करता है. डिफ़ॉल्ट रूप से पीएसी 526430005 सीएलआई है। अन्य स्रोतों के लिए, .526430000 mspcat_GetPowerCatalogDetails फ़ंक्शन पूरी सूची लौटाता है। संपत्ति उपलब्ध विकल्पों को सूचीबद्ध करती है mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions ।
submissionId	गाइड	No	सबमिशन की पहचान करने के लिए गाइड। यह मान अनुरोध को अन्य प्रणालियों से जोड़ने की अनुमति देने के लिए एक विदेशी कुंजी है।
operation	स्ट्रिंग	हां	भविष्य के विस्तार के लिए और वर्तमान में इसका सम्मान नहीं किया जाता है। उपयोग किए जाने वाले ऑपरेशन का प्रकार। मान्य मान: - CreateOrUpdate (डिफ़ॉल्ट) - Create - Update - Disabled
businessJustification	स्ट्रिंग	No	अनुमोदक को सबमिशन के व्यावसायिक मूल्य का वर्णन करता है। इस मान में HTML या रिच टेक्स्ट फ़ॉर्मैट (RTF) हो सकता है. यह जानकारी निर्माता खोज उपयोगकर्ता अनुभव में नियोजित उपभोग अनुभव में दिखाई देती है। उदाहरण के लिए, उपयोगकर्ता कह सकते हैं कि उनका सबमिशन लागत में कमी या उत्पादकता में मदद करता है। कुछ संगठनों को मूल्य के कुछ वर्गों की आवश्यकता होती है और उन मूल्यों को यहां दर्ज किया जा सकता है।
publisherDetails	प्रकाशक	हां	इस आइटम सबमिशन से संबद्ध प्रकाशक.
catalogItemDefinition	CatalogItemDefinition	हां	सबमिट किए जा रहे कैटलॉग आइटम को परिभाषित करता है.

प्रकाशक

कैटलॉग सबमिशन आइटम publisherDetails गुण निर्दिष्ट करने के लिए इस डेटा का उपयोग करें.

एक प्रकाशक रिकॉर्ड बनाता है जिसे एक या अधिक 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"
      }
   ]
}

गुण	Type	आवश्य	वर्णन
publisherId	स्ट्रिंग	हां	इस प्रकाशक के लिए अनन्य आईडी. जब भी आप इस प्रकाशक के लिए कैटलॉग आइटम बना रहे हों या अपडेट कर रहे हों, तो इस प्रकाशक की पहचान करने के लिए इस ID का उपयोग करें. कैटलॉग आइटम्स को एक समय में केवल एक प्रकाशक से संबद्ध किया जा सकता है. मान एक GUID या स्ट्रिंग हो सकता है। एक बार सेट हो जाने के बाद, इसे बनाए रखा जाना चाहिए।
publisherDisplayName	स्ट्रिंग	हां	उपभोक्ताओं को यह डेटा कैटलॉग गैलरी में दिखाई देता है.
publisherUpnList	कैटलॉगयूपीएनपीरेशन []	No	वे लोग जो इस प्रकाशक के रूप में नए कैटलॉग आइटम्स सबमिट कर सकते हैं या कैटलॉग का अद्यतन कर सकते हैं. पहली बार Publisher बनाने पर सबमिट करने वाले उपयोगकर्ता को हमेशा शामिल किया जाता है.
publisherAADGroupOIDS	कैटलॉगग्रुपऑपरेशन[]	No	Entra ID समूह जिनके सदस्यों को इस प्रकाशक तक पहुँचने की अनुमति है.

कैटलॉगयूपीएनपीरेशन

PublisherpublisherUpnList गुण निर्दिष्ट करने के लिए इस डेटा का उपयोग करें.

उन लोगों को जोड़ने या निकालने के लिए एक कार्रवाई निर्धारित करता है जो इस प्रकाशक के रूप में नए कैटलॉग आइटम्स सबमिट कर सकते हैं या अद्यतन कर सकते हैं.

गुण	Type	आवश्य	वर्णन
action	स्ट्रिंग	हां	इस यूपीएन के साथ की जाने वाली कार्रवाई। मान्य मान: Add या .Remove
upn	स्ट्रिंग	हां	उपयोगकर्ता का उपयोगकर्ता प्रिंसिपल नाम (UPN)।
userOid	गाइड	हां	उपयोगकर्ता के लिए ऑब्जेक्ट पहचानकर्ता।

कैटलॉग ग्रुप ऑपरेशन

PublisherpublisherAADGroupOIDS गुण निर्दिष्ट करने के लिए इस डेटा का उपयोग करें.

किसी Entra ID समूह को जोड़ने या निकालने के लिए एक कार्रवाई निर्धारित करता है जो इस प्रकाशक तक पहुँच सकता है.

गुण	Type	आवश्य	वर्णन
action	स्ट्रिंग	हां	इस यूपीएन के साथ की जाने वाली कार्रवाई। मान्य मान: Add या .Remove
groupName	स्ट्रिंग	हां	समूह का नाम।
groupOid	गाइड	हां	समूह के लिए ऑब्जेक्ट पहचानकर्ता.
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"
   }
   }
}

गुण	Type	आवश्य	वर्णन
id	गाइड	हां	कैटलॉग आइटम की अनन्य आईडी. कैटलॉग आइटम को अपडेट या इंस्टॉल करते समय इस ID का उपयोग करें.
displayName	स्ट्रिंग	हां	कैटलॉग गैलरी में उपभोक्ताओं को दिखाया गया नाम.
description	स्ट्रिंग	No	कैटलॉग गैलरी में उपभोक्ताओं को दिखाया गया विवरण।
offer	प्रस्तावविवरण	हां	कैटलॉग आइटम सबमिशन का विवरण।
packageFile	CatalogFileAsset	हां	वर्णन करता है कि सबमिशन के लिए कैटलॉग पैकेज फ़ाइल कहाँ प्राप्त करें।

प्रस्तावविवरण

CatalogItemDefinitionoffer गुण निर्दिष्ट करने के लिए इस डेटा का उपयोग करें.

ये गुण कैटलॉग आइटम सबमिशन के विवरण को परिभाषित करते हैं।

गुण	Type	आवश्य	वर्णन
businessCategories	इंट []	No	लक्ष्य कैटलॉग द्वारा सम्मानित पसंद विकल्प मानों की सूची। इस कैटलॉग आइटम के साथ संबद्ध करने के लिए व्यावसायिक श्रेणियों की पहचान करता है. उपयोग करने के लिए मान्य मानों के लिए व्यावसायिक श्रेणियाँ देखें.
type	स्ट्रिंग	हां	कैटलॉग आइटम का प्रकार. मान्य मान: - Application - Component_Collection
supportsApplicationTypes	स्ट्रिंग[]	No	समर्थित अनुप्रयोग प्रकारों की सूची. मान्य मान: - CanvasApps - ModelApps - PowerPortals - PowerAutomate
deploymentType	स्ट्रिंग	हां	इस कैटलॉग आइटम को परिनियोजित करने के लिए परिनियोजन के प्रकार को इंगित करता है। मान्य मान: - Normal एक प्रबंधित आइटम का प्रतिनिधित्व करता है। - Template आपके अप्रबंधित समाधान की एक प्रतिलिपि जिसे अन्य निर्माता अपनी पसंद के अनुसार संपादित कर सकते हैं. कैटलॉग आइटम प्रकारों के बारे में अधिक जानें
searchKeywords	स्ट्रिंग[]	No	वे शब्द जिनका उपयोग लोग इस कैटलॉग आइटम को खोजने के लिए कर सकते हैं.
small48x48Image	CatalogFileAsset	No	गैलरी दृश्य के लिए छवि। यदि आप यह छवि प्रदान नहीं करते हैं, तो एक सिस्टम डिफ़ॉल्ट आइकन का उपयोग किया जाता है।
large216x216Image	CatalogFileAsset	No	विस्तार से देखने के लिए छवि. निर्माता या अन्य खोज UI में प्रदर्शित होने के लिए एक आइकन प्रदान करें। कुछ उपयोगकर्ता अनुभव खोज के लिए कार्ड प्रस्तुत करने के लिए बड़े आइकन का उपयोग करते हैं।
useCaseDocument	CatalogFileAsset	No	अनुमोदकों के लिए मामले के विवरण और स्पष्टीकरण का उपयोग करें।
videos	कैटलॉगफाइलएसेट[]	No	विवरण दृश्य इन वीडियो/जीआईएफ फ़ाइलों के लिंक प्रदर्शित करता है।
documents	कैटलॉगफाइलएसेट[]	No	विवरण दृश्य इन फ़ाइलों के लिए लिंक्स प्रदर्शित करता है।
screenshots	कैटलॉगफाइलएसेट[]	No	विवरण दृश्य इन छवियों को प्रदर्शित करता है। आप निर्माताओं को यह पहचानने में मदद करने के लिए अपने एप्लिकेशन के स्क्रीनशॉट यहां पास कर सकते हैं कि यह ऐप वह कार्यक्षमता या क्षमता प्रदान करता है जिसकी वे तलाश कर रहे हैं। किसी ऐप या टेम्पलेट को डाउनलोड करने से पहले लोग जो सबसे आम काम करते हैं, वह है विवरण पढ़ने के बजाय क्षमताओं को समझने के लिए उसकी छवियों और स्क्रीनशॉट को देखें।
helpLink	उरी	No	दस्तावेज़ीकरण के लिए लिंक। ये URL आंतरिक दस्तावेज़ों या SharePoint संसाधनों के लिंक हो सकते हैं.
privacyPolicyLink	उरी	No	गोपनीयता दस्तावेज़ से लिंक करें। प्रस्तुत किए जा रहे घटक या अनुप्रयोग के सावधानीपूर्वक उपयोग के संबंध में नीतियां।
legalTermsLink	उरी	No	नियम और शर्तें दस्तावेज़ से लिंक करें। कैटलॉग आइटम के उपभोक्ता के मूल्यांकन के लिए कोई कानूनी शर्तें या आंतरिक मार्गदर्शन।
legalTerms	स्ट्रिंग	No	नियम और शर्तें दस्तावेज़ का मार्कडाउन, HTML या टेक्स्ट संस्करण. कैटलॉग आइटम के उपभोक्ता के मूल्यांकन के लिए कोई कानूनी शर्तें या आंतरिक मार्गदर्शन।
sourceCodeRepositoryLink	उरी	No	स्रोत कोड रिपॉजिटरी से लिंक करें
engineeringName	व्यक्तिसंपर्कजानकारी	हां	इस कैटलॉग आइटम को विकसित करने वाले इंजीनियर या समूह के लिए संपर्क जानकारी.
supportName	व्यक्तिसंपर्कजानकारी	No	समर्थन या समूह के लिए संपर्क जानकारी जो इस कैटलॉग आइटम का समर्थन करता है. इंजीनियरिंग संपर्क के समान हो सकता है कि कैटलॉग आइटम का उपभोक्ता उस तक पहुंच सकता है यदि वे एप्लिकेशन के साथ समस्याओं का सामना करते हैं।

व्यापार श्रेणियां

OfferDetailsbusinessCategories गुण को इनमें से एक या अधिक व्यावसायिक श्रेणियों पर सेट करें:

कोड	वर्णन
526430000	ग्राहक सेवा
526430001	परियोजना प्रबंधन
526430002	कैलेंडर प्रबंधन और समय-निर्धारण
526430003	ईमेल प्रबंधन
526430004	फाइलें और दस्तावेज
526430005	अधिसूचना और अनुस्मारक
526430006	विश्लेषण
526430007	सहयोग
526430008	वाणिज्य
526430009	वित्त
526430010	अनुपालन और कानूनी
526430011	Sales
526430012	आईटी उपकरण
526430013	Marketing
526430014	संचालन और आपूर्ति श्रृंखला
526430015	इंटरनेट ऑफ़ थिंग्स
526430016	एआई मशीन लर्निंग
526430017	जियोलोकेशन
526430018	मानव संसाधन

वर्तमान में, नई व्यावसायिक श्रेणियाँ कॉन्फ़िगर नहीं की जा सकती हैं, लेकिन उन्हें कैटलॉग व्यवसाय श्रेणी ()mspcat_catalogbusinesscategory वैश्विक विकल्प से पुनर्प्राप्त किया जा सकता है.

CatalogFileAsset

ये गुण CatalogItemDefinitionpackageFile और OfferDetailssmall48x48Image, large216x216Image, , useCaseDocumentvideosdocuments, और गुणों screenshots में संदर्भित फ़ाइल को परिभाषित करते हैं।

गुण	Type	आवश्य	वर्णन
name	स्ट्रिंग	हां	फ़ाइल का नाम.
filesaslink	उरी	हां	फ़ाइल डाउनलोड करने के लिए लिंक. यदि लिंक को प्रमाणीकरण की आवश्यकता है, तो एक साझा पहुँच हस्ताक्षर (SAS) URL प्रदान करें.

व्यक्तिसंपर्कजानकारी

ये गुण कैटलॉग आइटम में लोगों को परिभाषित करते हैं OfferविवरणengineeringName और supportName गुण.

गुण	Type	आवश्य	वर्णन
firstName	स्ट्रिंग	No	व्यक्ति का पहला नाम।
lastName	स्ट्रिंग	हां	व्यक्ति परिवार का नाम.
email	स्ट्रिंग	हां	व्यक्ति का ईमेल पता.
phoneNumber	स्ट्रिंग	No	व्यक्ति का फ़ोन नंबर।