مرجع مستند إرسال عنصر الكتالوج

يجب تضمين البيانات بتنسيق 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`	الباحث	لا	يحدد مصدر هذا الطلب. الإعدادات الافتراضية `526430005` التي هي PAC CLI. بالنسبة للمصادر الأخرى، استخدم `526430000`. ترجع `mspcat_GetPowerCatalogDetails` الدالة القائمة الكاملة. تسرد `mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions` الخاصية الخيارات المتوفرة.
`submissionId`	guid	لا	Guid لتحديد الإرسال. هذه القيمة هي مفتاح خارجي للسماح بربط الطلب بالأنظمة الأخرى.
`operation`	خيط	نعم	للتوسع في المستقبل ولا يتم احترامه حاليا. نوع العملية التي سيتم استخدامها. قيم صالحة: - `CreateOrUpdate` (افتراضي) - `Create` - `Update` - `Disabled`
`businessJustification`	خيط	لا	توضح هذه المقالة قيمة الأعمال الخاصة بالتقديم إلى الموافق. يمكن أن تحتوي هذه القيمة على HTML أو Rich Text Format (RTF). تظهر هذه المعلومات في تجربة الاستهلاك المخطط لها في تجربة مستخدم اكتشاف صانع. قد يقول المستخدمون إن إرسالهم يساعد في تقليل التكلفة أو الإنتاجية، على سبيل المثال. تتطلب بعض المؤسسات فئات معينة من القيمة ويمكن إدخال هذه القيم هنا.
`publisherDetails`	ناشر	نعم	الناشر المقترن بإرسال العنصر هذا.
`catalogItemDefinition`	تعريف CatalogItemDefinition	نعم	تعريف عنصر الكتالوج الذي يتم إرساله.

Publisher

استخدم هذه البيانات لتحديد خاصية عنصر publisherDetails إرسال الكتالوج.

إنشاء سجل ناشر يمكن إقرانه بمجموعة معرف Microsoft Entra واحدة أو أكثر تحتوي على مستخدمين معتمدين يمكنهم إجراء تحديثات لعنصر الكتالوج من الآن فصاعدا.

إشعار

لا تخلط بين هذا المصطلح و "ناشر الحلول". لا يتم استخدام ناشر عنصر الكتالوج مع الحلول.

تحتاج إلى توفير publisherDisplayName كحد أدنى. publisherId يمكن أن تكون أي قيمة سلسلة. يتحقق النظام من وجود هذا الناشر، وإلا يقوم بإنشائه وتعيين publisherId.

على سبيل المثال، يمكن لفريق تكنولوجيا المعلومات في الموارد البشرية من المطورين إنشاء ناشر ومعرف للمطورين باستخدام مجموعة معرف Microsoft 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"
      }
   ]
}

الخاصية	نوع	المطلوب	الوصف
`publisherId`	خيط	نعم	المعرف الفريد لهذا الناشر. استخدم هذا المعرف لتعريف هذا الناشر في أي وقت تقوم فيه بإنشاء عنصر كتالوج لهذا الناشر أو تحديثه. يمكن ربط عناصر الكتالوج بناشر واحد فقط في كل مرة. يمكن أن تكون القيمة GUID أو سلسلة. بمجرد التعيين، يجب الحفاظ عليه.
`publisherDisplayName`	خيط	نعم	يرى المستهلكون هذه البيانات في معرض الكتالوج.
`publisherUpnList`	CatalogUPNOperation[]	لا	الأشخاص الذين يمكنهم إرسال عناصر كتالوج جديدة أو تحديثها كناشر. يتضمن دائما المستخدم المرسل في المرة الأولى التي يتم فيها إنشاء Publisher.
`publisherAADGroupOIDS`	CatalogGroupOperation[]	لا	مجموعات معرفات الإدخال التي يسمح لأعضائها بالوصول إلى هذا الناشر.

CatalogUPNOperation

استخدم هذه البيانات لتحديد خاصية PublisherpublisherUpnList .

تعريف عملية لإضافة أو إزالة الأشخاص الذين يمكنهم إرسال عناصر كتالوج جديدة أو تحديثها كناشر.

الخاصية	نوع	المطلوب	الوصف
`action`	خيط	نعم	الإجراء الذي يجب اتخاذه باستخدام UPN هذا. القيم الصالحة: `Add` أو `Remove`.
`upn`	خيط	نعم	اسم المستخدم الأساسي (UPN) للمستخدم.
`userOid`	guid	نعم	معرف الكائن للمستخدم.

CatalogGroupOperation

استخدم هذه البيانات لتحديد خاصية PublisherpublisherAADGroupOIDS .

تعريف عملية لإضافة مجموعة معرفات إدخالات يمكنها الوصول إلى هذا الناشر أو إزالتها.

الخاصية	نوع	المطلوب	الوصف
`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	نعم	المعرف الفريد لعنصر الكتالوج. استخدم هذا المعرف عند تحديث عنصر الكتالوج أو تثبيته.
`displayName`	خيط	نعم	الاسم المعروض للمستهلكين في معارض الكتالوج.
`description`	خيط	لا	الوصف المعروض للمستهلكين في معارض الكتالوج.
`offer`	تفاصيل العرض	نعم	تفاصيل إرسال عنصر الكتالوج.
`packageFile`	CatalogFileAsset	نعم	توضح هذه المقالة مكان الحصول على ملف حزمة الكتالوج للإرسال.

