Comparteix via

Referència del document d'enviament d'elements de catàleg

Heu d'incloure dades en format JSON quan envieu un element al catàleg. En aquest article es descriuen les propietats vàlides d'aquest document. Aquest JSON n'és un exemple:

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

En aquesta taula es descriuen les propietats del document d'enviament:

Propietat Tipus Necessari Descripció
modelVersion cadena No Número de versió del document de presentació. El valor predeterminat és 1.0.0.0.
sourcePortal Int No Identifica l'origen d'aquesta sol·licitud. Per defecte 526430005 , quina és la CLI del PAC. Per a altres fonts, utilitzeu 526430000. La mspcat_GetPowerCatalogDetails funció retorna la llista completa. La mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions propietat enumera les opcions disponibles.
submissionId guid No Guid per identificar la presentació. Aquest valor és una clau externa per permetre enllaçar la sol·licitud a altres sistemes.
operation cadena Sí Per a l'expansió futura i actualment no es respecta. El tipus d'operació que s'utilitzarà. Valors vàlids:
- CreateOrUpdate (Per defecte)
- Create
- Update
- Disabled
businessJustification cadena No Descriu el valor empresarial de l'enviament a l'aprovador. Aquest valor pot contenir HTML o format de text enriquit (RTF). Aquesta informació apareix a l'experiència de consum planificat a l'experiència d'usuari de Maker Discovery. Els usuaris poden dir que el seu enviament ajuda a reduir costos o productivitat, per exemple. Algunes organitzacions requereixen certes classes de valor i aquests valors es poden introduir aquí.
publisherDetails Editor Sí L'editor associat a l'enviament d'aquest element.
catalogItemDefinition CatalogItemDefinition Sí Defineix l'element de catàleg que s'està enviant.

Editor

Utilitzeu aquestes dades per especificar la propietat de l'element publisherDetails d'enviament del catàleg.

Crea un registre d'editor que es pot associar a un o més grups d'identificadors del Microsoft Entra que contenen usuaris autoritzats que poden fer actualitzacions a l'element del catàleg en el futur.

Nota

No confondeu aquest terme amb l'editor de solucions. L'editor d'elements de catàleg no s'utilitza amb solucions.

Heu de proporcionar el publisherDisplayName com a mínim. publisherId pot ser qualsevol valor de cadena. El sistema comprova si aquest editor existeix, en cas contrari el crea i assigna un publisherId.

Per exemple, l'equip de desenvolupadors de TI de recursos humans pot crear un editor i identificar els desenvolupadors mitjançant un grup d'identificadors del Microsoft Entra.

A continuació es mostra un exemple d'un registre d'editor que inclou operacions per afegir una persona i un grup d'identificadors d'entrada

{
   "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"
      }
   ]
}
Propietat Tipus Necessari Descripció
publisherId cadena Sí L'identificador únic d'aquest editor. Utilitzeu aquest identificador per identificar aquest editor cada vegada que creeu o actualitzeu un element de catàleg per a aquest editor. Els elements del catàleg només es poden associar a un editor alhora. El valor pot ser un GUID o una cadena. Un cop configurat, s'ha de mantenir.
publisherDisplayName cadena Sí Els consumidors veuen aquestes dades a la galeria del catàleg.
publisherUpnList CatàlegUPNOoperació[modifica] No Persones que poden enviar elements de catàleg nous o actualitzats com a editor. Sempre inclou l'usuari que envia la primera vegada que es crea l'editor.
publisherAADGroupOIDS CatalogGroupOperation[modifica] No Entra ID Grups els membres dels quals poden accedir a aquest editor.

CatàlegUPNOoperació

Utilitzeu aquestes dades per especificar la propietat PublisherpublisherUpnList .

Defineix una operació per afegir o suprimir persones que poden enviar elements de catàleg nous o actualitzar-los com a publicador.

Propietat Tipus Necessari Descripció
action cadena Sí L'acció a prendre amb aquest UPN. Valors vàlids: Add o Remove.
upn cadena Sí Nom principal d'usuari (UPN) de l'usuari.
userOid guid Sí Identificador d'objecte per a l'usuari.

Operació CatalogGroupOperation

Utilitzeu aquestes dades per especificar la propietat PublisherpublisherAADGroupOIDS .

Defineix una operació per afegir o suprimir un grup d'identificadors d'Entra que pot accedir a aquest editor.

Propietat Tipus Necessari Descripció
action cadena Sí L'acció a prendre amb aquest UPN. Valors vàlids: Add o Remove.
groupName cadena Sí Nom del grup.
groupOid guid Sí Identificador d'objecte per al grup.
groupType cadena Sí Tipus de grup al qual s'adreça. Els valors vàlids són Security i Modern.

CatalogItemDefinition

Utilitzeu aquestes dades per especificar la propietat de l'element catalogItemDefinition d'enviament del catàleg.

Aquestes propietats defineixen l'element de catàleg que s'envia. Aquesta és la solució real del Power Platform. Un paquet és el que s'emmagatzema al catàleg.

Aquí teniu un exemple d'un element de catàleg que inclou els seus engineeringName contactes obligatoris 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"
   }
   }
}
Propietat Tipus Necessari Descripció
id guid Sí L'identificador únic de l'element del catàleg. Utilitzeu aquest identificador quan actualitzeu o instal·leu l'element del catàleg.
displayName cadena Sí Nom mostrat als consumidors a les galeries del catàleg.
description cadena No Descripció mostrada als consumidors a les galeries del catàleg.
offer OfertesDetalls Sí Els detalls de l'enviament de l'element del catàleg.
packageFile CatàlegArxiuActiu Sí Descriu on obtenir el fitxer del paquet de catàleg per a l'enviament.

