הפניה למסמך לשליחה של פריט קטלוג

עליך לכלול נתונים בתבנית 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	מחרוזת	כן	מספר גירסה של מסמך השליחה. ברירת המחדל היא 1.0.0.0.
sourcePortal	int	כן	מזהה את המקור של בקשה זו. ברירות מחדל 526430005 שעבורן מוגדר ה- PAC CLI. עבור מקורות אחרים, השתמש ב- 526430000. הפונקציה mspcat_GetPowerCatalogDetails מחזירה את הרשימה המלאה. המאפיין mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions מפרט את האפשרויות הזמינות.
submissionId	guid	כן	GUID לזיהוי ההגשה. ערך זה הוא מפתח זר המאפשר לקשר את הבקשה למערכות אחרות.
operation	מחרוזת	כן	להרחבה עתידית ולא יתחשבו בשלב זה. סוג הפעולה שבה יש להשתמש. ערכים חוקיים: - CreateOrUpdate (ברירת מחדל) - Create - Update - Disabled
businessJustification	מחרוזת	כן	מתאר את הערך העסקי של ההגשה למאשר. ערך זה יכול להכיל HTML או תבנית טקסט עשיר (RTF). מידע זה מופיע בחוויה המתוכננת של הצריכה בגילוי חוויית המשתמש של היוצר. המשתמשים עשויים לומר שהשליחה שלהם מסייעת בהפחתת עלות או בפרודוקטיביות, לדוגמה. ארגונים מסוימים דורשים מחלקות ערך מסוימות ובאפשרותך להזין כאן ערכים אלה.
publisherDetails	מוציא לאור	כן	המפרסם המשויך לשליחת פריט זה.
catalogItemDefinition	פריט קטלוג - הגדרה	כן	מגדיר את פריט הקטלוג שנשלח.

מפרסם

השתמש בנתונים אלה כדי לציין את מאפיין פריט שליחת הקטלוג publisherDetails .

יצירת רשומת מפרסם שניתן לשייך לקבוצות מזהה Microsoft Entra אחת או יותר המכילה משתמשים מורשים שיכולים לבצע עדכונים בפריט הקטלוג מעתה והלאה.

הערה

אל תבלבל מונח זה עם Solution Publisher. לא נעשה שימוש ב- Publisher של פריט קטלוג עם פתרונות.

עליך לספק את המינימום publisherDisplayName . publisherId יכול להיות כל ערך מחרוזת. המערכת בודקת אם מפרסם זה קיים, אחרת יוצרת אותו ומקצה .publisherId

לדוגמה, צוות ה- 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"
      }
   ]
}

מאפיין‬	Type	נדרש	תיאור‬‏‫‬
publisherId	מחרוזת	כן	המזהה הייחודי של מפרסם זה. השתמש במזהה זה כדי לזהות מפרסם זה בכל פעם שאתה יוצר או מעדכן פריט קטלוג עבור מפרסם זה. ניתן לשייך פריטי קטלוג למפרסם אחד בלבד בכל פעם. הערך יכול להיות GUID או מחרוזת. לאחר ההגדרה, יש לשמור אותו.
publisherDisplayName	מחרוזת	כן	צרכנים רואים נתונים אלה בגלריית הקטלוגים.
publisherUpnList	CatalogUPNOperation[]	כן	אנשים ה יכולים לשלוח פריטי קטלוג חדשים או לעדכן אותם כמפרסם זה. כולל תמיד את המשתמש השולח בפעם הראשונה שבה המוציא לאור נוצר.
publisherAADGroupOIDS	CatalogGroupOperation[]	כן	קבוצות מזהה Entra שהאיברים שלה מורשים לגשת למפרסם זה.

פעילות CatalogUPN

השתמש בנתונים אלה כדי לציין את המאפיין PublisherpublisherUpnList .

הגדרת פעולה להוספה או הסרה של אנשים ה יכולים לשלוח פריטי קטלוג חדשים או לעדכן אותם כמפרסם זה.

מאפיין‬	Type	נדרש	תיאור‬‏‫‬
action	מחרוזת	כן	הפעולה שיש לבצע עם UPN זה. ערכים חוקיים: Add או Remove.
upn	מחרוזת	כן	שם ראשי של משתמש (UPN) של המשתמש.
userOid	guid	כן	מזהה אובייקט עבור המשתמש.

פעילות קבוצת קטלוג

השתמש בנתונים אלה כדי לציין את המאפיין PublisherpublisherAADGroupOIDS .

הגדרת פעולה להוספה או להסרה של קבוצת Entra ID שניתן לגשת למפרסם זה.

