Katalóguselem-beküldési dokumentum referenciája

Az elemek katalógusba való elküldésekor JSON formátumban kell megadnia az adatokat. Ez a cikk a dokumentum érvényes tulajdonságait ismerteti. Ez a JSON egy példa:

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

Ez a táblázat a beküldési dokumentum tulajdonságait ismerteti:

Ingatlan Típus Kötelező Description
modelVersion karakterlánc Nem A beküldési dokumentum verziószáma. Az alapértelmezett érték 1.0.0.0.
sourcePortal int Nem Azonosítja a kérés forrását. Alapértelmezett értékek, amelyekhez 526430005 a PAC CLI tartozik. Más forrásokhoz használja a következőt 526430000: . A mspcat_GetPowerCatalogDetails függvény a teljes listát adja vissza. A mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions tulajdonság felsorolja az elérhető lehetőségeket.
submissionId útmutató Nem Guid a beküldés azonosításához. Ez az érték egy idegen kulcs, amely lehetővé teszi a kérés más rendszerekhez való csatolását.
operation karakterlánc Igen A jövőbeli bővítéshez, és jelenleg nem tartják tiszteletben. A használni kívánt művelet típusa. Érvényes értékek:
- CreateOrUpdate (Alapértelmezett)
- Create
- Update
- Disabled
businessJustification karakterlánc Nem A jóváhagyónak történő beküldés üzleti értékét ismerteti. Ez az érték HTML- vagy Rich Text-formátumot (RTF) tartalmazhat. Ezek az információk a tervezett használatban jelennek meg a készítő felderítési felhasználói felületén. A felhasználók azt mondhatják, hogy a beküldésük segít például a költségcsökkentésben vagy a termelékenységben. Egyes szervezetek bizonyos értékosztályokat igényelnek, és ezeket az értékeket itt adhatja meg.
publisherDetails Publisher Igen Az elem beküldésével társított közzétevő.
catalogItemDefinition CatalogItemDefinition Igen Meghatározza a beküldendő katalóguselemet.

Kiadó

Ezen adatok használatával adja meg a katalógus beküldési elemének tulajdonságát publisherDetails .

Létrehoz egy közzétevői rekordot, amely egy vagy több Microsoft Entra-azonosítócsoporthoz társítható, amely jogosult felhasználókat tartalmaz, akik frissíthetik a katalóguselemet.

Megjegyzés:

Ne keverje össze ezt a kifejezést a Solution Publisherrel. A katalóguselem-közzétevő nem használható megoldásokkal.

A minimumot meg kell adnia publisherDisplayName . publisherId bármilyen sztringérték lehet. A rendszer ellenőrzi, hogy létezik-e a közzétevő, máskülönben létrehozza és hozzárendel egy publisherId.

A HR informatikai csapata például létrehozhat egy közzétevőt, és egy Microsoft Entra ID-csoport használatával azonosítót adhat a fejlesztőknek.

Íme egy minta egy közzétevői rekordból, amely egy személy és egy Entra-azonosító csoport hozzáadására szolgáló műveleteket tartalmaz

{
   "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"
      }
   ]
}
Ingatlan Típus Kötelező Description
publisherId karakterlánc Igen A közzétevő egyedi azonosítója. Ezzel az azonosítóval azonosíthatja ezt a közzétevőt, amikor katalóguselemet hoz létre vagy frissít ehhez a közzétevőhöz. A katalóguselemek egyszerre csak egy közzétevőhöz társíthatók. Az érték lehet GUID vagy sztring. Ha be van állítva, azt meg kell tartani.
publisherDisplayName karakterlánc Igen A felhasználók ezeket az adatokat a katalógusgyűjteményben látják.
publisherUpnList CatalogUPNOperation[] Nem Azok a személyek, akik közzétevőként küldhetnek be új vagy frissített katalóguselemeket. Mindig tartalmazza a beküldő felhasználót a Publisher első létrehozásakor.
publisherAADGroupOIDS CatalogGroupOperation[] Nem Entra-azonosító csoportok, amelyek tagjai hozzáférhetnek a közzétevőhöz.

