Compartir a través de

Referencia del documento de envío del artículo del catálogo

  • Artículo

Debe incluir los datos en formato JSON cuando envíe un artículo al catálogo. En este artículo se describen las propiedades válidas de ese documento. Este JSON es un ejemplo:

{
  "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 tabla describe las propiedades del documento de envío:

Property Type Obligatorio Description
modelVersion string No Número de versión del documento de envío. El valor predeterminado es 1.0.0.0.
sourcePortal entero No Identifica el origen de esta solicitud. Adopta como predeterminado 526430005 que es la CLI de PAC. Para otras fuentes, utilice 526430000. La mspcat_GetPowerCatalogDetails función devuelve la lista completa. La mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions propiedad enumera las opciones disponibles.
submissionId guid No Guid para identificar el envío. Este valor es una clave externa para permitir vincular la solicitud a otros sistemas.
operation string Sí Para futuras ampliaciones y no se respeta en la actualidad. El tipo de operación que se va a usar. Los valores válidos son:
- CreateOrUpdate (valor predeterminado)
- Create
- Update
- Disabled
businessJustification string No Describe el valor comercial del envío al aprobador. Este valor puede contener HTML o formato de texto enriquecido (RTF). Esta información aparece en la experiencia de consumo planificada en la experiencia del usuario de detección del creador. Los usuarios pueden decir que su presentación ayuda a reducir costes o a aumentar la productividad, por ejemplo. Algunas organizaciones requieren ciertas clases de valor y esos valores se pueden ingresar aquí.
publisherDetails Publisher Sí El editor asociado con el envío de este elemento.
catalogItemDefinition CatalogItemDefinition Sí Define el elemento de catálogo que se va a enviar.

Publicador

Utilice estos datos para especificar la propiedad publisherDetails del elemento de envío del catálogo.

Crea un registro de editor que se puede asociar a uno o más grupos de Microsoft Entra ID que contienen usuarios autorizados que pueden realizar actualizaciones al elemento del catálogo en el futuro.

Nota

No confunda este término con Editor de soluciones. El editor de elementos del catálogo no se utiliza con soluciones.

Como mínimo debe proporcionar el publisherDisplayName. publisherId puede ser cualquier valor de cadena. El sistema verifica si ese editor existe, de lo contrario lo crea y le asigna un publisherId.

Por ejemplo, el equipo de desarrolladores de TI de RR. HH. puede crear un editor e identificar a los desarrolladores mediante un grupo de Microsoft Entra ID.

A continuación, se muestra un ejemplo de un registro de editor que incluye operaciones para agregar una persona y 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"
      }
   ]
}
Property Type Obligatorio Description
publisherId string Sí El ID exclusivo de este editor. Utilice este identificador para identificar a este editor cada vez que cree o actualice un elemento de catálogo para este editor. Los elementos del catálogo solo se pueden asociar a un editor a la vez. El valor puede ser un GUID o una cadena. Una vez configurado, debe mantenerse.
publisherDisplayName string Sí Los consumidores ven estos datos en la galería del catálogo.
publisherUpnList CatalogUPNOperation[] No Personas que pueden enviar nuevos artículos de catálogo o actualizarlos como este editor. Incluye siempre al usuario remitente la primera vez que se crea el editor.
publisherAADGroupOIDS CatalogGroupOperation[] No Grupos de ID de entrada cuyos miembros tienen permiso para acceder a este editor.

CatalogUPNOperation

Utilice estos datos para especificar la propiedad del editorpublisherUpnList .

Define una operación para añadir o eliminar personas que pueden enviar elementos de catálogo nuevos o actualizados como este editor.

Property Type Obligatorio Description
action string Sí La acción a realizar con este UPN. Valores aceptables: Add o Remove.
upn string Sí Nombre principal de usuario (UPN) del usuario.
userOid guid Sí Identificador de objeto para el usuario.

CatalogGroupOperation

Utilice estos datos para especificar la propiedad del editorpublisherAADGroupOIDS .

Define una operación para añadir o eliminar un grupo Entra ID que puede acceder a este editor.

Property Type Obligatorio Description
action string Sí La acción a realizar con este UPN. Valores aceptables: Add o Remove.
groupName string Sí Nombre del grupo.
groupOid guid Sí Identificador de objeto para el grupo.
groupType string Sí Tipo de grupo al que se dirige. Los valores aceptables son Security y Modern.

CatalogItemDefinition

Utilice estos datos para especificar la propiedad catalogItemDefinition del elemento de envío del catálogo.

Estas propiedades definen el elemento de catálogo que se envía. Esta es la solución real de la Power Platform. Un paquete es lo que se almacena en el catálogo.

Este es un ejemplo de un artículo del catálogo que incluye sus contactos engineeringName y supportName que son obligatorios.

"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"
   }
   }
}
Property Type Obligatorio Description
id guid Sí El identificador único del elemento de catálogo Utilice este identificador al actualizar o instalar el elemento del catálogo.
displayName string Sí Nombre que se muestra a los consumidores en las galerías del catálogo.
description string No Descripción que se muestra a los consumidores en las galerías del catálogo.
offer OfferDetails Sí Los detalles del envío del elemento del catálogo.
packageFile CatalogFileAsset Sí Describe dónde obtener el archivo de paquete de catálogo para el envío.