تفاصيل العرض

استخدم هذه البيانات لتحديد الخاصية CatalogItemDefinitionoffer .

تحدد هذه الخصائص تفاصيل إرسال عنصر الكتالوج.

الخاصية	نوع	المطلوب	الوصف
`businessCategories`	int[]	لا	قيم خيارات قائمة الاختيار التي يحترمها الكتالوج الهدف. تعريف فئات الأعمال المراد إقرانها بعنصر الكتالوج هذا. راجع فئات الأعمال للحصول على القيم الصالحة لاستخدامها.
`type`	خيط	نعم	نوع عنصر الكتالوج. قيم صالحة: - `Application` - `Component_Collection`
`supportsApplicationTypes`	سلسلة[]	لا	قائمة أنواع التطبيقات المدعومة. قيم صالحة: - `CanvasApps` - `ModelApps` - `PowerPortals` - `PowerAutomate`
`deploymentType`	خيط	نعم	يشير إلى نوع النشر لنشر عنصر الكتالوج هذا. قيم صالحة: - `Normal` يمثل عنصرا مدارا. - `Template` نسخة من الحل غير المدار الذي يمكن لصانعي آخرين تحريره كيفما يختارون. تعرف على المزيد حول أنواع عناصر الكتالوج
`searchKeywords`	سلسلة[]	لا	الكلمات التي قد يستخدمها الأشخاص للعثور على عنصر الكتالوج هذا.
`small48x48Image`	CatalogFileAsset	لا	صورة لعرض المعرض. إذا لم توفر هذه الصورة، يتم استخدام أيقونة افتراضية للنظام.
`large216x216Image`	CatalogFileAsset	لا	صورة لعرض التفاصيل. قم بتوفير أيقونة ليتم عرضها في صانع أو واجهة مستخدم اكتشاف أخرى. تستخدم بعض تجارب المستخدم أيقونات أكبر لعرض البطاقات للاكتشاف.
`useCaseDocument`	CatalogFileAsset	لا	استخدم وصف الحالة وتفسيرها للموافقين.
`videos`	CatalogFileAsset[]	لا	تعرض طريقة عرض التفاصيل الارتباطات إلى ملفات الفيديو/gif هذه.
`documents`	CatalogFileAsset[]	لا	تعرض طريقة عرض التفاصيل ارتباطات إلى هذه الملفات.
`screenshots`	CatalogFileAsset[]	لا	تعرض طريقة عرض التفاصيل هذه الصور. يمكنك تمرير لقطات الشاشة هنا لتطبيقك لمساعدة صانعي التطبيق على تحديد ما إذا كان هذا التطبيق يوفر الوظائف أو الإمكانية التي يبحثون عنها. الشيء الأكثر شيوعا الذي يفعله الأشخاص قبل تنزيل تطبيق أو قالب هو إلقاء نظرة على صوره ولقطات الشاشة لفهم القدرات بدلا من قراءة الوصف.
`helpLink`	uri	لا	ارتباط إلى الوثائق. يمكن أن تكون عناوين URL هذه ارتباطات إلى مستندات داخلية أو موارد sharepoint.
`privacyPolicyLink`	uri	لا	ارتباط إلى مستند الخصوصية. النهج المتعلقة باستخدام دقيق للمكون أو التطبيق الذي يتم إرساله.
`legalTermsLink`	uri	لا	ارتباط إلى مستند الشروط والأحكام. أي شروط قانونية أو إرشادات داخلية لتقييم مستهلك عنصر الكتالوج.
`legalTerms`	خيط	لا	Markdown أو HTML أو إصدار نصي من مستند الشروط والأحكام. أي شروط قانونية أو إرشادات داخلية لتقييم مستهلك عنصر الكتالوج.
`sourceCodeRepositoryLink`	uri	لا	الارتباط بمستودع التعليمات البرمجية المصدر
`engineeringName`	معلومات PersonContact	نعم	معلومات الاتصال للمهندس أو المجموعة التي طورت عنصر الكتالوج هذا.
`supportName`	معلومات PersonContact	لا	معلومات الاتصال للحصول على الدعم أو المجموعة التي تدعم عنصر الكتالوج هذا. يمكن أن يكون نفس جهة الاتصال الهندسية التي يمكن لمستهلك عنصر الكتالوج الوصول إليها إذا واجه مشكلات في التطبيق.

