Jagamisviis:


Kataloogiüksuse edastusdokumendi viide

Üksuse kataloogi saatmiseks peate kaasama JSON-vormingus andmed. Selles artiklis kirjeldatakse selle dokumendi kehtivaid atribuute. See JSON on näide.

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

Selles tabelis kirjeldatakse edastusdokumendi atribuute.

Atribuut Tüüp Nõutav Kirjeldus
modelVersion string No Edastusdokumendi versiooninumber. Vaikeväärtus on 1.0.0.0.
sourcePortal täisarv No Tuvastab selle taotluse allika. Vaikeväärtused 526430005 , mis on PAC CLI. Muude allikate korral kasutage .526430000 Funktsioon mspcat_GetPowerCatalogDetails tagastab täieliku loendi. Atribuut mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions sisaldab saadaolevaid suvandeid.
submissionId Guid No Edastuse tuvastamise GUID. See väärtus on võõrvõti, mis võimaldab taotluse linkida teiste süsteemidega.
operation string Ja Tulevase laienemise korral, mida praegu ei austata. Kasutatava toimingu tüüp. Sobivad väärtused:
- CreateOrUpdate (Vaikimisi)
- Create
- Update
- Disabled
businessJustification string No Kirjeldab kinnitajale edastamise ärilist väärtust. See väärtus võib sisaldada HTML- või RTF-vormingut. See teave kuvatakse plaanitud tarbimiskogemuses tegija avastamise kasutuskogemuses. Kasutajad võivad öelda, et nende esitamine aitab näiteks kulusid vähendada või tööviljakust vähendada. Mõni asutus nõuab teatud väärtuseklasse ja need väärtused saab siia sisestada.
publisherDetails Kirjastaja Ja Selle üksuse edastamisega seostatud avaldaja.
catalogItemDefinition CatalogItemDefinition Ja Määratleb edastatava kataloogiüksuse.

Kirjastaja

Nende andmete abil saate määrata kataloogi edastusüksuse atribuudi publisherDetails .

Loob avaldajakirje, mida saab seostada ühe või mitme Microsoft Entra ID rühmaga, mis sisaldab volitatud kasutajaid, kes saavad kataloogiüksusele edaspidi värskendusi teha.

Märkus.

Ärge ajage seda terminit segi lahenduse väljaandjaga. Kataloogiüksuse avaldajat ei kasutata lahendustega.

Peate esitama publisherDisplayName vähemalt. publisherId võib olla mis tahes stringiväärtus. Süsteem kontrollib, kas see avaldaja on olemas, muidu loob see ja määrab i publisherId.

Näiteks saab PERSONALI IT-meeskond luua väljaandja ja ID arendajad Microsoft Entra ID rühma abil.

Siin on näide avaldajakirjest, mis sisaldab inimese ja Entra ID rühma lisamise toiminguid

{
   "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"
      }
   ]
}
Atribuut Tüüp Nõutav Kirjeldus
publisherId string Ja Selle väljaandja ainu-ID. Selle ID abil saate selle väljaandja tuvastada iga kord, kui loote või värskendate selle väljaandja kataloogiüksust. Kataloogiüksusi saab korraga seostada ainult ühe avaldajaga. Väärtus võib olla GUID või string. Kui see on seatud, tuleb see säilitada.
publisherDisplayName string Ja Tarbijad näevad neid andmeid kataloogigaleriis.
publisherUpnList CatalogUPNOperation[] No Inimesed, kes saavad kataloogiüksusi selle avaldajana edastada või värskendada. Publisheri esmakordsel loomisel kaasatakse alati edastav kasutaja.
publisherAADGroupOIDS CatalogGroupOperation[] No Entra ID rühmad, mille liikmetel on sellele avaldajale juurdepääs lubatud.

CatalogUPNOperation

Nende andmete abil saate määrata PublisheripublisherUpnList atribuudi.

Määratleb toimingu, et lisada või eemaldada inimesi, kes saavad kataloogiüksusi selle avaldajana edastada või värskendada.

Atribuut Tüüp Nõutav Kirjeldus
action string Ja Selle UPN-iga tehtav toiming. Sobivad väärtused: Add või Remove.
upn string Ja Kasutaja turvasubjektinimi (UPN).
userOid Guid Ja Kasutaja objektiidentifikaator.

CatalogGroupOperation

Nende andmete abil saate määrata PublisheripublisherAADGroupOIDS atribuudi.

Määratleb toimingu, mis lisab või eemaldab Entra ID rühma, mis sellele avaldajale juurde pääseb.

Atribuut Tüüp Nõutav Kirjeldus
action string Ja Selle UPN-iga tehtav toiming. Sobivad väärtused: Add või Remove.
groupName string Ja Rühma nimi.
groupOid Guid Ja Rühma objekti identifikaator.
groupType string Ja Adresseeritava rühma tüüp. Sobivad väärtused on Security ja Modern.

CatalogItemDefinition

Nende andmete abil saate määrata kataloogi edastusüksuse atribuudi catalogItemDefinition .

Need atribuudid määratlevad edastatava kataloogiüksuse. See on tegelik Power Platformi lahendus. Pakett on see, mida talletatakse kataloogis.

Siin on näide kataloogiüksusest(sh selle engineeringName ja supportName kontaktide kohta), mis on kohustuslikud.

