Sklic na dokument za pošiljanje elementa kataloga

Ko pošljete element v katalog, morate vključiti podatke v obliki JSON. V tem članku so opisane veljavne lastnosti tega dokumenta. Ta JSON je primer:

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

V tej tabeli so opisane lastnosti dokumenta za pošiljanje:

Lastnost Vrsta Zahtevano Opis
modelVersion niz Ne Številka različice dokumenta za pošiljanje. Privzeta vrednost je 1.0.0.0.
sourcePortal celo število Ne Določa vir te zahteve. Privzeto je PAC 526430005 CLI. Za druge vire uporabite 526430000. Funkcija mspcat_GetPowerCatalogDetails vrne celoten seznam. V lastnosti mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions so navedene možnosti, ki so na voljo.
submissionId Guid Ne Guid za prepoznavanje pošiljanja. Ta vrednost je tuji ključ, ki omogoča povezovanje zahteve z drugimi sistemi.
operation niz Da Za razširitev v prihodnosti in trenutno ni upoštevana. Vrsta operacije, ki bo uporabljena. Veljavne vrednosti:
- CreateOrUpdate (Privzeto)
- Create
- Update
- Disabled
businessJustification niz Ne Opisuje poslovno vrednost pošiljanja potrjevalca. Ta vrednost lahko vsebuje HTML ali obogateno besedilo (RTF). Te informacije so prikazane v izkušnji načrtovane porabe v uporabniški izkušnji odkrivanja izdelovalca. Uporabniki lahko na primer rečejo, da njihova predložitev pomaga pri zmanjšanju stroškov ali produktivnosti. Nekatere organizacije zahtevajo določene razrede vrednosti, te vrednosti pa lahko vnesete tukaj.
publisherDetails Založnik Da Izdajatelj, povezan s pošiljanjem tega elementa.
catalogItemDefinition CatalogItemDefinition Da Določi element kataloga, ki ga želite poslati.

Založnik

S podatki določite lastnost elementa pošiljanja kataloga publisherDetails .

Ustvari zapis izdajatelja, ki ga je mogoče povezati z eno ali več skupinami Microsoft Entra ID, ki vsebujejo pooblaščene uporabnike, ki lahko v prihodnje posodabljajo element kataloga.

opomba,

Ne zamenjujte tega izraza s programom Solution Publisher. Izdajatelj elementa kataloga se ne uporablja z rešitvami.

Zagotoviti morate vsaj publisherDisplayName to. publisherId je lahko katera koli vrednost niza. Sistem preveri, ali ta izdajatelj obstaja, sicer ga ustvari in dodeli publisherId.

Tako lahko na primer skupina za IT kadrovske službe razvijalcev ustvari založnika in ID-je razvijalcev, ki uporabljajo skupino Microsoft Entra ID.

Tukaj je vzorec zapisa izdajatelja, ki vključuje postopke za dodajanje osebe in skupine »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"
      }
   ]
}
Lastnost Vrsta Zahtevano Opis
publisherId niz Da Enolični ID tega izdajatelja. S tem ID-jem določite tega izdajatelja, ko ustvarjate ali posodabljate element kataloga za tega izdajatelja. Elemente kataloga je mogoče povezati le z enim založnikom hkrati. Vrednost je lahko GUID ali niz. Ko je nastavljen, ga je treba ohraniti.
publisherDisplayName niz Da Potrošniki vidijo te podatke v galeriji katalogov.
publisherUpnList CatalogUPNOperation[] Ne Osebe, ki lahko kot izdajatelja predložijo nove ali posodobijo elemente kataloga. Vedno vključuje uporabnika, ki je oddajal, ko prvič ustvarite Publisherja.
publisherAADGroupOIDS CatalogGroupOperation[] Ne Skupine ID-jev entre, katerih člani lahko dostopajo do tega izdajatelja.

CatalogUPNOperation

S podatki določite publisherjevopublisherUpnList lastnost.

Določi operacijo za dodajanje ali odstranjevanje oseb, ki lahko kot izdajatelja predložijo nove ali posodobijo elemente kataloga.

Lastnost Vrsta Zahtevano Opis
action niz Da Dejanje, ki ga morate izvesti s tem UPN-jem. Veljavne vrednosti: Add ali Remove.
upn niz Da Glavno uporabniško ime (UPN) uporabnika.
userOid Guid Da Identifikator predmeta za uporabnika.

Skupina katalogovOperation

S podatki določite publisherjevopublisherAADGroupOIDS lastnost.

Določi operacijo za dodajanje ali odstranjevanje skupine ID-jev Entra, ki ima dostop do tega izdajatelja.

Lastnost Vrsta Zahtevano Opis
action niz Da Dejanje, ki ga morate izvesti s tem UPN-jem. Veljavne vrednosti: Add ali Remove.
groupName niz Da Ime skupine.
groupOid Guid Da Identifikator predmeta za skupino.
groupType niz Da Vrsta skupine, ki jo obravnavamo. Veljavne vrednosti so in SecurityModern.

CatalogItemDefinition

S podatki določite lastnost elementa pošiljanja kataloga catalogItemDefinition .

Te lastnosti določajo element kataloga, ki ga želite poslati. To je dejanska rešitev platforme Power Platform. Paket je paket, ki je shranjen v katalogu.

Tukaj je primer elementa kataloga, vključno z njegovimi engineeringName in stiki supportName , ki so obvezni.

