Compartir por

Referencia do documento de envío de elementos do catálogo

Debe incluír datos en formato JSON cando envíe un elemento ao catálogo. Este artigo describe as propiedades válidas para este documento. Este JSON é un exemplo:

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

Esta táboa describe as propiedades do documento de envío:

Propiedade Tipo Obrigatorio Descrición
modelVersion cadea Non Número de versión do documento de envío. O valor predeterminado é 1.0.0.0.
sourcePortal ent Non Identifica a orixe desta solicitude. O valor predeterminado é 526430005 o PAC CLI. Para outras fontes, use 526430000. A mspcat_GetPowerCatalogDetails función devolve a lista completa. Na propiedade mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions aparecen as opcións dispoñibles.
submissionId guid Non Identificación da presentación. Este valor é unha clave estranxeira para permitir vincular a solicitude a outros sistemas.
operation cadea Si Para a futura expansión e actualmente non se respecta. O tipo de operación que se vai utilizar. Valores válidos:
- CreateOrUpdate (Por defecto)
- Create
- Update
- Disabled
businessJustification cadea Non Describe o valor empresarial da presentación ao aprobador. Este valor pode conter HTML ou formato de texto enriquecido (RTF). Esta información aparece na experiencia de consumo planificado na experiencia de usuario de descubrimento do fabricante. Os usuarios poden dicir que o seu envío axuda á redución de custos ou produtividade, por exemplo. Algunhas organizacións requiren certas clases de valor e estes valores pódense introducir aquí.
publisherDetails Editorial Si O editor asociado a este envío de elementos.
catalogItemDefinition CatalogItemDefinition Si Define o elemento do catálogo que se envía.

Editor

Use estes datos para especificar a propiedade do elemento publisherDetails de envío do catálogo.

Crea un rexistro de editor que se pode asociar a un ou máis grupos de ID de Microsoft Entra que conteñen usuarios autorizados que poden facer actualizacións no elemento do catálogo no futuro.

Nota

Non confundir este termo con Solution Publisher. O editor de elementos de catálogo non se usa con solucións.

Hai que proporcionar o publisherDisplayName mínimo. publisherId Pode ser calquera valor de cadea. O sistema comproba se ese editor existe, senón créao e asigna un publisherId.

Por exemplo, o equipo de desenvolvedores de TI de recursos humanos pode crear un editor e identificar aos desenvolvedores usando un grupo de ID de Microsoft Entra.

Aquí tes unha mostra dun rexistro de editor que inclúe operacións para engadir unha persoa e un grupo de ID de Entra

{
   "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"
      }
   ]
}
Propiedade Tipo Obrigatorio Descrición
publisherId cadea Si O ID único desta editorial. Use este ID para identificar este editor cada vez que estea creando ou actualizando un elemento de catálogo para este editor. Os elementos do catálogo só se poden asociar a un editor á vez. O valor pode ser un GUID ou unha cadea. Unha vez establecido, debe manterse.
publisherDisplayName cadea Si Os consumidores poden ver estes datos na galería do catálogo.
publisherUpnList CatalogUPNOperation[editar | editar a fonte] Non Persoas que poden enviar elementos de catálogo novos ou actualizados como este editor. Sempre inclúe o usuario que envía a primeira vez que se crea o Publisher.
publisherAADGroupOIDS CatalogGroupOperation[editar | editar a fonte] Non Entra ID Grupos cuxos membros están autorizados a acceder a este editor.

CatalogUPNOperation

Use estes datos para especificar a propiedade PublisherpublisherUpnList .

Define unha operación para engadir ou eliminar persoas que poden enviar novos ou actualizar elementos do catálogo como este editor.

Propiedade Tipo Obrigatorio Descrición
action cadea Si As accións a tomar con este UPN. Valores válidos: Add ou Remove.
upn cadea Si Nome principal de usuario (UPN) do usuario.
userOid guid Si Identificador de obxecto para o usuario.

CatalogGroupOperation

Use estes datos para especificar a propiedade PublisherpublisherAADGroupOIDS .

Define unha operación para engadir ou eliminar un grupo de ID de Entra que poida acceder a este editor.

Propiedade Tipo Obrigatorio Descrición
action cadea Si As accións a tomar con este UPN. Valores válidos: Add ou Remove.
groupName cadea Si Nome do grupo.
groupOid guid Si Identificador de obxecto para o grupo.
groupType cadea Si Tipo de grupo ao que se aborda. Os valores válidos son Security e Modern.

CatalogItemDefinition

Use estes datos para especificar a propiedade do elemento catalogItemDefinition de envío do catálogo.

Estas propiedades definen o elemento do catálogo que se envía. Esta é a solución real de Power Platform. Un paquete é o que se almacena no catálogo.

Aquí tes un exemplo dun elemento de catálogo que inclúe os seus engineeringNamesupportName contactos que son obrigatorios.

"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"
   }
   }
}
Propiedade Tipo Obrigatorio Descrición
id guid Si O ID único do elemento do catálogo. Empregue este ID ao actualizar ou instalar o elemento do catálogo.
displayName cadea Si Nome que se mostra aos consumidores nas galerías do catálogo.
description cadea Non Descrición mostrada aos consumidores nas galerías do catálogo.
offer Detalles da oferta Si Os detalles do envío do elemento do catálogo.
packageFile FicheiroCatálogo Si Describe onde obter o ficheiro do paquete de catálogo para o envío.