فئات الأعمال

قم بتعيين الخاصية OfferDetailsbusinessCategories إلى فئة واحدة أو أكثر من فئات الأعمال هذه:

Code	الوصف
`526430000`	خدمة العملاء
`526430001`	إدارة المشروع
`526430002`	إدارة التقويم والجدولة
`526430003`	إدارة البريد الإلكتروني
`526430004`	الملفات والوثائق
`526430005`	الإعلام والتذكيرات
`526430006`	التحليلات
`526430007`	التعاون‬
`526430008`	التجارة
`526430009`	Finance
`526430010`	الامتثال القانوني
`526430011`	Sales
`526430012`	أدوات تكنولوجيا المعلومات
`526430013`	تسويق
`526430014`	العمليات وسلسلة التوريد
`526430015`	إنترنت الأشياء
`526430016`	الذكاء الاصطناعي التعلم الآلي
`526430017`	الموقع الجغرافي
`526430018`	الموارد البشرية

حاليا، لا يمكن تكوين فئات الأعمال الجديدة، ولكن يمكن استردادها من الخيار العمومي لفئة أعمال الكتالوج (mspcat_catalogbusinesscategory).

CatalogFileAsset

تعرف هذه الخصائص ملفا مشار إليه في CatalogItemDefinitionpackageFile وخصائص OfferDetailssmall48x48Image و large216x216ImageuseCaseDocumentvideosdocumentsو.screenshots

الخاصية	نوع	المطلوب	الوصف
`name`	خيط	نعم	اسم الملف.
`filesaslink`	uri	نعم	ارتباط لتنزيل الملف. إذا كان الارتباط يتطلب مصادقة، فوفر عنوان URL لتوقيع الوصول المشترك (SAS).

معلومات PersonContact

تعرف هذه الخصائص الأشخاص في عنصر الكتالوج OfferDetailsengineeringName والخصائص supportName .

الخاصية	نوع	المطلوب	الوصف
`firstName`	خيط	لا	الاسم الأول للشخص.
`lastName`	خيط	نعم	اسم عائلة الشخص.
`email`	خيط	نعم	عنوان البريد الإلكتروني للشخص.
`phoneNumber`	خيط	لا	رقم هاتف الشخص.

الملاحظات

هل كانت هذه الصفحة مفيدة؟

Last updated on 2025-10-03