OfertesDetalls

Utilitzeu aquestes dades per especificar la propietat CatalogItemDefinitionoffer .

Aquestes propietats defineixen els detalls de l'enviament de l'element del catàleg.

Propietat Tipus Necessari Descripció
businessCategories int[modifica] No Llista de valors d'opció respectats pel catàleg de destinació. Identifica les categories d'empresa que s'han d'associar amb aquest element de catàleg. Vegeu Categories d'empresa per veure els valors vàlids que voleu utilitzar.
type cadena Sí Tipus d'element de catàleg. Valors vàlids:
- Application
- Component_Collection
supportsApplicationTypes corda[modifica] No Llista dels tipus d'aplicacions admeses. Valors vàlids:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType cadena Sí Indica el tipus d'implementació per implementar aquest element de catàleg. Valors vàlids:
- Normalrepresenta un element administrat.
- Template Una còpia de la vostra solució no administrada que altres creadors poden editar com vulguin.
Més informació sobre els tipus d'elements del catàleg
searchKeywords corda[modifica] No Paraules que la gent pot utilitzar per trobar aquest element del catàleg.
small48x48Image CatàlegArxiuActiu No Imatge per a la visualització de galeria. Si no proporcioneu aquesta imatge, s'utilitzarà una icona predeterminada del sistema.
large216x216Image CatàlegArxiuActiu No Imatge per a la vista de detall. Proporcioneu una icona que es mostrarà al creador o a una altra interfície d'usuari de descobriment. Algunes experiències d'usuari utilitzen icones més grans per representar targetes per descobrir-les.
useCaseDocument CatàlegArxiuActiu No Descripció del cas d'ús i explicació als aprovadors.
videos CatalogFileAsset[modifica] No La visualització de detalls mostra enllaços a aquests fitxers de vídeo/gif.
documents CatalogFileAsset[modifica] No La visualització de detalls mostra enllaços a aquests fitxers.
screenshots CatalogFileAsset[modifica] No La visualització de detalls mostra aquestes imatges. Podeu passar captures de pantalla aquí de la vostra aplicació per ajudar els creadors a identificar si aquesta aplicació proporciona la funcionalitat o la capacitat que busquen. El més comú que fa la gent abans de descarregar una aplicació o plantilla és mirar les seves imatges i captures de pantalla per entendre les capacitats en lloc de llegir la descripció.
helpLink uri No Enllaç a la documentació. Aquestes adreces URL poden ser enllaços a documents interns o recursos del SharePoint.
privacyPolicyLink uri No Enllaç al document de privacitat. Polítiques sobre l'ús acurat del component o l'aplicació que s'envia.
legalTermsLink uri No Enllaç al document de Termes i Condicions. Qualsevol termini legal o orientació interna per a l'avaluació del consumidor de l'article de catàleg.
legalTerms cadena No Markdown, HTML o versió de text del document Termes i condicions. Qualsevol termini legal o orientació interna per a l'avaluació del consumidor de l'article de catàleg.
sourceCodeRepositoryLink uri No Enllaç al repositori de codi font
engineeringName PersonaContacteInformació Sí Informació de contacte de l'enginyer o grup que ha desenvolupat aquest article de catàleg.
supportName PersonaContacteInformació No Informació de contacte del suport tècnic o del grup que admet aquest element de catàleg. Pot ser el mateix que el contacte d'enginyeria al qual el consumidor d'un element de catàleg pot contactar si té problemes amb l'aplicació.

Categories d'empresa

Definiu la propietat OfferDetailsbusinessCategories en una o més d'aquestes categories d'empresa:

Codi Descripció
526430000 Atenció al client
526430001 Administració de projectes
526430002 Gestió i planificació de calendaris
526430003 Gestió de correu electrònic
526430004 Fitxers i documentació
526430005 Notificacions i recordatoris
526430006 Anàlisis
526430007 Col·laboració
526430008 Comerç
526430009 Finances
526430010 Compliment i Legal
526430011 Sales
526430012 Eines informàtiques
526430013 Marketing
526430014 Operacions i cadena de subministrament
526430015 Internet de les coses
526430016 Aprenentatge automàtic d'IA
526430017 Geolocalització
526430018 Recursos humans

Actualment, les categories d'empresa noves no es poden configurar, però es poden recuperar des de l'opció global Categoria d'empresa del catàleg (mspcat_catalogbusinesscategory).

CatàlegArxiuActiu

Aquestes propietats defineixen un fitxer al qual es fa referència a CatalogItemDefinitionpackageFile i a les propietats OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsi screenshots .

Propietat Tipus Necessari Descripció
name cadena Sí Nom del fitxer.
filesaslink uri Sí Enllaç per descarregar el fitxer. Si l'enllaç requereix autenticació, proporcioneu una adreça URL de signatura d'accés compartit (SAS).

PersonaContacteInformació

Aquestes propietats defineixen les persones de l'element de catàleg OfferDetailsengineeringName i supportName les propietats.

Propietat Tipus Necessari Descripció
firstName cadena No Nom de la persona.
lastName cadena Sí Nom de la persona.
email cadena Sí Adreça electrònica de la persona.
phoneNumber cadena No Número de telèfon de la persona.
  • Last updated on