מאפיין‬	Type	נדרש	תיאור‬‏‫‬
action	מחרוזת	כן	הפעולה שיש לבצע עם UPN זה. ערכים חוקיים: Add או Remove.
groupName	מחרוזת	כן	שם הקבוצה.
groupOid	guid	כן	מזהה אובייקט עבור קבוצה.
groupType	מחרוזת	כן	סוג הקבוצה הממוען. הערכים החוקיים הם ו Security - Modern.

פריט קטלוג - הגדרה

השתמש בנתונים אלה כדי לציין את מאפיין פריט שליחת הקטלוג 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	guid	כן	המזהה הייחודי של פריט הקטלוג. השתמש במזהה זה בעת עדכון או התקנה של פריט הקטלוג.
displayName	מחרוזת	כן	השם המוצג לצרכנים בגלריות הקטלוג.
description	מחרוזת	כן	תיאור המוצג לצרכנים בגלריות הקטלוג.
offer	הצעות ופעולות	כן	הפרטים של שליחת פריט הקטלוג.
packageFile	קובץ קטלוגקובץ	כן	מתאר היכן לקבל את קובץ חבילת הקטלוג עבור ההגשה.

הצעות ופעולות

השתמש בנתונים אלה כדי לציין את המאפיין CatalogItemDefinitionoffer .

מאפיינים אלה מגדירים את הפרטים של שליחת פריט הקטלוג.

מאפיין‬	Type	נדרש	תיאור‬‏‫‬
businessCategories	ב- int[]	כן	רשימה של ערכי אפשרויות בחירה שקטלוג היעד מכבד. מזהה את הקטגוריות העסקיות שיש לשייך לפריט קטלוג זה. ראה קטגוריות עסקיות עבור הערכים החוקיים שבהם יש להשתמש.
type	מחרוזת	כן	סוג פריט קטלוג. ערכים חוקיים: - Application - Component_Collection
supportsApplicationTypes	מחרוזת []	כן	רשימה של סוגי היישומים הנתמכים. ערכים חוקיים: - CanvasApps - ModelApps - PowerPortals - PowerAutomate
deploymentType	מחרוזת	כן	מציין את סוג הפריסה לפריסת פריט קטלוג זה. ערכים חוקיים: - Normal מייצג פריט מנוהל. - Template עותק של הפתרון הלא מנוהל שלך, היוצרים האחרים יכולים לערוך בכל דרך שתבחר. קבל מידע נוסף אודות סוגי פריטי קטלוג
searchKeywords	מחרוזת []	כן	מילים שאנשים עשויים להשתמש בהן כדי למצוא פריט קטלוג זה.
small48x48Image	קובץ קטלוגקובץ	כן	תמונה עבור תצוגת גלריה. אם לא תספק תמונה זו, ייעשה שימוש סמל ברירת מחדל של המערכת.
large216x216Image	קובץ קטלוגקובץ	כן	תמונה של תצוגת פירוט. ספק סמל שיוצגו ב- Maker או בממשק משתמש אחר לגילוי. חוויות משתמש מסוימות משתמשות בסמלים גדולים יותר לעיבוד כרטיסים לגילוי.
useCaseDocument	קובץ קטלוגקובץ	כן	תיאור מקרה שימוש והסבר למאשרים.
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	מסחר
526430009	כספים
526430010	תאימות וחוקית
526430011	Sales
526430012	כלי IT
526430013	Marketing
526430014	שרשרת אספקה ותפעול
526430015	האינטרנט של הדברים
526430016	למידת מכונה של בינה מלאכותית
526430017	מיקום גיאוגרפי
526430018	משאבי אנוש

בשלב זה, לא ניתן לקבוע את התצורה של קטגוריות עסקיות חדשות, אך ניתן לאחזר ןן מהבחירה הכללית של קטלוג קטגוריות עסקיות (mspcat_catalogbusinesscategory).

קובץ קטלוגקובץ

מאפיינים אלה מגדירים קובץ שאליו מתבצעת הפניה ב- CatalogItemDefinitionpackageFile ובמאפיינים OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documents, ו- screenshots .

מאפיין‬	Type	נדרש	תיאור‬‏‫‬
name	מחרוזת	כן	שם הקובץ.
filesaslink	URI של	כן	קישור להורדת הקובץ. אם הקישור דורש אימות, ספק כתובת URL של חתימת גישה משותפת (SAS).

PersonContactInformation

מאפיינים אלה מגדירים אנשים בפריט הקטלוג OfferDetailsengineeringName ומאפיינים supportName .

מאפיין‬	Type	נדרש	תיאור‬‏‫‬
firstName	מחרוזת	כן	שם פרטי של אדם.
lastName	מחרוזת	כן	שם משפחה של אדם.
email	מחרוזת	כן	כתובת דואר אלקטרוני של אדם.
phoneNumber	מחרוזת	כן	מספר טלפון של אדם.