Referencia: esquema de manifiesto para Microsoft Teams

• 12/02/2020
• Tiempo de lectura: 14 minutos
• • 
  • 

El manifiesto de Microsoft Teams describe cómo se integra la aplicación en el producto de Microsoft Teams. El manifiesto debe cumplir el esquema hospedado en https://developer.microsoft.com/json-schemas/teams/v1.5/MicrosoftTeams.schema.json. También se admiten las versiones anteriores 1.0-1.4 (mediante "v1. x" en la dirección URL).

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

Manifiesto completo de ejemplo

{
  "$schema": "https://developer.microsoft.com/json-schemas/teams/v1.5/MicrosoftTeams.schema.json",
  "manifestVersion": "1.5",
  "version": "1.0.0",
  "id": "%MICROSOFT-APP-ID%",
  "packageName": "com.example.myapp",
  "devicePermissions" : [ "geolocation", "media" ],
  "developer": {
    "name": "Publisher Name",
    "websiteUrl": "https://website.com/",
    "privacyUrl": "https://website.com/privacy",
    "termsOfUseUrl": "https://website.com/app-tos",
    "mpnId": "1234567890"
  },
  "localizationInfo": {
    "defaultLanguageTag": "en-us",
    "additionalLanguages": [
      {
        "languageTag": "es-es",
        "file": "en-us.json"
      }
    ]
  },
  "name": {
    "short": "Name of your app (<=30 chars)",
    "full": "Full name of app, if longer than 30 characters"
  },
  "description": {
    "short": "Short description of your app",
    "full": "Full description of your app"
  },
  "icons": {
    "outline": "%FILENAME-32x32px%",
    "color": "%FILENAME-192x192px"
  },
  "accentColor": "%HEX-COLOR%",
  "configurableTabs": [
    {
      "configurationUrl": "https://contoso.com/teamstab/configure",
      "canUpdateConfiguration": true,
      "scopes": [ "team", "groupchat" ]
    }
  ],
  "staticTabs": [
    {
      "entityId": "idForPage",
      "name": "Display name of tab",
      "contentUrl": "https://contoso.com/content?host=msteams",
      "websiteUrl": "https://contoso.com/content",
      "scopes": [ "personal" ]
    }
  ],
  "bots": [
    {
      "botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
      "needsChannelSelector": false,
      "isNotificationOnly": false,
      "scopes": [ "team", "personal", "groupchat" ],
      "supportsFiles": true,
      "commandLists": [
        {
          "scopes": [ "team", "groupchat" ],
          "commands": [
            {
              "title": "Command 1",
              "description": "Description of Command 1"
            },
            {
              "title": "Command N",
              "description": "Description of Command N"
            }
          ]
        },
        {
          "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%",
      "configurationUrl": "https://contoso.com/teamsconnector/configure",
      "scopes": [ "team"]
    }
  ],
  "composeExtensions": [
    {
      "botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
      "canUpdateConfiguration": true,
      "commands": [
        {
          "id": "exampleCmd1",
          "title": "Example Command",
          "description": "Command Description; e.g., Search on the web",
          "initialRun": true,
          "type" : "search",
          "context" : ["compose", "commandBox"],
          "parameters": [
            {
              "name": "keyword",
              "title": "Search keywords",
              "description": "Enter the keywords to search for"
            }
          ]
        },
        {
          "id": "exampleCmd2",
          "title": "Example Command 2",
          "description": "Command Description; e.g., Search for a customer",
          "initialRun": true,
          "type" : "action",
          "fetchTask" : true,
          "context" : ["message"],
          "parameters": [
            {
              "name": "custinfo",
              "title": "Customer name",
              "description": "Enter a customer name",
              "inputType" : "text"
            }
          ]
        }
      ],
      "messageHandlers": [
        {
          "type" : "link",
          "value" : {
            "domains" : [
              "mysite.someplace.com",
              "othersite.someplace.com"
            ]
          }
        }
      ]
    }
  ],
  "permissions": [
    "identity",
    "messageTeamMembers"
  ],
  "validDomains": [
     "contoso.com",
     "mysite.someplace.com",
     "othersite.someplace.com"
  ]
}

El esquema define las siguientes propiedades:

$schema

Opcional, pero – la cadena recomendada

La dirección URL de https://que hace referencia al esquema JSON del manifiesto.

manifestVersion

String requerida –

La versión del esquema del manifiesto que está usando este manifiesto. Debe ser "1,5".

version

String requerida –

La versión de la aplicación específica. Si actualiza algo en el manifiesto, la versión también debe incrementarse. De este modo, cuando se instale el nuevo manifiesto, se sobrescribirá el anterior y el usuario podrá disfrutar de las funciones nuevas. Si esta aplicación se envió a la tienda, el nuevo manifiesto tendrá que volver a enviarse y a validarse. A continuación, los usuarios de esta aplicación recibirán el nuevo manifiesto actualizado automáticamente en unas pocas horas, después de que se apruebe.

Si la aplicación ha solicitado un cambio de permisos, se pedirá a los usuarios que actualicen y vuelvan a dar su consentimiento a la aplicación.

Esta cadena de versión debe seguir el estándar SemVer (Major. Secundaria. REVISIÓN).

id

Identificador de aplicación de Microsoft necesario –

El identificador único generado por Microsoft para esta aplicación. Si ha registrado un bot a través de Microsoft bot Framework o la aplicación Web de su pestaña ya inicia sesión en Microsoft, debe tener ya un identificador y escribirlo aquí. De lo contrario, debe generar un nuevo identificador en el portal de registro de aplicaciones de Microsoft (mis aplicaciones), escribirlo aquí y volver a usarlo cuando agregue un bot. Nota: Si va a enviar una actualización a su aplicación existente en AppSource, el identificador del manifiesto no debe modificarse.

packageName

String requerida –

Un identificador único para esta aplicación en la notación de dominio inverso; por ejemplo, com. example. myapp.

developer

Required

Especifica información sobre la compañía. Para las aplicaciones enviadas a AppSource (anteriormente tienda Office), estos valores deben coincidir con la información de la entrada AppSource. Consulte nuestras directrices de publicación para obtener más información.

localizationInfo

Optional

Permite la especificación de un idioma predeterminado, así como punteros a archivos de idioma adicionales. Consulte localización.

localizationInfo.additionalLanguages

Una matriz de objetos que especifica traducciones de idioma adicionales.

name

Required

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

description

Required

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 la descripción describe con precisión su experiencia y proporciona información para ayudar a los clientes potenciales a comprender lo que hace su experiencia. También debe tener en cuenta, en la descripción completa, si se requiere uso de una cuenta externa. Los valores de short y full no deben ser iguales. La descripción breve no debe repetirse en la descripción larga y no debe incluir ningún otro nombre de aplicación.

iconos

Required

Iconos usados en la aplicación Microsoft Teams. Los archivos de icono deben incluirse como parte del paquete de carga. Vea iconos para obtener más información.

accentColor

String requerida –

Color que se va a usar junto con y como fondo de los iconos de esquema.

El valor debe ser un código de color HTML válido que empiece por ' # ', #4464eepor ejemplo.

configurableTabs

Optional

Se usa cuando la experiencia de la aplicación tiene una experiencia de la pestaña de canal de equipo que requiere una configuración adicional antes de que se agregue. Las pestañas configurables solo se admiten en el ámbito de Teams y actualmente solo se admite una pestaña por aplicación.

El objeto es una matriz con todos los elementos del tipo object. Este bloque solo es necesario para las soluciones que proporcionan una solución de ficha de canal configurable.

staticTabs

Optional

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 personal el ámbito siempre están ancladas a la experiencia personal de la aplicación. Actualmente no se admiten team las pestañas estáticas declaradas en el ámbito.

El objeto es una matriz (un máximo de 16 elementos) con todos los elementos del objecttipo. Este bloque solo es necesario para las soluciones que proporcionan una solución de pestaña estática.

transferido

Optional

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

El objeto es una matriz (un máximo de solo 1—elemento solo es posible para cada 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 (un máximo de 2 elementos) con todos los elementos objectde tipo; debe definir una lista de comandos independiente para cada ámbito que admita el bot. Consulte menús de bot para obtener más información.

Connector

Optional

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

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

composeExtensions

Optional

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

El objeto es una matriz (un máximo de 1 elemento) con todos los elementos objectde tipo. 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. Cada comando aparece en Microsoft Teams como una posible interacción desde el punto de entrada basado en la interfaz de usuario. Hay un máximo de 10 comandos.

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

permissions

Optional

Una matriz de string que especifica los permisos que solicita la aplicación, lo que permite a los usuarios finales saber cómo se realizará la extensión. Las siguientes opciones no son exclusivas:

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

Cambiar estos permisos al actualizar la aplicación hará que los usuarios repitan el proceso de consentimiento la primera vez que ejecuten la aplicación actualizada. Consulte actualizar la aplicación para obtener más información.

devicePermissions

Opcional Matriz de cadenas

Especifica las características nativas del dispositivo de un usuario al que la aplicación puede solicitar acceso. Las opciones son:

• geolocation
• media
• notifications
• midi
• openExternal

validDomains

Opcional, excepto obligatorio donde se indica

Una lista de dominios válidos para los sitios web que la aplicación espera que se carguen dentro del cliente de Teams. Las listas de dominios pueden incluir caracteres comodín, por *.example.comejemplo. Esto coincide exactamente con un segmento del dominio; Si tiene que hacer coincidir a.b.example.com , *.*.example.comuse. Si la configuración de la pestaña o la interfaz de usuario de contenido debe navegar a cualquier otro dominio además del uso de la configuración de pestañas, dicho dominio debe especificarse aquí.

No obstante, no es necesario incluir los dominios de los proveedores de identidades que desea admitir en la aplicación. Por ejemplo, para autenticarse con un identificador de Google, es necesario redirigir a accounts.google.com, pero no se debe incluir accounts.google.com en validDomains[].

Las aplicaciones de Microsoft teams que requieren sus propias direcciones URL de SharePoint para que funcionen correctamente pueden incluir "{teamsitedomain}" en su lista de dominios válidos.

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

webApplicationInfo

Optional

Especifique la información del grafo y el identificador de la aplicación de AAD para ayudar a los usuarios a iniciar sesión sin problemas en su aplicación de AAD.