Detalles da oferta

Use estes datos para especificar a propiedade CatalogItemDefinitionoffer .

Estas propiedades definen os detalles do envío do elemento do catálogo.

Propiedade Tipo Obrigatorio Descrición
businessCategories int[editar | editar a fonte] Non Lista de valores de opcións de elección respectados polo catálogo de destino. Identifica as categorías de negocio que se van asociar a este elemento do catálogo. Vexa as categorías de negocio para obter os valores válidos a usar.
type cadea Si Tipo de elemento do catálogo. Valores válidos:
- Application
- Component_Collection
supportsApplicationTypes corda[editar | editar a fonte] Non Lista dos tipos de aplicacións soportadas. Valores válidos:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType cadea Si Indica o tipo de despregamento para despregar este elemento do catálogo. Valores válidos:
- Normal Representa un elemento xestionado.
- Template Unha copia da túa solución non xestionada que outros creadores poden editar como queiran.
Máis información sobre os tipos de elementos do catálogo
searchKeywords corda[editar | editar a fonte] Non Palabras que a xente pode usar para atopar este elemento do catálogo.
small48x48Image FicheiroCatálogo Non Imaxe para a vista da galería. Se non proporciona esta imaxe, utilízase unha icona predeterminada do sistema.
large216x216Image FicheiroCatálogo Non Imaxe para a vista de detalle. Proporciona unha icona para que se mostre no creador ou noutra interface de descubrimento. Algunhas experiencias de usuario usan iconas máis grandes para renderizar tarxetas para o descubrimento.
useCaseDocument FicheiroCatálogo Non Descrición do caso de uso e explicación para os aprobadores.
videos CatalogFileAsset[] Non A vista de detalles mostra ligazóns a estes ficheiros de vídeo/GIF.
documents CatalogFileAsset[] Non A vista de detalles mostra ligazóns a estes ficheiros.
screenshots CatalogFileAsset[] Non A vista de detalle mostra estas imaxes. Podes pasar capturas de pantalla aquí da túa aplicación para axudar aos creadores a identificar se esta aplicación ofrece a funcionalidade ou a capacidade que están a buscar. O máis común que a xente fai antes de descargar unha aplicación ou modelo é mirar as súas imaxes e capturas de pantalla para comprender as capacidades en lugar de ler a descrición.
helpLink URI Non Enlace á documentación. Estes URL poden ser ligazóns a documentos internos ou recursos de sharepoint.
privacyPolicyLink URI Non Enlace ao documento de privacidade. Políticas sobre o uso coidadoso do compoñente ou aplicación que se presenta.
legalTermsLink URI Non Enlace ao documento de Termos e Condicións. Calquera termo legal ou orientación interna para a avaliación do consumidor do artigo do catálogo.
legalTerms cadea Non Markdown, HTML ou versión de texto do documento Termos e Condicións. Calquera termo legal ou orientación interna para a avaliación do consumidor do artigo do catálogo.
sourceCodeRepositoryLink URI Non Ligazón ao repositorio de código fonte
engineeringName PersoaInformación de contacto Si Información de contacto do enxeñeiro ou grupo que desenvolveu este elemento do catálogo.
supportName PersoaInformación de contacto Non Información de contacto para o soporte ou grupo que soporta este elemento do catálogo. Pode ser o mesmo que o contacto de enxeñaría ao que o consumidor dun artigo de catálogo pode contactar se atopa problemas coa aplicación.

Categorías empresariais

Establece a propiedade OfferDetailsbusinessCategories nunha ou varias destas categorías de negocios:

Código Descrición
526430000 Servizo de atención ao cliente
526430001 Xestión de proxectos
526430002 Xestión e planificación do calendario
526430003 Xestión de correo electrónico
526430004 Ficheiros e documentación
526430005 & Recordatorios de notificacións
526430006 Analytics
526430007 Colaboración
526430008 Comercio
526430009 Finanzas
526430010 Cumprimento e legal
526430011 Sales
526430012 Ferramentas informáticas
526430013 Marketing
526430014 Operacións e cadea de subministración
526430015 Internet das cousas
526430016 Aprendizaxe automática de IA
526430017 Xeolocalización
526430018 Recursos humanos

Actualmente, non se poden configurar novas categorías de negocios, pero pódense recuperar desde a opción global Categoría de negocio do catálogo (mspcat_catalogbusinesscategory).

FicheiroCatálogo

Estas propiedades definen un ficheiro ao que se fai referencia en CatalogItemDefinitionpackageFile e nas propiedades OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentse screenshots .

Propiedade Tipo Obrigatorio Descrición
name cadea Si Nome do ficheiro.
filesaslink URI Si Enlace para descargar o arquivo. Se a ligazón require autenticación, proporcione un URL de sinatura de acceso compartido (SAS).

PersoaInformación de contacto

Estas propiedades definen as persoas no elemento de catálogo OfferDetailsengineeringName e propiedades supportName .

Propiedade Tipo Obrigatorio Descrición
firstName cadea Non Nome da persoa.
lastName cadea Si Nome da persoa.
email cadea Si Enderezo de correo electrónico da persoa.
phoneNumber cadea Non Número de teléfono da persoa.
  • Last updated on