OfferDetails

Utilice estos datos para especificar la propiedad CatalogItemDefinitionoffer .

Estas propiedades definen los detalles del envío de elementos del catálogo.

Property Type Obligatorio Description
businessCategories int[] No Lista de valores de opciones de elección respetados por el catálogo de destino. Identifica las categorías de negocio que se van a asociar a este elemento del catálogo. Consulte Categorías de negocio para conocer los valores aceptables que debe utilizar.
type string Sí Tipo de elemento del catálogo. Los valores válidos son:
- Application
- Component_Collection
supportsApplicationTypes string[] No Lista de los tipos de aplicaciones compatibles. Los valores válidos son:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType string Sí Indica el tipo de despliegue para implementar este elemento del catálogo. Los valores válidos son:
- Normal representa un elemento gestionado.
- Template Una copia de la solución no administrada que otros creadores pueden editar como quieran.
Más información sobre los tipos de elementos del catálogo
searchKeywords string[] No Palabras que las personas pueden usar para encontrar este elemento del catálogo.
small48x48Image CatalogFileAsset No Imagen para la vista de galería. Si no proporciona esta imagen, se utilizará un icono predeterminado del sistema.
large216x216Image CatalogFileAsset No Imagen para vista de detalle. Proporcione un icono que se mostrará en el creador u otra interfaz de usuario de detección. Algunas experiencias de usuario usan iconos más grandes para representar tarjetas para la detección.
useCaseDocument CatalogFileAsset No Descripción del caso de uso y explicación a los aprobadores.
videos CatalogFileAsset[] No La vista de detalles muestra enlaces a estos archivos de vídeo/gif.
documents CatalogFileAsset[] No La vista de detalles muestra vínculos a estos archivos.
screenshots CatalogFileAsset[] No La vista de detalles muestra estas imágenes. Puede pasar aquí capturas de pantalla de su aplicación para ayudar a los creadores a identificar si esta aplicación proporciona la funcionalidad o capacidad que están buscando. Lo más común que hace la gente antes de descargar una aplicación o plantilla es mirar sus imágenes y capturas de pantalla para comprender sus capacidades en lugar de leer la descripción.
helpLink uri No Vínculo a la documentación Estas URL pueden ser enlaces a documentos internos o recursos de Sharepoint.
privacyPolicyLink uri No Vínculo al documento sobre privacidad. Directivas sobre el uso cuidadoso del componente o la aplicación que se envía.
legalTermsLink uri No Vínculo al documento de términos y condiciones. Cualquier término legal o guía interna para la evaluación del consumidor del artículo del catálogo.
legalTerms string No Markdown, HTML o versión de texto del documento de Términos y condiciones. Cualquier término legal o guía interna para la evaluación del consumidor del artículo del catálogo.
sourceCodeRepositoryLink uri No Vínculo al repositorio del código fuente
engineeringName PersonContactInformation Sí Información de contacto del ingeniero o grupo que desarrolló este elemento del catálogo.
supportName PersonContactInformation No Información de contacto del soporte o grupo que admite este artículo del catálogo. Puede ser el mismo que el contacto de ingeniería con el que el consumidor de un artículo del catálogo puede comunicarse si tiene problemas con la aplicación.

Categorías de negocio

Establezca la propiedad OfferDetailsbusinessCategories en una o varias de estas categorías de negocio:

Código Description
526430000 Customer Service
526430001 Administración del proyecto
526430002 Administración y programación de calendarios
526430003 Administración de correo electrónico
526430004 Archivos y documentación
526430005 Notificación y recordatorios
526430006 Análisis
526430007 Colaboración
526430008 Commerce
526430009 Finance
526430010 Cumplimiento y legal
526430011 Ventas
526430012 Herramientas de TI
526430013 Marketing
526430014 Operaciones y cadena de suministro
526430015 Internet de las cosas
526430016 Aprendizaje automático con IA
526430017 Geolocalización
526430018 Recursos humanos

Actualmente, no se pueden configurar nuevas categorías de negocio, pero se pueden obtener de la opción global Categoría de negocio del catálogo (mspcat_catalogbusinesscategory).

CatalogFileAsset

Estas propiedades definen un archivo al que se hace referencia en las propiedades CatalogItemDefinitionpackageFile y las propiedades OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documents y screenshots.

Property Type Obligatorio Description
name string Sí Nombre del archivo.
filesaslink uri Sí Vínculo para descargar el archivo. Si el enlace requiere autenticación, proporcione una firma de acceso compartido (SAS) URL.

PersonContactInformation

Estas propiedades definen a las personas en las propiedades del elemento de catálogo OfferDetailsengineeringName y supportName.

Property Type Obligatorio Description
firstName string No Nombre de pila de la persona.
lastName string Sí Apellidos de la persona
email string Sí Dirección de correo electrónico personal
phoneNumber string No Número de teléfono particular.