CatalogUPNOperation

Ezen adatok használatával adja meg a PublisherpublisherUpnList tulajdonságot.

Egy olyan művelet definiálása, amellyel új vagy frissítési katalóguselemeket beküldő személyek vehetők fel vagy távolíthatók el közzétevőként.

Ingatlan Típus Kötelező Description
action karakterlánc Igen Az upn használatával végrehajtandó művelet. Érvényes értékek: Add vagy Remove.
upn karakterlánc Igen A felhasználó egyszerű felhasználóneve (UPN).
userOid útmutató Igen A felhasználó objektumazonosítója.

CatalogGroupOperation

Ezen adatok használatával adja meg a PublisherpublisherAADGroupOIDS tulajdonságot.

Meghatározza a közzétevőhöz hozzáférő Entra-azonosítócsoport hozzáadására vagy eltávolítására irányuló műveletet.

Ingatlan Típus Kötelező Description
action karakterlánc Igen Az upn használatával végrehajtandó művelet. Érvényes értékek: Add vagy Remove.
groupName karakterlánc Igen Csoport neve.
groupOid útmutató Igen Csoport objektumazonosítója.
groupType karakterlánc Igen A cím alatt álló csoport típusa. Az érvényes értékek a következők: Security és Modern.

CatalogItemDefinition

Ezen adatok használatával adja meg a katalógus beküldési elemének tulajdonságát catalogItemDefinition .

Ezek a tulajdonságok határozzák meg a beküldendő katalóguselemet. Ez a tényleges Power Platform-megoldás. A csomag a katalógusban tárolt csomag.

Íme egy példa egy katalóguselemre, beleértve annak engineeringName és supportName a kötelező névjegyeket is.

"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"
   }
   }
}
Ingatlan Típus Kötelező Description
id útmutató Igen A katalóguselem egyedi azonosítója. Ezt az azonosítót használja a katalóguselem frissítésekor vagy telepítésekor.
displayName karakterlánc Igen A katalógustárakban a felhasználók számára megjelenített név.
description karakterlánc Nem A katalógustárakban a felhasználók számára megjelenített leírás.
offer OfferDetails Igen A katalóguselem beküldésének részletei.
packageFile CatalogFileAsset Igen Ez a cikk bemutatja, hogy hol szerezheti be a katalóguscsomagfájlt a beküldéshez.

Ajánlat részletei

Ezen adatok használatával adja meg a CatalogItemDefinition tulajdonságotoffer .

Ezek a tulajdonságok határozzák meg a katalóguselem beküldésének részleteit.