"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"
   }
   }
}
Lastnost Vrsta Zahtevano Opis
id Guid Da Enolični ID elementa kataloga. Ta ID uporabite pri posodabljanju ali nameščanju elementa kataloga.
displayName niz Da Ime, prikazano potrošnikom v galerijah kataloga.
description niz Ne Opis, prikazan potrošnikom v galerijah kataloga.
offer OfferDetails Da Podrobnosti pošiljanja elementa kataloga.
packageFile CatalogFileAsset Da Opisuje, kje je mogoče pridobiti paketno datoteko kataloga za pošiljanje.

OfferDetails

S podatki določite lastnost CatalogItemDefinitionoffer .

Te lastnosti določajo podrobnosti pošiljanja elementa kataloga.

Lastnost Vrsta Zahtevano Opis
businessCategories int[] Ne Seznam vrednosti možnosti izbire, ki jih upošteva ciljni katalog. Določa poslovne kategorije, ki jih želite povezati s tem elementom kataloga. Če želite uporabiti veljavne vrednosti, glejte Poslovne kategorije.
type niz Da Vrsta elementa kataloga. Veljavne vrednosti:
- Application
- Component_Collection
supportsApplicationTypes niz [] Ne Seznam podprtih vrst programov. Veljavne vrednosti:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType niz Da Označuje vrsto uvajanja za uvedbo tega elementa kataloga. Veljavne vrednosti:
- Normal predstavlja upravljan element.
- Template Kopija neupravljane rešitve, ki jo lahko drugi ustvarjalci urejajo, ne glede na to, kaj izberejo.
Več informacij o vrstah elementov kataloga
searchKeywords niz [] Ne Besede, ki jih ljudje morda uporabljajo za iskanje tega elementa kataloga.
small48x48Image CatalogFileAsset Ne Slika za pogled galerije. Če slike ne navedete, je uporabljena privzeta ikona sistema.
large216x216Image CatalogFileAsset Ne Slika za pogled podrobnosti. Navedite ikono, ki bo prikazana v ustvarjalcu ali drugem uporabniškem vmesniku za odkrivanje. Nekatere uporabniške izkušnje uporabljajo večje ikone za upodabljanje kartic za odkrivanje.
useCaseDocument CatalogFileAsset Ne Potrjevalcem dodajte opis primera in razlago.
videos CatalogFileAsset[] Ne V podrobnem pogledu so prikazane povezave do teh datotek video/gif.
documents CatalogFileAsset[] Ne V podrobnem pogledu so prikazane povezave do teh datotek.
screenshots CatalogFileAsset[] Ne Na podrobnem pogledu so prikazane te slike. Tukaj lahko podaste posnetke zaslona svoje aplikacije in nosilcem pomagate ugotoviti, ali ta aplikacija zagotavlja funkcije ali zmogljivosti, ki jih iščejo. Ljudje pred prenosom aplikacije ali predloge najpogosteje pogledajo slike in posnetke zaslona, da razumejo zmogljivosti, namesto da bi brali opis.
helpLink uri Ne Povezava do dokumentacije. Ti URL-ji so lahko povezave do notranjih dokumentov ali SharePointovih virov.
privacyPolicyLink uri Ne Povezava do dokumenta o zasebnosti. Pravilniki o skrbni uporabi poslane komponente ali aplikacije.
legalTermsLink uri Ne Povezava do dokumenta s pogoji in določili. Kateri koli pravni pogoji ali interna navodila za vrednotenje potrošnika elementa kataloga.
legalTerms niz Ne Markdown, HTML ali besedilna različica dokumenta s pogoji in določili. Kateri koli pravni pogoji ali interna navodila za vrednotenje potrošnika elementa kataloga.
sourceCodeRepositoryLink uri Ne Povezava do skladišča izvorne kode
engineeringName PersonContactInformation Da Podatki za stik za inženirja ali skupino, ki je razvila ta element kataloga.
supportName PersonContactInformation Ne Podatki za stik za podporo ali skupino, ki podpira ta element kataloga. Lahko je enak kot stik inženirstva, na katero se lahko obrne potrošnik elementa kataloga, če naleti na težave s programom.

Poslovne kategorije

Lastnost OfferDetails nastavitebusinessCategories na eno ali več od teh poslovnih kategorij:

Koda Opis
526430000 Služba za stranke
526430001 Vodenje projektov
526430002 Upravljanje koledarja & načrtovanje
526430003 Upravljanje e-pošte
526430004 Datoteke in dokumentacija
526430005 Obvestilo &opomniki
526430006 Analitika
526430007 Sodelovanje
526430008 Commerce
526430009 Finance
526430010 Skladnost s predpisi in pravno
526430011 Sales
526430012 Orodja za IT
526430013 Marketing
526430014 Operacije & dobavna veriga
526430015 internet stvari
526430016 Strojno učenje za UI
526430017 Geolokacija
526430018 Človeški viri

Novih poslovnih kategorij trenutno ni mogoče konfigurirati, lahko pa jih pridobite iz globalne izbire kategorije kataloga (mspcat_catalogbusinesscategory).

CatalogFileAsset

Te lastnosti določajo datoteko, na katere se sklicuje catalogItemDefinitionpackageFile in OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsin screenshots lastnosti.

Lastnost Vrsta Zahtevano Opis
name niz Da Ime datoteke.
filesaslink uri Da Povezava za prenos datoteke. Če povezava zahteva preverjanje pristnosti, navedite URL podpisa za dostop v skupni rabi (SAS).

PersonContactInformation

Te lastnosti določajo osebe v elementu kataloga OfferDetailsengineeringNamesupportName in lastnosti.

Lastnost Vrsta Zahtevano Opis
firstName niz Ne Ime osebe.
lastName niz Da Ime družinske osebe.
email niz Da E-poštni naslov osebe.
phoneNumber niz Ne Telefonska številka osebe.