"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"
   }
   }
}
Atribuut Tüüp Nõutav Kirjeldus
id Guid Ja Kataloogiüksuse kordumatu ID. Kasutage seda ID-t kataloogiüksuse värskendamisel või installimisel.
displayName string Ja Nimi, mis kuvatakse tarbijatele kataloogigaleriides.
description string No Kirjeldus kuvatakse tarbijatele kataloogi galeriides.
offer OfferDetails Ja Kataloogiüksuse edastamise üksikasjad.
packageFile CatalogFileAsset Ja Kirjeldab, kust hankida edastuseks kataloogipaketi fail.

OfferDetails

Nende andmete abil saate määrata atribuudi CatalogItemDefinitionoffer .

Need atribuudid määratlevad kataloogiüksuse edastamise üksikasjad.

Atribuut Tüüp Nõutav Kirjeldus
businessCategories int[] No Sihtkataloogi järgitavate valikusuvandite väärtuste loend. Tuvastab selle kataloogiüksusega seostavad ärikategooriad. Sobivad väärtused leiate teemast Ärikategooriad .
type string Ja Kataloogiüksuse tüüp. Sobivad väärtused:
- Application
- Component_Collection
supportsApplicationTypes string[] No Toetatud rakendusetüüpide loend. Sobivad väärtused:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType string Ja Näitab selle kataloogiüksuse juurutamise tüüpi. Sobivad väärtused:
- Normal tähistab hallatavat üksust.
- Template Koopia teie mittehallatavast lahendusest, mida teised valmistajad saavad soovi korral redigeerida.
Lisateave kataloogiüksuste tüüpide kohta
searchKeywords string[] No Sõnad, mida inimesed võivad selle kataloogiüksuse leidmiseks kasutada.
small48x48Image CatalogFileAsset No Galeriivaate pilt. Kui te seda pilti ei sisesta, kasutatakse süsteemi vaikeikooni.
large216x216Image CatalogFileAsset No Üksikasjavaate pilt. Sisestage ikoon, mis kuvatakse loojas või mõnes muus tuvastuse kasutajaliideses. Mõned kasutusvõimalused kasutavad tuvastuskaartide renderdamiseks suuremaid ikoone.
useCaseDocument CatalogFileAsset No Saate kinnitajatele kasutada juhtumi kirjeldust ja selgitust.
videos CatalogFileAsset[] No Üksikasjavaates kuvatakse nende video-/GIF-failide lingid.
documents CatalogFileAsset[] No Üksikasjavaates kuvatakse nende failide lingid.
screenshots CatalogFileAsset[] No Üksikasjavaates kuvatakse need pildid. Siin saate edastada oma rakenduse kuvatõmmiseid, et aidata loojatel kindlaks teha, kas see rakendus pakub otsitavaid funktsioone või funktsioone. Kõige levinum asi, mida inimesed enne rakenduse või malli allalaadimist teevad, on vaadata selle pilte ja kuvatõmmiseid, et mõista kirjelduste lugemise asemel võimalusi.
helpLink Uri No Dokumentatsiooni link. Need URL-id võivad olla sisemise dokumendi või SharePointi ressursside lingid.
privacyPolicyLink Uri No Privaatsusdokumendi link. Edastatava komponendi või rakenduse hoolikat kasutamist käsitlevad poliitikad.
legalTermsLink Uri No Link tingimustele vastavale dokumendile. Kõik juriidilised tingimused või sisemised juhised kataloogiüksuse tarbija hindamiseks.
legalTerms string No Tingimuste dokumendi markdown, HTML või tekstiversioon. Kõik juriidilised tingimused või sisemised juhised kataloogiüksuse tarbija hindamiseks.
sourceCodeRepositoryLink Uri No Link lähtekoodi hoidlale
engineeringName PersonContactInformation Ja Selle kataloogiüksuse välja töötanud inseneri või rühma kontaktteave.
supportName PersonContactInformation No Seda kataloogiüksust toetava tugiteenuse või rühma kontaktteave. Võib olla sama mis tehniline kontakt, millega kataloogiüksuse tarbija saab ühendust võtta, kui neil tekib rakendusega probleeme.

Ärikategooriad

Seadke atribuudi OfferDetailsbusinessCategories väärtuseks üks või mitu järgmistest ärikategooriatest:

Kood Kirjeldus
526430000 Klienditeenindus
526430001 Projektihaldus
526430002 Kalendrihaldus ja ajastamine
526430003 Meilihaldus
526430004 Failid &dokumentatsioon
526430005 Teatised ja meeldetuletused
526430006 Analüüsiteave
526430007 Koostöö
526430008 Commerce
526430009 Rahandus
526430010 Nõuetele vastavus &õiguslik
526430011 Sales
526430012 IT-tööriistad
526430013 Marketing
526430014 Operatsioonid & tarneahela
526430015 asjade Internet
526430016 Tehte masinõpe
526430017 Asukoht
526430018 Inimressursid

Praegu ei saa uusi ärikategooriaid konfigureerida, kuid neid saab tuua kataloogi ärikategooria (mspcat_catalogbusinesscategory) globaalsest valikust.

CatalogFileAsset

Need atribuudid määratlevad faili, millele on viidatud atribuutides CatalogItemDefinitionpackageFile ja OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsja screenshots .

Atribuut Tüüp Nõutav Kirjeldus
name string Ja Faili nimi.
filesaslink Uri Ja Faili allalaadimise link. Kui link nõuab autentimist, sisestage ühispääsusignatuuri (SAS) URL.

PersonContactInformation

Need atribuudid määratlevad inimesed kataloogiüksuses OfferDetails ja engineeringName atribuudidsupportName.

Atribuut Tüüp Nõutav Kirjeldus
firstName string No Isiku eesnimi.
lastName string Ja Isiku perekonnanimi.
email string Ja Isiku meiliaadress.
phoneNumber string No Isiku telefoninumber.