Ingatlan Típus Kötelező Description
businessCategories int[] Nem A célkatalógus által tiszteletben tartható választási lehetőségek listája. Azonosítja a katalóguselemhez társítandó üzleti kategóriákat. A használni kívánt érvényes értékekért tekintse meg az üzleti kategóriákat .
type karakterlánc Igen Katalóguselem típusa. Érvényes értékek:
- Application
- Component_Collection
supportsApplicationTypes karakterlánc[] Nem A támogatott alkalmazástípusok listája. Érvényes értékek:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType karakterlánc Igen A katalóguselem üzembe helyezésének típusát jelzi. Érvényes értékek:
- Normal egy felügyelt elemet jelöl.
- Template A nem felügyelt megoldás másolata, amelyet a többi készítő tetszés szerint szerkeszthet.
További információ a katalóguselem-típusokról
searchKeywords karakterlánc[] Nem Olyan szavak, amelyekkel a felhasználók megkereshetik ezt a katalóguselemet.
small48x48Image CatalogFileAsset Nem Kép katalógusnézethez. Ha nem adja meg ezt a képet, a rendszer egy alapértelmezett ikont használ.
large216x216Image CatalogFileAsset Nem Kép a részletes nézetről. Adjon meg egy ikont, amely megjeleníthető a készítőben vagy más felderítési felhasználói felületen. Egyes felhasználói élmények nagyobb ikonokkal jelenítik meg a kártyákat a felderítéshez.
useCaseDocument CatalogFileAsset Nem Használja az eset leírását és magyarázatát a jóváhagyók számára.
videos CatalogFileAsset[] Nem A Részletek nézetben ezekre a videó-/gif-fájlokra mutató hivatkozások láthatók.
documents CatalogFileAsset[] Nem A Részletek nézetben ezekre a fájlokra mutató hivatkozások jelennek meg.
screenshots CatalogFileAsset[] Nem A Részletek nézet megjeleníti ezeket a képeket. Az alkalmazás képernyőképeit itt adhatja meg, hogy a készítők megállapíthassák, hogy az alkalmazás biztosítja-e az általuk keresett funkciókat vagy képességeket. Az alkalmazások vagy sablonok letöltése előtt leggyakrabban a képeket és a képernyőképeket tekintik meg, hogy a leírás elolvasása helyett megismerhessék a képességeket.
helpLink URL Nem Hivatkozás a dokumentációra. Ezek az URL-címek lehetnek belső dokumentumokra vagy SharePoint-erőforrásokra mutató hivatkozások.
privacyPolicyLink URL Nem Hivatkozás az adatvédelmi dokumentumra. A beküldött összetevő vagy alkalmazás gondos használatára vonatkozó szabályzatok.
legalTermsLink URL Nem Hivatkozás a Használati feltételek dokumentumra. Bármely jogi feltétel vagy belső útmutató a katalóguselem fogyasztójának értékeléséhez.
legalTerms karakterlánc Nem A Használati feltételek dokumentum Markdown-, HTML- vagy szöveges verziója. Bármely jogi feltétel vagy belső útmutató a katalóguselem fogyasztójának értékeléséhez.
sourceCodeRepositoryLink URL Nem Hivatkozás a forráskódtárra
engineeringName PersonContactInformation Igen A katalóguselemet fejlesztő mérnök vagy csoport kapcsolattartási adatai.
supportName PersonContactInformation Nem A katalóguselemet támogató támogatási vagy csoport kapcsolattartási adatai. Ugyanaz lehet, mint az a mérnöki partner, akivel a katalóguselem fogyasztója kapcsolatba léphet, ha problémákba ütköznek az alkalmazással kapcsolatban.

Üzleti kategóriák

Állítsa be az OfferDetailsbusinessCategories tulajdonságot egy vagy több üzleti kategóriára:

Kód Description
526430000 Ügyfélszolgálat
526430001 Projektvezetés
526430002 Naptárkezelés és ütemezés
526430003 E-mail-kezelés
526430004 Fájlok > dokumentáció
526430005 Értesítés és emlékeztetők
526430006 Adat-elemzés
526430007 Együttműködés
526430008 Commerce
526430009 Finance
526430010 Megfelelőség > Jogi
526430011 Sales
526430012 Informatikai eszközök
526430013 Marketing
526430014 Műveletek és Ellátási Lánc
526430015 eszközök internetes hálózata
526430016 AI Machine Learning
526430017 Geolocation
526430018 Emberi erőforrások

Az új üzleti kategóriák jelenleg nem konfigurálhatók, de lekérhetők a katalógus üzleti kategóriájának (mspcat_catalogbusinesscategory) globális választásából.

CatalogFileAsset

Ezek a tulajdonságok definiálnak egy, a CatalogItemDefinitionpackageFile és az OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsés screenshots tulajdonságokban hivatkozott fájlt.

Ingatlan Típus Kötelező Description
name karakterlánc Igen A fájl neve.
filesaslink URL Igen Hivatkozás a fájl letöltéséhez. Ha a hivatkozás hitelesítést igényel, adjon meg egy közös hozzáférésű jogosultságkód (SAS) URL-címet.

PersonContactInformation

Ezek a tulajdonságok definiálják az OfferDetailsengineeringName katalóguselemben szereplő személyeket és supportName tulajdonságokat.

Ingatlan Típus Kötelező Description
firstName karakterlánc Nem Személy utóneve.
lastName karakterlánc Igen Személy családneve.
email karakterlánc Igen Személy e-mail-címe.
phoneNumber karakterlánc Nem Személy telefonszáma.
  • Utolsó frissítés időpontja: