Referencia: esquema de manifiesto para Microsoft Teams

El Teams describe cómo se integra la aplicación en el Microsoft Teams producto. El manifiesto debe cumplir con el esquema hospedado en https://developer.microsoft.com/json-schemas/teams/v1.11/MicrosoftTeams.schema.json . También se admiten las versiones anteriores 1.0, 1.1,..., y 1.11 (con "v1.x" en la dirección URL). Para obtener más información sobre los cambios realizados en cada versión, vea registro de cambios de manifiesto.

En el ejemplo de esquema siguiente se muestran todas las opciones de extensibilidad:

Manifiesto completo de ejemplo

{
  "$schema": "https://developer.microsoft.com/json-schemas/teams/v1.11/MicrosoftTeams.schema.json",
  "manifestVersion": "1.11",
  "version": "1.0.0",
  "id": "%MICROSOFT-APP-ID%",
  "packageName": "com.example.myapp",
  "localizationInfo": {
    "defaultLanguageTag": "en-us",
    "additionalLanguages": [
      {
        "languageTag": "es-es",
        "file": "en-us.json"
      }
    ]
  },
  "developer": {
    "name": "Publisher Name",
    "websiteUrl": "https://website.com/",
    "privacyUrl": "https://website.com/privacy",
    "termsOfUseUrl": "https://website.com/app-tos",
    "mpnId": "1234567890"
  },
  "name": {
    "short": "Name of your app (<=30 chars)",
    "full": "Full name of app, if longer than 30 characters (<=100 chars)"
  },
  "description": {
    "short": "Short description of your app (<= 80 chars)",
    "full": "Full description of your app (<= 4000 chars)"
  },
  "icons": {
    "outline": "A relative path to a transparent .png icon — 32px X 32px",
    "color": "A relative path to a full color .png icon — 192px X 192px"
  },
  "accentColor": "A valid HTML color code.",
  "configurableTabs": [
    {
      "configurationUrl": "https://contoso.com/teamstab/configure",
      "scopes": [
        "team",
        "groupchat"
      ],
      "canUpdateConfiguration": true,
      "context":[
        "channelTab",
        "privateChatTab",
        "meetingChatTab",
        "meetingDetailsTab",
        "meetingSidePanel",
        "meetingStage"
      ],
      "sharePointPreviewImage": "Relative path to a tab preview image for use in SharePoint — 1024px X 768",
      "supportedSharePointHosts": [
         "sharePointFullPage",
         "sharePointWebPart"
      ]
    }
  ],
  "staticTabs": [
    {
      "entityId": "unique Id for the page entity",
      "scopes": [
        "personal"
      ],
      "context":[
        "personalTab",
        "channelTab"
        ],
      "name": "Display name of tab",
      "contentUrl": "https://contoso.com/content (displayed in Teams canvas)",
      "websiteUrl": "https://contoso.com/content (displayed in web browser)",
       "searchUrl":  "https://contoso.com/content (displayed in web browser)"
    }
  ],
  "bots": [
    {
      "botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
      "scopes": [
        "team",
        "personal",
        "groupchat"
      ],
      "needsChannelSelector": false,
      "isNotificationOnly": false,
      "supportsFiles": true,
      "supportsCalling": false,
      "supportsVideo": true,
      "commandLists": [
        {
          "scopes": [
            "team",
            "groupchat"
          ],
          "commands": [
            {
              "title": "Command 1",
              "description": "Description of Command 1"
            },
            {
              "title": "Command 2",
              "description": "Description of Command 2"
            }
          ]
        },
        {
          "scopes": [
            "personal",
            "groupchat"
          ],
          "commands": [
            {
              "title": "Personal command 1",
              "description": "Description of Personal command 1"
            },
            {
              "title": "Personal command N",
              "description": "Description of Personal command N"
            }
          ]
        }
      ]
    }
  ],
  "connectors": [
    {
      "connectorId": "GUID-FROM-CONNECTOR-DEV-PORTAL%",
      "scopes": [
        "team"
      ],
      "configurationUrl": "https://contoso.com/teamsconnector/configure"
    }
  ],
  "composeExtensions": [
    {
      "canUpdateConfiguration": true,
      "botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
      "commands": [
        {
          "id": "exampleCmd1",
          "title": "Example Command",
          "type": "query",
          "context": [
            "compose",
            "commandBox"
          ],
          "description": "Command Description; e.g., Search on the web",
          "initialRun": true,
          "fetchTask": false,
          "parameters": [
            {
              "name": "keyword",
              "title": "Search keywords",
              "inputType": "text",
              "description": "Enter the keywords to search for",
              "value": "Initial value for the parameter",
              "choices": [
                {
                  "title": "Title of the choice",
                  "value": "Value of the choice"
                }
              ]
            }
          ]
        },
        {
          "id": "exampleCmd2",
          "title": "Example Command 2",
          "type": "action",
          "context": [
            "message"
          ],
          "description": "Command Description; e.g., Add a customer",
          "initialRun": true,
          "fetchTask": true,
          "parameters": [
            {
              "name": "custinfo",
              "title": "Customer name",
              "description": "Enter a customer name",
              "inputType": "text"
            }
          ]
        },
         {
          "id": "exampleCmd3",
          "title": "Example Command 3",
          "type": "action",
          "context": [
            "compose",
            "commandBox",
            "message"
          ],
          "description": "Command Description; e.g., Add a customer",
          "fetchTask": false,
          "taskInfo": {
            "title": "Initial dialog title",
            "width": "Dialog width",
            "height": "Dialog height",
            "url": "Initial webview URL"
          }
        }
      ],
      "messageHandlers": [
        {
          "type": "link",
          "value": {
            "domains": [
              "mysite.someplace.com",
              "othersite.someplace.com"
            ]
          }
        }
      ]
    }
  ],
"permissions": [
    "identity",
    "messageTeamMembers"
  ],
  "devicePermissions": [
    "geolocation",
    "media",
    "notifications",
    "midi",
    "openExternal"
  ],
  "validDomains": [
    "contoso.com",
    "mysite.someplace.com",
    "othersite.someplace.com"
  ],
  "webApplicationInfo": {
    "id": "AAD App ID",
    "resource": "Resource URL for acquiring auth token for SSO",
    "applicationPermissions": [
      "TeamSettings.Read.Group",
      "ChannelSettings.Read.Group",
      "ChannelSettings.Edit.Group",
      "Channel.Create.Group",
      "Channel.Delete.Group",
      "ChannelMessage.Read.Group",
      "TeamsApp.Read.Group",
      "TeamsTab.Read.Group",
      "TeamsTab.Create.Group",
      "TeamsTab.Edit.Group",
      "TeamsTab.Delete.Group",
      "Member.Read.Group",
      "Owner.Read.Group",
      "Member.ReadWrite.Group",
      "Owner.ReadWrite.Group"
    ]
  },
  "showLoadingIndicator": false,
  "isFullScreen": false,
  "activities": {
    "activityTypes": [
      {
        "type": "taskCreated",
        "description": "Task created activity",
        "templateText": "<team member> created task <taskId> for you"
      },
      {
        "type": "userMention",
        "description": "Personal mention activity",
        "templateText": "<team member> mentioned you"
      }
    ]
  },
  "defaultBlockUntilAdminAction": true,
  "publisherDocsUrl": "https://website.com/app-info",
  "defaultInstallScope": "meetings",
  "defaultGroupCapability": {
    "meetings": "tab", 
    "team": "bot", 
    "groupchat": "bot"
  },
 "configurableProperties": [
     "name",
     "shortDescription",
     "longDescription",
     "smallImageUrl", 
     "largeImageUrl", 
     "accentColor",
     "developerUrl",
     "privacyUrl",
     "termsOfUseUrl"        
 ],
  "subscriptionOffer": {
    "offerId": "publisherId.offerId"
  }
}

El esquema define las siguientes propiedades:

$schema

Cadena opcional, pero recomendada

La https:// url que hace referencia al esquema JSON para el manifiesto.

manifestVersion

Required—string

La versión del esquema de manifiesto que usa este manifiesto. Debe ser 1.10.

version

Required—string

La versión de una aplicación específica. Al actualizar algo en el manifiesto, la versión también debe incrementarse. De este modo, cuando se instala el nuevo manifiesto, se sobrescribe el existente y el usuario recibe la nueva funcionalidad. Cuando esta aplicación se envió a la tienda, el nuevo manifiesto debe volver a enviarse y revalidarse. Los usuarios de la aplicación reciben el nuevo manifiesto actualizado automáticamente en pocas horas después de que se apruebe el manifiesto.

Si cambian las solicitudes de permisos de la aplicación, se pedirá a los usuarios que actualicen y vuelvan a realizar la actualización a la aplicación.

Esta cadena de versión debe seguir el estándar de semver (MAJOR. MINOR. PATCH).

id

Obligatorio:Id. de aplicación de Microsoft

El identificador es un identificador único generado por Microsoft para la aplicación. Tienes un identificador si el bot está registrado a través del Microsoft Bot Framework. Tienes un identificador si la aplicación web de la pestaña ya inicia sesión con Microsoft. Debe escribir el identificador aquí. De lo contrario, debe generar un nuevo identificador en el Portal de registro de aplicaciones de Microsoft. Use el mismo identificador si agrega un bot.

developer

Required—object

Especifica información sobre su empresa. Para las aplicaciones enviadas a la Teams, estos valores deben coincidir con la información de la descripción de la tienda. Para obtener más información, consulte las Teams de publicación del almacén de almacenamiento.

name

Required—object

El nombre de la experiencia de la aplicación, que se muestra a los usuarios en la Teams usuario. Para las aplicaciones enviadas a AppSource, estos valores deben coincidir con la información de la entrada AppSource. Los valores de short y full deben ser diferentes.

description

Required—object

Describe la aplicación a los usuarios. Para las aplicaciones enviadas a AppSource, estos valores deben coincidir con la información de la entrada AppSource.

Asegúrese de que su descripción describe su experiencia y ayuda a los clientes potenciales a comprender lo que hace su experiencia. Debe tener en cuenta en la descripción completa, si se requiere una cuenta externa para su uso. Los valores de short y full deben ser diferentes. La descripción corta no se puede repetir dentro de la descripción larga y no debe incluir ningún otro nombre de aplicación.

packageName

Optional—string

Un identificador único para la aplicación en la notación de dominio inverso; por ejemplo, com.example.myapp. Longitud máxima: 64 caracteres.

localizationInfo

Opcional—object

Permite la especificación de un idioma predeterminado y proporciona punteros a más archivos de idioma. Para obtener más información, vea localización.

localizationInfo.additionalLanguages

Una matriz de objetos que especifica más traducciones de idioma.

iconos

Required—object

Iconos usados dentro de la Teams aplicación. Los archivos de icono deben incluirse como parte del paquete de carga. Para obtener más información, vea Iconos.

accentColor

Obligatorio:código de color Hexadecimal HTML

Color que se usará y como fondo para los iconos de esquema.

El valor debe ser un código de color HTML válido a partir de '#', por ejemplo #4464ee .

configurableTabs

Opcional—array

Se usa cuando la experiencia de la aplicación tiene una experiencia de pestaña de canal de grupo que requiere una configuración adicional antes de agregarla. Las pestañas configurables solo se admiten en los ámbitos and y team puede configurar las mismas groupchat pestañas varias veces. Sin embargo, solo puede definirlo en el manifiesto una vez.

staticTabs

Opcional—array

Define un conjunto de pestañas que se pueden "anclar" de forma predeterminada, sin que el usuario las agregue manualmente. Las pestañas estáticas declaradas en el ámbito siempre se anclan a la experiencia personal personal de la aplicación. Actualmente no se admiten las pestañas estáticas declaradas team en el ámbito.

Este elemento es una matriz (máximo de 16 elementos) con todos los elementos del tipo object . Este bloque solo es necesario para las soluciones que proporcionan una solución de tabulación estática.

bots

Opcional—array

Define una solución de bot, junto con información opcional, como las propiedades de comando predeterminadas.

El elemento es una matriz (máximo de un solo elemento actualmente solo se permite un bot por aplicación) con todos los — elementos del tipo object . Este bloque solo es necesario para las soluciones que proporcionan una experiencia de bot.

bots.commandLists

Una lista opcional de comandos que el bot puede recomendar a los usuarios. El objeto es una matriz (máximo de dos elementos) con todos los elementos de tipo; debe definir una lista de comandos independiente para cada ámbito object compatible con el bot. Para obtener más información, vea Menús bot.

bots.commandLists.commands

conectores

Opcional—array

El connectors bloque define un Office 365 connector para la aplicación.

El objeto es una matriz (máximo de un elemento) con todos los elementos de tipo object . Este bloque solo es necesario para las soluciones que proporcionan un conector.

composeExtensions

Opcional—array

Define una extensión de mensajería para la aplicación.

El elemento es una matriz (máximo de un elemento) con todos los elementos de tipo object . Este bloque solo es necesario para las soluciones que proporcionan una extensión de mensajería.

composeExtensions.commands

La extensión de mensajería debe declarar uno o más comandos con un máximo de 10 comandos. Cada comando aparece en Microsoft Teams como una interacción potencial desde el punto de entrada basado en la interfaz de usuario.

Cada elemento de comando es un objeto con la siguiente estructura:

permissions

Opcional:matriz de cadenas

Una matriz de , que especifica qué permisos solicita la aplicación, que permiten a los usuarios string finales saber cómo funciona la extensión. Las siguientes opciones no son exclusivas:

• identity Requiere información de identidad de usuario.
• messageTeamMembers Requiere permiso para enviar mensajes directos a los miembros del equipo.

Al cambiar estos permisos durante la actualización de la aplicación, los usuarios repiten el proceso de consentimiento después de ejecutar la aplicación actualizada. Para obtener más información, consulta Actualizar la aplicación.

devicePermissions

Opcional:matriz de cadenas

Proporciona las características nativas en el dispositivo de un usuario al que la aplicación solicita acceso. Las opciones son:

• geolocation
• media
• notifications
• midi
• openExternal

validDomains

Opcional, excepto Requerido cuando se indica.

Una lista de dominios válidos para sitios web que la aplicación espera cargar en el Teams cliente. Las listas de dominios pueden incluir caracteres comodín, por ejemplo, *.example.com . El dominio válido coincide exactamente con un segmento del dominio; si necesita hacer a.b.example.com coincidir, use *.*.example.com . Si la interfaz de usuario de contenido o configuración de pestañas navega a cualquier otro dominio que no sea la configuración de tabulación, este dominio debe especificarse aquí.

No incluyas los dominios de los proveedores de identidades que quieras admitir en la aplicación. Por ejemplo, para autenticar con un identificador de Google, es necesario redirigir a accounts.google.com, sin embargo, no debe incluir accounts.google.com en validDomains[] .

Teams aplicaciones que requieren que sus propias direcciones SHAREPOINT funcionen correctamente, incluye "{teamsitedomain}" en su lista de dominios válida.

El objeto es una matriz con todos los elementos del tipo string .

webApplicationInfo

Opcional—object

Proporcione su Azure Active Directory de aplicación (AAD) e información de Microsoft Graph para ayudar a los usuarios a iniciar sesión sin problemas en la aplicación. Si la aplicación está registrada en AAD, debes proporcionar el identificador de la aplicación. Los administradores pueden revisar fácilmente los permisos y conceder el consentimiento en Teams centro de administración.

showLoadingIndicator

Optional—boolean

Indica si se va a mostrar el indicador de carga cuando se carga una aplicación o una pestaña. El valor predeterminado es false.

isFullScreen

Optional—boolean

Indica dónde se representa una aplicación personal con o sin una barra de encabezado de pestaña. El valor predeterminado es false.

activities

Opcional—object

Define las propiedades que usa la aplicación para publicar una fuente de actividad de usuario.

activities.activityTypes

{
   "activities":{
      "activityTypes":[
         {
            "type":"taskCreated",
            "description":"Task Created Activity",
            "templateText":"{actor} created task {taskId} for you"
         },
         {
            "type":"teamMention",
            "description":"Team Mention Activity",
            "templateText":"{actor} mentioned team"
         },
         {
            "type":"channelMention",
            "description":"Channel Mention Activity",
            "templateText":"{actor} mentioned channel"
         },
         {
            "type":"userMention",
            "description":"Personal Mention Activity",
            "templateText":"{actor} mentioned user"
         },
         {
            "type":"calendarForward",
            "description":"Forwarding a Calendar Event",
            "templateText":"{actor} sent user an invite on behalf of {eventOwner}"
         },
         {
            "type":"calendarForward",
            "description":"Forwarding a Calendar Event",
            "templateText":"{actor} sent user an invite on behalf of {eventOwner}"
         },
         {
            "type":"creatorTaskCreated",
            "description":"Created Task Created",
            "templateText":"The Creator created task {taskId} for you"
         }
      ]
   }
}

defaultInstallScope

Opcional : cadena

Especifica el ámbito de instalación definido para esta aplicación de forma predeterminada. El ámbito definido será la opción que se muestra en el botón cuando un usuario intente agregar la aplicación. Las opciones son:

• personal
• team
• groupchat
• meetings

defaultGroupCapability

Opcional : objeto

Cuando se selecciona un ámbito de instalación de grupo, se definirá la funcionalidad predeterminada cuando el usuario instale la aplicación. Las opciones son:

• team
• groupchat
• meetings

configurableProperties

Opcional : matriz

El configurableProperties bloque define las propiedades de la aplicación que Teams los administradores pueden personalizar. Para obtener más información, consulta Habilitar la personalización de la aplicación. La característica de personalización de aplicaciones no se admite en aplicaciones personalizadas o lob.

Puede definir cualquiera de las siguientes propiedades:

• name: nombre para mostrar de la aplicación.
• shortDescription: descripción breve de la aplicación.
• longDescription: descripción larga de la aplicación.
• smallImageUrl: icono de esquema de la aplicación.
• largeImageUrl: icono de color de la aplicación.
• accentColor: color que se usará y un fondo para los iconos de esquema.
• developerUrl: la dirección URL HTTPS del sitio web del desarrollador.
• privacyUrl: la dirección URL HTTPS de la directiva de privacidad del desarrollador.
• termsOfUseUrl: la dirección URL HTTPS de los términos de uso del desarrollador.

defaultBlockUntilAdminAction

Optional—boolean

Cuando defaultBlockUntilAdminAction la propiedad se establece en true, la aplicación se oculta a los usuarios de forma predeterminada hasta que el administrador lo permita. Si se establece en true, la aplicación está oculta para todos los inquilinos y usuarios finales. Los administradores de inquilinos pueden ver la aplicación en el Teams de administración y realizar acciones para permitir o bloquear la aplicación. El valor predeterminado es False. Para obtener más información sobre el bloqueo de aplicaciones predeterminado, consulta Ocultar Teams aplicación hastaque el administrador apruebe .

publisherDocsUrl

Opcional : cadena

Tamaño máximo: 128 caracteres

La propiedad depende de defaultBlockUntilAdminAction . Cuando la propiedad se establece en true, la dirección URL HTTPS proporciona una página de información para que los administradores obtengan directrices antes de permitir una aplicación, que defaultBlockUntilAdminAction está bloqueada de forma publisherDocsUrl predeterminada.

subscriptionOffer

Opcional : objeto

Especifica la oferta SaaS asociada a la aplicación.

Vea también

• Comprender la estructura Microsoft Teams aplicación
• Habilitar la personalización de aplicaciones
• Localizar la aplicación
• Integrar capacidades multimedia
• Referencia de esquema de manifiesto de vista previa del desarrollador: Teams