Partilhar via


Manifesto da aplicação de pré-visualização do programador público

Para obter informações sobre como habilitar o Developer Preview, confira Developer Preview público para Microsoft Teams.

Observação

Se não estiver a utilizar funcionalidades de pré-visualização para programadores, incluindo a execução de separadores pessoais do Teams e extensões de mensagens no Outlook e na aplicação Microsoft 365, utilize o manifesto da aplicação (anteriormente denominado manifesto da aplicação Teams) para funcionalidades de disponibilidade geral (GA).

O manifesto da aplicação descreve como a aplicação se integra na plataforma do Microsoft Teams. O manifesto do seu aplicativo deve estar em conformidade com o esquema hospedado em https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json.

Manifesto de aplicação de exemplo

{
    "$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json",
    "manifestVersion": "devPreview",
    "version": "1.0.0",
    "id": "%MICROSOFT-APP-ID%",
    "devicePermissions": [
        "geolocation",
        "media"
    ],
    "developer": {
        "name": "Publisher Name",
        "websiteUrl": "https://example.com/",
        "privacyUrl": "https://example.com/privacy",
        "termsOfUseUrl": "https://example.com/app-tos",
        "mpnId": "1234567890"
    },
    "localizationInfo": {
        "defaultLanguageTag": "en",
        "defaultLanguageFile": "en.json",
        "additionalLanguages": [
            {
                "languageTag": "es",
                "file": "es.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",
        "color32x32": "%FILENAME-32x32px%"
    },
    "accentColor": "%HEX-COLOR%",
    "elementRelationshipSet": {
      "oneWayDependencies" : [
        {
          "element" : {
            "name" : "composeExtensions",
            "id" : "composeExtension-id",
            "commandIds": ["exampleCmd1", "exampleCmd2"]
          },
          "dependsOn" : [
              {"name" : "bots", "id" : "bot-id"}
          ]
        }
      ],
      "mutualDependencies" : [
        [
                {"name" : "bots", "id" : "bot-id"}, 
                {"name" : "staticTabs", "id" : "staticTab-id"},
                {"name" : "composeExtensions", "id" : "composeExtension-id"},
                {"name" : "configurableTabs", "id": "configurableTab-id"}
        ]
      ],
    "copilotAgents": {
        "declarativeAgents": [
            {
                "id": "agent1",
                "file": "declarativeAgent1.json"
            }
        ]
    },
    "configurableTabs": [
        {
            "id": "configurableTab-id",
            "configurationUrl": "https://contoso.com/teamstab/configure",
            "canUpdateConfiguration": true,
            "scopes": [
                "team",
                "groupChat"
            ],
            "context": []
        }
    ],
    "staticTabs": [
        {
            "entityId": "idForPage",
            "name": "Display name of tab",
            "contentUrl": "https://contoso.com/content?host=msteams",
            "contentBotId": "Specifies to the app that tab is an Adaptive Card Tab. You can either provide the contentBotId or contentUrl.",
            "websiteUrl": "https://contoso.com/content",
            "scopes": [
                "personal"
            ],
            "requirementSet": {
                "hostMustSupportFunctionalities": [
                  {"name": "dialogUrl"},
                  {"name": "dialogUrlBot"}
                ]
            }
        }
    ],
    "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"
                        }
                    ]
                }
            ],
            "requirementSet": {
                "hostMustSupportFunctionalities": [
                  {"name": "dialogUrl"},
                  {"name": "dialogUrlBot"}
                ]
            }
        }
    ],
    "connectors": [
        {
            "connectorId": "GUID-FROM-CONNECTOR-DEV-PORTAL%",
            "configurationUrl": "https://contoso.com/teamsconnector/configure",
            "scopes": [
                "team"
            ]
        }
    ],
    "composeExtensions": [
        {
            "botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
            "id": "composeExtension-id",
            "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"
                        }
                    ]
                },
                {
                    "id": "exampleMessageHandler",
                    "title": "Message Handler",
                    "description": "Domains that will create a preview when pasted into the compose box",
                    "messageHandlers": [
                        {
                            "type": "link",
                            "value": {
                                "domains": [
                                    "mysite.someplace.com",
                                    "othersite.someplace.com"
                                ]
                            }
                        }
                    ]
                }
            ],
            "requirementSet": {
                "hostMustSupportFunctionalities": [
                  {"name": "dialogUrl"},
                  {"name": "dialogUrlBot"}
                ]
            }
        }
    ],
    "permissions": [
        "identity",
        "messageTeamMembers"
    ],
    "validDomains": [
        "contoso.com",
        "mysite.someplace.com",
        "othersite.someplace.com"
    ],
    "webApplicationInfo": {
        "id": "AAD App ID",
        "resource": "Resource URL for acquiring auth token for SSO"
    },
    "showLoadingIndicator": false,
    "isFullScreen": false,
    "defaultBlockUntilAdminAction": false,
    "publisherDocsUrl": "https://contoso.com/teamtabapp/admin-doc",
    "scopeConstraints": { 
        "teams": [ 
            { "id": "%TEAMS-THREAD-ID" } 
        ], 
        "groupChats": [ 
          { "id": "%GROUP-CHATS-THREAD-ID" } 
        ] 
    },    
    "authorization": {
        "permissions": {
            "resourceSpecific": [
                {
                    "type": "Application",
                    "name": "ChannelSettings.Read.Group"
                },
                {
                    "type": "Delegated",
                    "name": "ChannelMeetingParticipant.Read.Group"
                }
            ]
        }
    },
"actions": [
    {
      "id": "addTodoTask",
      "displayName": "Add ToDo task",
      "intent": "addTo",
      "description": "Add this file with a short note to my to do list",
      "handlers": [
        {
          "type": "openPage",
          "supportedObjects": {
            "file": {
              "extensions": [
                "doc",
                "pdf"
              ]
            }
          },
          "pageInfo": {
            "pageId": "newTaskPage",
            "subPageId": ""
          }
        }
      ]
    },
  ],
    "configurableProperties": [
        "name",
        "shortDescription",
        "longDescription",
        "smallImageUrl",
        "largeImageUrl",
        "accentColor",
        "developerUrl",
        "privacyUrl",
        "termsOfUseUrl"
    ],
    "supportedChannelTypes": [
        "sharedChannels",
        "privateChannels"
    ],
    "defaultInstallScope": "meetings",
    "defaultGroupCapability": {
        "meetings": "tab",
        "team": "bot",
        "groupchat": "bot"
    },
    "subscriptionOffer": {
        "offerId": "publisherId.offerId"
    },
    "meetingExtensionDefinition": {
        "scenes": [
            {
                "id": "9082c811-7e6a-4174-8173-6ccd57d377e6",
                "name": "Getting started sample",
                "file": "scenes/sceneMetadata.json",
                "preview": "scenes/scenePreview.png",
                "maxAudience": 15,
                "seatsReservedForOrganizersOrPresenters": 0
            },
            {
                "id": "afeaed22-f89b-48e1-98b4-46a514344e4a",
                "name": "Sample-1",
                "file": "scenes/sceneMetadata.json",
                "preview": "scenes/scenePreview.png",
                "maxAudience": 15,
                "seatsReservedForOrganizersOrPresenters": 3
            }
        ]
    }
}

O esquema define as seguintes propriedades:

$esquema

Opcional (mas recomendado) – Cadeia

O URL https:// que referencia o Esquema JSON do manifesto da aplicação.

manifestVersion

Necessário – Cadeia

A versão do esquema de manifesto da aplicação que este manifesto está a utilizar.

versão

Necessário – Cadeia

A versão da aplicação específica. Se atualizar algo no manifesto da aplicação, a versão também tem de ser incrementada. Desta forma, quando o novo manifesto de aplicação é instalado, substitui o existente e o utilizador obtém a nova funcionalidade. Se esta aplicação tiver sido submetida para a Microsoft Teams Store, o novo manifesto de aplicação tem de ser novamente submetido e revogado. Em seguida, os utilizadores desta aplicação recebem automaticamente o novo manifesto da aplicação atualizado dentro de algumas horas, após a aprovação.

Se as permissões pedidas da aplicação forem alteradas, é pedido aos utilizadores que atualizem e reinsintam na aplicação.

Esta cadeia de caracteres da versão deve seguir o padrão semver (MAJOR.MINOR.PATCH).

Observação

Se a sua aplicação incluir um Suplemento do Office, cada segmento da cadeia de versão está limitado a um máximo de cinco dígitos. As extensões de cadeia de versão de pré-lançamento e de metadados do semver standard não são suportadas.

id

Necessário – ID da aplicação Microsoft

O identificador exclusivo gerado pela Microsoft para esse aplicativo. O formato do ID é GUID. Se registou um bot através de Microsoft Bot Framework ou a aplicação Web do separador já inicia sessão na Microsoft, é possível que já tenha um ID e tenha de introduzi-lo aqui. Caso contrário, tem de gerar um novo ID no Portal de Registo de Aplicações da Microsoft (As Minhas Aplicações), introduzi-lo aqui e, em seguida, reutilizá-lo quando adicionar um bot.

developer

Necessário – Objeto

Especifica informações sobre o programador e a respetiva empresa. Para aplicações da Loja Teams, o valor tem de corresponder aos valores que fornecer no formulário de submissão de aplicações do Centro de Parceiros.

Nome Tipo Tamanho máximo Obrigatório Descrição
name Cadeia de caracteres 32 caracteres ✔️ O nome de exibição do desenvolvedor.
websiteUrl Cadeia de caracteres 2048 caracteres ✔️ A https:// URL para a página específica da aplicação no seu site.
privacyUrl Cadeia de caracteres 2048 caracteres ✔️ O https:// URL para a política de privacidade da aplicação.
termsOfUseUrl Cadeia de caracteres 2048 caracteres ✔️ O https:// URL para os termos de utilização da aplicação.
mpnId Cadeia de caracteres 10 caracteres O ID do Programa de Parceiros da Cloud da Microsoft (CCP) (anteriormente conhecido como ID do Microsoft Partner Network (MPN) que identifica a organização parceira que está a criar a aplicação. Opcional
contactInfo Objeto Informações de contacto do programador de aplicações.

developer.contactInfo

Opcional – Objeto

As suas informações de contacto utilizadas pelos clientes para contactá-lo através de chat ou e-mail do Teams. Os clientes podem precisar de informações adicionais ao avaliar a sua aplicação ou se tiverem alguma consulta sobre a sua aplicação quando esta não funcionar. Os clientes podem contactá-lo através do chat do Teams, pelo que pedem aos administradores de TI que ativem as comunicações externas na sua organização. Para obter mais informações, veja informações de contacto e aplicações fornecidas pelo programador.

Observação

Só tem de fornecer um endereço de e-mail de contacto.

Recomendamos que triaging your customer queries in timely manner and route those internally within your organization, say to other functions to get the answers. Ajuda a melhorar a adoção de aplicações, cria confiança do programador e aumenta as receitas se rentabilizar a aplicação.

Nome Tipo Tamanho máximo Obrigatório Descrição
defaultsupport Objeto ✔️ As informações de contacto predefinidas da sua aplicação.
defaultsupport.userEmailsForChatSupport Matriz 10 ✔️ Email endereço para receber consultas do cliente através do chat do Teams. Embora o manifesto da aplicação permita até 10 endereços de e-mail, o Teams utiliza apenas o primeiro endereço de e-mail para permitir que os administradores de TI comuniquem consigo. O objeto é uma matriz com todos os elementos da cadeia de tipo. O comprimento máximo do e-mail é de 80 carateres.
defaultsupport.emailsForEmailSupport Matriz 1 ✔️ Contacte o e-mail para consulta do cliente (Mínimo: 1; máximo: 1). O objeto é uma matriz com todos os elementos da cadeia de tipo. O comprimento máximo do e-mail é de 80 carateres.

localizationInfo

Opcional – Objeto

Permite a especificação de um idioma predefinido e aponta para ficheiros de idioma adicionais. Consulte a localização.

Nome Tipo Tamanho máximo Obrigatório Descrição
defaultLanguageTag Cadeia de caracteres ✔️ A etiqueta de idioma para as cadeias neste ficheiro de manifesto de aplicação. Por exemplo, en
defaultLanguageFile Cadeia de caracteres 2048 caracteres Um caminho de ficheiro relativo para o ficheiro .json que contém as cadeias. Se não for especificado, as cadeias são obtidas diretamente do ficheiro de manifesto da aplicação. É necessário um ficheiro de idioma predefinido para agentes copilot que suportam vários idiomas.

localizationInfo.additionalLanguages

Uma matriz de objetos com as seguintes propriedades para especificar traduções de idioma adicionais.

Nome Tipo Tamanho máximo Obrigatório Descrição
languageTag Cadeia de caracteres ✔️ A marca de idioma das cadeias de caracteres no arquivo fornecido. Por exemplo, es
file Cadeia de caracteres 2048 caracteres ✔️ Um caminho de ficheiro relativo para o ficheiro .json que contém as cadeias traduzidas.

nome

Necessário – Objeto

O nome da sua experiência de aplicativo, exibido aos usuários na experiência do Teams. Para aplicativos enviados ao AppSource, esses valores devem corresponder às informações na entrada do AppSource. Os valores de short e full devem ser diferentes.

Nome Tipo Tamanho máximo Obrigatório Descrição
short Cadeia de caracteres 30 caracteres ✔️ O nome de exibição curto para o aplicativo.
full Cadeia de caracteres 100 caracteres ✔️ O nome completo da aplicação. É utilizado se o nome completo da aplicação exceder os 30 carateres.

description

Necessário – Objeto

Descreve o seu aplicativo para os usuários. Para aplicativos enviados ao AppSource, esses valores devem corresponder às informações na entrada do AppSource.

Certifique-se de que a sua descrição detalhe corretamente a sua experiência e forneça informações para ajudar clientes em potencial a entender o que sua experiência faz. Você deve anotar na descrição completa, se uma conta externa for necessária para uso. Os valores de short e full devem ser diferentes. A sua descrição curta não deve ser repetida na descrição longa e não deve incluir nenhum outro nome de aplicativo.

Nome Tipo Tamanho máximo Obrigatório Descrição
short Cadeia de caracteres 80 caracteres ✔️ Uma descrição curta da experiência do seu aplicativo, usada quando o espaço é limitado.
full Cadeia de caracteres 4000 caracteres ✔️ A descrição completa do seu aplicativo.

ícones

Necessário – Objeto

Ícones usados no aplicativo Teams. Os arquivos de ícone devem ser incluídos como parte do pacote de upload.

Nome Tamanho máximo Obrigatório Descrição
outline 2048 caracteres ✔️ Um caminho de arquivo relativo para um ícone de contorno PNG transparente de 32x32. A cor do limite tem de ser branca.
color 2048 caracteres ✔️ Um caminho de arquivo relativo para um ícone PNG colorido de 192x192.
color32x32 Caráter de 2048 Um caminho de ficheiro relativo para um ícone PNG de cor completa 32x32 com fundo transparente. Utilizado quando a aplicação é afixada no Outlook e na aplicação Microsoft 365.

accentColor

Necessário – Cadeia

Uma cor a utilizar com e como fundo para os ícones de destaque.

O valor deve ser um código de cor HTML válido começando com '#', por exemplo #4464ee.

elementRelationshipSet

Opcional – Objeto

Descreve as relações entre as capacidades individuais da aplicação, incluindo staticTabs, configurableTabs, composeExtensionse bots. É utilizado para especificar dependências de runtime para garantir que a aplicação só é iniciada em anfitriões do Microsoft 365 aplicáveis, como o Teams, o Outlook e a aplicação Microsoft 365 (Office). Para obter mais informações, veja como especificar os requisitos de runtime no manifesto da aplicação.

Nome Tipo Tamanho máximo Obrigatório Descrição
oneWayDependencies Matriz Define uma ou mais relações de dependência unidirecional entre os componentes da aplicação (cada um representado por um oneWayDependency objeto com um dependenteelement e um dependsOnelement).
mutualDependencies Matriz Define uma ou mais relações de dependência mútua entre as capacidades da aplicação (cada uma representada por uma mutualDependency matriz de element objetos).

elemento

Opcional – Objeto

Descreve uma capacidade de aplicação (element) num elementRelationshipSet.

Nome Tipo Tamanho máximo Obrigatório Descrição
name Enumeração de cadeias ✔️ O tipo de capacidade da aplicação. Valores suportados: bots, , staticTabs, composeExtensionsconfigurableTabs
id Cadeia de caracteres ✔️ Se existirem várias instâncias de um bot, separador ou extensão de mensagem, esta propriedade define uma instância específica da capacidade. Mapeia para botId bots, entityId separadores estáticos e id para separadores configuráveis e extensões de mensagens.
commandIds Matriz de cadeias de caracteres Lista de um ou mais comandos de extensão de mensagem que dependem da capacidade especificada dependsOn . Utilize apenas para extensões de mensagens.

elementRelationshipSet.oneWayDependency

Descreve a dependência unidirecional de uma capacidade de aplicação (X) para outra (Y). Se um anfitrião de runtime do Microsoft 365 não suportar uma capacidade necessária (Y), a capacidade dependente (X) não carregará nem será apresentada ao utilizador.

Opcional – Objeto

Nome Tipo Tamanho máximo Obrigatório Descrição
element Objeto ✔️ Representa uma capacidade de aplicação individual (representada por element) que tem uma dependência de runtime unidirecional noutra capacidade a ser carregada.
dependsOn Matriz ✔️ Define uma ou mais capacidades da aplicação (cada uma representada por element) necessárias para o carregamento especificado element .

elementRelationshipSet.mutualDependencies

Descreve um conjunto de dependências mútuas entre duas ou mais capacidades de aplicações. Um anfitrião de runtime do Microsoft 365 tem de suportar todas as capacidades necessárias para que qualquer uma dessas capacidades esteja disponível para os utilizadores nesse anfitrião.

Opcional – matriz de matrizes (cada uma com dois ou mais element objetos)

copilotAgents

Opcional – Objeto

Define um ou mais agentes para Microsoft 365 Copilot (anteriormente conhecido como copilotExtensions). Os agentes declarativos são personalizações de Microsoft 365 Copilot que são executados no mesmo orquestrador e modelos de fundação (anteriormente conhecidos como declarativeCopilots).

Nome Tipo Tamanho máximo Obrigatório Descrição
declarativeAgents Matriz de objetos 1 ✔️ Matriz de objetos que cada um define um agente declarativo.

declarativeAgents

Representa uma personalização de Microsoft 365 Copilot, conforme definido pelo respetivo ficheiro de manifesto.

Nome Tipo Tamanho máximo Obrigatório Descrição
id Cadeia de caracteres ✔️ Identificador exclusivo do agente. Ao utilizar Microsoft Copilot Studio para criar agentes, este é gerado automaticamente. Caso contrário, atribua manualmente o valor de acordo com as suas próprias convenções ou preferência.
file Cadeia de caracteres ✔️ Caminho relativo no pacote de aplicação para o ficheiro de manifesto do agente declarativo .

configurbleTabs

Opcional – Matriz

Utilizado quando a sua experiência de aplicação tem uma experiência de separador de canal de equipa que requer configuração adicional antes de ser adicionada. Os separadores configuráveis são suportados apenas no âmbito das equipas e só é suportado um separador por aplicação.

O objeto é uma matriz com todos os elementos do tipo object. Esse bloco é necessário apenas para soluções que fornecem uma solução de guia de canal configurável.

Nome Tipo Tamanho máximo Obrigatório Descrição
id Cadeia de caracteres Identificador exclusivo para o separador configurável. Utilizado ao definir dependências unidirecionais e de capacidade de aplicações mútuas em elementRelationshipSet.
configurationUrl Cadeia de caracteres 2048 caracteres ✔️ O URL de https:// a utilizar ao configurar o separador.
canUpdateConfiguration Booliano Um valor que indica se uma instância da configuração da guia pode ser atualizada pelo usuário após a criação.
Valor predefinido: true
scopes Matriz de enumeração 2 ✔️ Os separadores configuráveis só suportam os team âmbitos e groupChat .
context Matriz de enumeração 8 O conjunto de contextItem escopos em que uma guia é compatível.
Valores predefinidos: channelTab, privateChatTab, meetingChatTab, meetingDetailsTab, meetingSidePanel, , meetingStage. personalTab
sharePointPreviewImage Cadeia de caracteres 2048 caracteres Um caminho de arquivo relativo para uma imagem de visualização de guia para uso no SharePoint. Tamanho 1024x768.
supportedSharePointHosts Matriz de enumeração 2 Define como a sua guia é disponibilizada no SharePoint. As opções são sharePointFullPage, sharePointWebPart
meetingSurfaces Matriz de enumeração 2 O conjunto de meetingSurfaceItem âmbitos a que pertence um separador.
Valores predefinidos: sidePanel, stage
supportedPlatform Matriz de enumeração 3 O conjunto de supportedPlatform âmbitos a que pertence um separador.
Valores predefinidos: desktop, , mobileteamsMeetingDevices

staticTabs

Opcional – Matriz

Define um conjunto de guias que podem ser "fixadas" por padrão, sem que o usuário as adicione manualmente. As guias estáticas declaradas no escopo personal são sempre vinculadas à experiência pessoal do aplicativo. Os separadores estáticos declarados no team âmbito não são suportados.

Renderize guias com Cartões Adaptáveis especificando contentBotId em vez de contentUrl no bloco staticTabs.

O objeto é uma matriz (máximo de 16 elementos) com todos os elementos do tipo object. Esse bloco é necessário apenas para soluções que fornecem uma solução de guia estática.

Nome Tipo Tamanho máximo Obrigatório Descrição
entityId String 64 caracteres ✔️ Um identificador exclusivo para a entidade que a guia exibe.
name Cadeia de caracteres 128 caracteres O nome a apresentar do separador.
contentUrl Cadeia de caracteres 2048 caracteres O URL de https:// que aponta para a IU da entidade a apresentar na tela do Teams.
contentBotId Cadeia de caracteres A ID do Aplicativo do Microsoft Teams especificada para o bot no portal do Bot Framework.
websiteUrl Cadeia de caracteres 2048 caracteres O URL de https:// a apontar se um utilizador optar por ver num browser.
scopes Matriz de enumeração 3 ✔️ Os separadores estáticos suportam os âmbitos , teame groupChat , o personalque significa que podem ser aprovisionados como parte da experiência pessoal, de chat de grupo e de reuniões de canal.
searchUrl Cadeia de caracteres 2048 caracteres O URL de https:// para direcionar as consultas de pesquisa de um utilizador.
context Matriz de enumeração 8 O conjunto de contextItem âmbitos a que pertence um separador.
Valores predefinidos: personalTab, channelTab, privateChatTab, meetingChatTab, meetingDetailsTab, meetingSidePanel, , , meetingStageteamLevelApp
supportedPlatform Matriz de enumeração 3 O conjunto de supportedPlatform âmbitos a que pertence um separador.
Valores predefinidos: desktop, , mobileteamsMeetingDevices
requirementSet Objeto Requisitos de tempo de execução para que o separador funcione corretamente na aplicação anfitriã do Microsoft 365. Se um ou mais dos requisitos não forem suportados pelo anfitrião de runtime, o anfitrião não carregará o separador.

staticTabs.requirementSet

Opcional – Objeto

Nome Tipo Tamanho máximo Obrigatório Descrição
requirementSet.hostMustSupportFunctionalities Matriz de objetos ✔️ Especifica uma ou mais capacidades de runtime de que o separador necessita para funcionar corretamente. Valores suportados: dialogUrl, , dialogAdaptiveCarddialogUrlBot, dialogAdaptiveCardBot. Para obter mais informações, veja como especificar os requisitos de runtime no manifesto da aplicação.

bots

Opcional – Matriz

Define uma solução de bot, juntamente com informações opcionais, como propriedades de comando padrão.

O objeto é uma matriz (máximo de apenas 1 elemento— só é permitido um bot por aplicação) com todos os elementos do tipo object. Esse bloco é necessário apenas para soluções que fornecem uma experiência de bot.

Nome Tipo Tamanho máximo Obrigatório Descrição
botId Cadeia de caracteres ✔️ O ID exclusivo do aplicativo Microsoft para o bot conforme registrado na estrutura do bot. A ID pode ser igual a ID do aplicativo geral.
needsChannelSelector Booliano Descreve se o bot utiliza uma sugestão de utilizador para adicionar o bot a um canal específico.
Valor predefinido: false
isNotificationOnly Boolean Indica se um bot é um bot unidirecional, somente para notificação, em vez de um bot de conversa.
Valor predefinido: false
supportsFiles Boolean Indica se o bot é compatível com a capacidade de carregar/baixar arquivos em chat pessoal.
Valor predefinido: false
scopes Matriz de enumeração 3 ✔️ Especifica se o bot oferece uma experiência no contexto de um canal em um team, em um chat de grupo (groupChat) ou uma experiência delimitada apenas a um usuário individual (personal). Estas opções não são independentes.
supportsCalling Booliano Um valor que indica onde um bot dá suporte a chamadas de áudio. IMPORTANTE: esta propriedade é experimental. As propriedades experimentais podem estar incompletas e podem sofrer alterações antes de estarem totalmente disponíveis. A propriedade é fornecida apenas para fins de teste e exploração e não deve ser usada em aplicativos de produção.
Valor predefinido: false
supportsVideo Booliano Um valor que indica onde um bot oferece suporte a chamadas com vídeo. IMPORTANTE: esta propriedade é experimental. As propriedades experimentais podem estar incompletas e podem sofrer alterações antes de estarem totalmente disponíveis. A propriedade é fornecida apenas para fins de teste e exploração e não deve ser usada em aplicativos de produção.
Valor predefinido: false
requiresSecurityEnabledGroup Booliano Um valor que indica se o grupo do Office da equipa precisa de ter a segurança ativada.
Valor predefinido: false
requirementSet Objeto Requisitos de runtime para o bot funcionar corretamente na aplicação anfitriã do Microsoft 365. Se um ou mais dos requisitos não forem suportados pelo anfitrião de runtime, o anfitrião não carregará o bot.

bots.configuration

Opcional – Objeto

Nome Tipo Tamanho máximo Obrigatório Descrição
team.fetchTask Booliano ✔️ Um valor booleano que indica se deve obter a caixa de diálogo (referida como módulo de tarefas no TeamsJS v1.x) dinamicamente.
Valor predefinido: false
team.taskInfo Objeto ✔️ A caixa de diálogo a pré-carregar quando utiliza um bot.
team.taskInfo.title String 64 caracteres ✔️ Título inicial da caixa de diálogo.
team.taskInfo.width Cadeia de caracteres 16 carateres A largura da caixa de diálogo é um número em píxeis ou um esquema predefinido, como large, mediumou small.
team.taskInfo.height Cadeia de caracteres 16 carateres A altura da caixa de diálogo é um número em píxeis ou um esquema predefinido, como large, mediumou small.
team.taskInfo.url Cadeia de caracteres 2048 caracteres URL inicial da webview.
groupChat.fetchTask Booliano ✔️ Um valor booleano que indica se deve obter a caixa de diálogo dinamicamente.
Valor predefinido: false
groupChat.taskInfo Objeto Caixa de diálogo a iniciar ao obter a tarefa definida como false.
Valor predefinido: false
groupChat.taskInfo.title String 64 caracteres ✔️ Título inicial da caixa de diálogo.
groupChat.taskInfo.width Cadeia de caracteres 16 carateres A largura da caixa de diálogo é um número em píxeis ou um esquema predefinido, como large, mediumou small.
groupChat.taskInfo.height Cadeia de caracteres 16 carateres A altura da caixa de diálogo é um número em píxeis ou um esquema predefinido, como large, mediumou small.
groupChat.taskInfo.url Cadeia de caracteres 2048 caracteres URL inicial da webview.

bots.commandLists

Opcional – Matriz

Uma lista opcional de comandos que seu bot pode recomendar aos usuários. O objeto é uma matriz (máximo de 3 elementos) com todos os elementos do tipo object; tem de definir uma lista de comandos separada para cada âmbito suportado pelo bot. Para obter mais informações, confira Menus de Bot.

Nome Tipo Tamanho máximo Obrigatório Descrição
scopes Matriz de enumeração 3 ✔️ Especifica o escopo para o qual a lista de comandos é válida. As opção são team, personal e groupChat.
commands Matriz de objetos 10 ✔️ Uma matriz de comandos suportados pelo bot.

bots.commandLists.commands

Necessário – Matriz

Nome Tipo Tamanho máximo Obrigatório Descrição
title Cadeia de caracteres 32 caracteres ✔️ O nome do comando do bot.
description Cadeia de caracteres 128 caracteres ✔️ Uma descrição de texto simples ou um exemplo da sintaxe do comando e seus argumentos.

bots.requirementSet

Opcional – Objeto

Nome Tipo Tamanho máximo Obrigatório Descrição
requirementSet.hostMustSupportFunctionalities Matriz de objetos ✔️ Especifica uma ou mais capacidades de runtime de que o bot necessita para funcionar corretamente. Valores suportados: dialogUrl, , dialogAdaptiveCarddialogUrlBot, dialogAdaptiveCardBot. Para obter mais informações, veja como especificar os requisitos de runtime no manifesto da aplicação.

conectores

Opcional – Matriz

O connectors bloco define um conector para Grupos do Microsoft 365 para a aplicação.

O objeto é uma matriz (máximo de um elemento) com todos os elementos do tipo object. Este bloco é necessário apenas para soluções que fornecem um Conector. Só é suportado um conector por aplicação.

Nome Tipo Tamanho máximo Obrigatório Descrição
configurationUrl Cadeia de caracteres 2048 caracteres O URL de https:// a utilizar ao configurar o conector com a experiência de configuração inline.
connectorId String 64 caracteres ✔️ Um identificador exclusivo para o Conector que corresponde a sua ID no Painel do Desenvolvedor de Conectores.
scopes Matriz de enumeração 1 ✔️ Especifica se o Conector oferece uma experiência no contexto de um canal em um team, ou uma experiência com escopo apenas para um usuário individual (personal). O team âmbito só é suportado.

composeExtensions

Opcional – Matriz

Define uma extensão de mensagens para o aplicativo.

Observação

O nome da funcionalidade foi alterado de "compor extensão" para "extensão de mensagem" em novembro de 2017, mas o nome do manifesto da aplicação permanece o mesmo para que as extensões existentes continuem a funcionar.

O objeto é uma matriz (máximo de um elemento) com todos os elementos do tipo object. Este bloco é necessário apenas para soluções que fornecem uma extensão de mensagem.

Nome Tipo Tamanho Máximo Obrigatório Descrição
id Cadeia de caracteres Identificador exclusivo para a extensão da mensagem. Utilizado ao definir dependências unidirecionais e de capacidade de aplicações mútuas em elementRelationshipSet.
botId Cadeia de caracteres A ID exclusiva do aplicativo da Microsoft para o bot que oferece suporte à extensão de mensagens, conforme registrado no Bot Framework. A ID pode ser igual a ID do aplicativo geral.
composeExtensionType Cadeia de caracteres Tipo da extensão da mensagem. Os valores de enumeração são botBased e apiBased.
authorization Objeto 2 Informações relacionadas com autorização para a extensão de mensagens baseada em API
authorization.authType Cadeia de caracteres Enumeração de possíveis tipos de autorização. Os valores suportados são none, apiSecretServiceAuthe microsoftEntra.
authorization.microsoftEntraConfiguration Objeto Detalhes de captura de objetos necessários para fazer o fluxo de autenticação microsoftEntra. Aplicável apenas quando o tipo de autenticação for microsoftEntra.
authorization.microsoftEntraConfiguration.supportsSingleSignOn Booliano Um valor que indica se o início de sessão único está configurado para a aplicação.
authorization.apiSecretServiceAuthConfiguration Objeto Objeto que captura os detalhes necessários para realizar a autenticação do serviço. Aplicável apenas quando o tipo de autenticação for apiSecretServiceAuth.
authorization.apiSecretServiceAuthConfiguration.apiSecretRegistrationId Cadeia de caracteres 128 caracteres ID de registo devolvido quando o programador submete a chave de API através do Portal do Programador.
apiSpecificationFile Cadeia de caracteres 2048 caracteres Um caminho de ficheiro relativo para o ficheiro de especificação da API no pacote de manifesto.
canUpdateConfiguration Booliano Um valor que indica se a configuração de uma extensão de mensagem pode ser atualizada pelo utilizador.
Valor predefinido: true
commands Matriz de objetos 10 Matriz de comandos com suporte da extensão de mensagens.
messageHandlers Matriz de objetos 5 Uma lista de manipuladores que permitem que aplicativos sejam invocados quando determinadas condições são atendidas. Os domínios também têm de estar listados em validDomains.
messageHandlers.type Cadeia de caracteres O tipo de manipulador de mensagens. Deve ser link.
messageHandlers.value.domains Matriz de cadeias de caracteres 2048 caracteres Matriz de domínios para os quais o manipulador de mensagens de link pode se registrar.
messageHandlers.supportsAnonymizedPayloads Booliano Um valor Booleano que indica se o processador de mensagens de ligação da aplicação suporta um fluxo de invocação anónimo.
Valor predefinido: false
Para ativar a instalação zero para a desfraldamento da ligação, o valor tem de ser definido como true.
Nota: a propriedade supportAnonymousAccess é substituído por supportsAnonymizedPayloads.
type Tipo da extensão da mensagem. Os valores suportados são apiBased ou botBased.
requirementSet Objeto Requisitos de tempo de execução para que a extensão de mensagem funcione corretamente na aplicação anfitriã do Microsoft 365. Se um ou mais dos requisitos não forem suportados pelo anfitrião de runtime, o anfitrião não carregará a extensão da mensagem.

composeExtensions.commands

A extensão da mensagem tem de declarar um ou mais comandos. Cada comando aparece no Teams como uma potencial interação a partir do ponto de entrada baseado na IU. Existe um máximo de 10 comandos.

Cada item de comando é um objeto com a seguinte estrutura:

Nome Tipo Tamanho máximo Obrigatório Descrição
id String 64 caracteres ✔️ A ID do comando.
type String 64 caracteres O tipo do comando. Um de query ou action. Padrão: query
samplePrompts Matriz 5 Propriedade utilizada por Microsoft 365 Copilot para apresentar pedidos suportados pelo plug-in ao utilizador. Para Microsoft 365 Copilot cenários, esta propriedade é necessária para passar a validação da aplicação para submissão da loja.
samplePrompts.text string 128 caracteres ✔️ Conteúdo do pedido de exemplo.
apiResponseRenderingTemplateFile Cadeia de caracteres 2048 caracteres Um caminho de ficheiro relativo para o ficheiro de modelo de composição de resposta da API utilizado para formatar a resposta JSON da API do programador para a resposta do Cartão Ajustável.
context Matriz de cadeias de caracteres 3 carateres Define de onde a extensão da mensagem pode ser invocada. Qualquer combinação de compose, commandBox e message.
Valores predefinidos: compose, commandBox
title Cadeia de caracteres 32 caracteres ✔️ O nome do comando amigável.
description Cadeia de caracteres 128 caracteres A descrição que aparece para os usuários para indicar a finalidade deste comando.
semanticDescription Cadeia de caracteres 5000 carateres Descrição semântica do comando para consumo por Microsoft 365 Copilot através de Modelos de Linguagem Grande (LLMs).
initialRun Booliano Um valor Booleano que indica se o comando é executado inicialmente sem parâmetros.
Valor predefinido: false
fetchTask Booliano Um valor booleano que indica se tem de obter a caixa de diálogo dinamicamente.
Valor predefinido: false
taskInfo Objeto Especifique a caixa de diálogo a pré-carregar quando utilizar um comando de extensão de mensagem.
taskInfo.title String 64 caracteres Título inicial da caixa de diálogo.
taskInfo.width Cadeia de caracteres 16 carateres Largura da caixa de diálogo – um número em píxeis ou um esquema predefinido, como large, mediumou small.
taskInfo.height Cadeia de caracteres 16 carateres Altura da caixa de diálogo – um número em píxeis ou um esquema predefinido, como large, mediumou small.
taskInfo.url Cadeia de caracteres 2048 caracteres URL inicial da webview.
parameters Matriz de objetos 5 A lista de parâmetros que o comando usa.
parameters.name String 64 caracteres ✔️ O nome do parâmetro como ele aparece no cliente. Isto está incluído no pedido do utilizador.
Para a extensão de mensagens baseada em API, o nome tem de ser mapeado para o parameters.name na Descrição de OpenAPI. Se estiver a referenciar uma propriedade no esquema do corpo do pedido, o nome tem de mapear para properties.name ou consultar parâmetros.
parameters.title Cadeia de caracteres 32 caracteres ✔️ Título amigável para o parâmetro.
parameters.description Cadeia de caracteres 128 caracteres Cadeia de caracteres amigável que descreve a finalidade desse parâmetro.
parameters.semanticDescription Cadeia de caracteres 2000 carateres Descrição semântica do parâmetro para consumo pelos Modelos de Linguagem Grandes (LLMs).
parameters.inputType Cadeia de caracteres Define o tipo de controlo apresentado numa caixa de diálogo para fetchTask: false. O valor de entrada só pode ser um de text, textarea, number, date, time, toggle, . choiceset
Valor predefinido: text
parameters.value Cadeia de caracteres 512 caracteres Valor inicial para o parâmetro.
parameters.choices Matriz de objetos 10 As opções de escolha para choiceset. Use apenas quando parameters.inputType for choiceset.
parameters.choices.title Cadeia de caracteres 128 caracteres ✔️ Títulor da escolha.
parameters.choices.value Cadeia de caracteres 512 caracteres ✔️ O valor da escolha.

composeExtensions.requirementSet

Opcional – Objeto

Nome Tipo Tamanho máximo Obrigatório Descrição
requirementSet.hostMustSupportFunctionalities Matriz de objetos ✔️ Especifica uma ou mais capacidades de runtime de que a extensão de mensagem necessita para funcionar corretamente. Valores suportados: dialogUrl, , dialogAdaptiveCarddialogUrlBot, dialogAdaptiveCardBot. Para obter mais informações, veja como especificar os requisitos de runtime no manifesto da aplicação.

scopeConstraints

As restrições de âmbito impostas a uma aplicação para especificar em que threads pode instalar a aplicação. Quando não são especificadas restrições, pode instalar a aplicação em todos os threads dentro do âmbito específico.

Opcional – Objeto

Nome Tipo Tamanho Máximo Obrigatório Descrição
teams Matriz 128 Uma lista de IDs de threads de equipa aos quais a sua aplicação é restrita.
teams.id String 64 caracteres ✔️ ID do thread da equipa.
groupChats Matriz 128 Uma lista de IDs de tópicos de chat aos quais a sua aplicação é restrita.
groupChats.id String 64 caracteres ✔️ ID do tópico do chat.

permissões

Opcional – Matriz de cadeias de carateres

Uma matriz de string, que especifica as permissões que a aplicação pede, que permite que os utilizadores finais saibam como a extensão funciona. As seguintes opções são não existentes:

  • identity Requer informações de identidade do utilizador.
  • messageTeamMembers Requer permissão para enviar mensagens diretas aos membros da equipa.

Alterar estas permissões ao atualizar a aplicação faz com que os utilizadores repitam o processo de consentimento da primeira vez que executarem a aplicação atualizada.

devicePermissions

Opcional – Matriz de Cadeias

Especifica as funcionalidades nativas no dispositivo de um utilizador a que a sua aplicação pode pedir acesso. As opções são:

  • geolocation
  • media
  • notifications
  • midi
  • openExternal

validDomains

Opcional, exceto Obrigatório onde indicado.

Uma lista de domínios válidos dos quais o aplicativo espera carregar qualquer conteúdo. As listagens de domínio podem incluir caracteres curinga, por exemplo, *.example.com. O domínio válido corresponde exatamente a um segmento do domínio; se você precisar combinar a.b.example.com, use *.*.example.com. Se a configuração do separador ou a IU do conteúdo precisar de aceder a qualquer outro domínio para além da utilização para a configuração do separador, esse domínio tem de ser especificado aqui.

Observação

Os Suplementos do Office, configurados com uma extensions propriedade no manifesto, ignoram os domínios que contêm um caráter universal. Se a sua aplicação incorporar um Suplemento do Office, especifique o nome de domínio completo para os domínios aos quais o suplemento acede.

No entanto, não é necessário incluir os domínios dos fornecedores de identidade que pretende suportar na sua aplicação. Por exemplo, para autenticar com um ID google, é necessário redirecionar para accounts.google.com, mas não pode incluir accounts.google.com no validDomains[].

Importante

Não adicione domínios que estão fora de seu controle, seja diretamente ou por meio de curingas. Por exemplo, yourapp.onmicrosoft.com é válido, mas *.onmicrosoft.com não é válido.

O objeto é uma matriz com todos os elementos do tipo string. O item máximo do objeto é 16 e o comprimento máximo é de 2048 carateres.

webApplicationInfo

Opcional – Objeto

Especifique o ID da Aplicação Microsoft Entra e as informações do Graph para ajudar os utilizadores a iniciar sessão na sua aplicação Microsoft Entra de forma totalmente integrada.

Nome Tipo Tamanho máximo Obrigatório Descrição
id Cadeia de caracteres ✔️ Microsoft Entra ID da aplicação. Essa ID deve ser um GUID.
resource Cadeia de caracteres 2048 caracteres URL de recurso do aplicativo para adquirir token de autenticação para logon único.

graphConnector

Opcional – Objeto

Especifique a configuração do conector de gráfico do aplicativo. Se estiver presente, webApplicationInfo.id também tem de ser especificado.

Nome Tipo Tamanho máximo Obrigatório Descrição
notificationUrl Cadeia de caracteres 2048 caracteres ✔️ O URL https:// para o qual as notificações do conector de gráficos para a aplicação têm de ser enviadas.

showLoadingIndicator

Opcional – Booleano

Indica se pretende mostrar o indicador de carregamento quando uma aplicação ou um separador está a carregar.
Valor predefinido: false

Observação

  • Se selecionar showLoadingIndicator como verdadeiro no manifesto da aplicação, para carregar a página corretamente, modifique as páginas de conteúdo dos seus separadores e caixas de diálogo, conforme descrito em Mostrar um documento de indicador de carregamento nativo .
  • Se não modificar as páginas de conteúdo do separador, a aplicação de separador não carrega e mostra o erro There was a problem reaching this app.

isFullScreen

Opcional – Booleano

Indique onde um aplicativo pessoal é renderizado com ou sem uma barra de cabeçalho de guia.
Valor predefinido: false

Observação

isFullScreen funciona apenas para aplicativos publicados em sua organização.

activities

Opcional – Objeto

Defina as propriedades que o seu aplicativo usa para postar um feed de atividades do usuário..

Nome Tipo Tamanho máximo Obrigatório Descrição
activityTypes Matriz de objetos 128 Forneça os tipos de atividades que seu aplicativo pode postar no feed de atividades de um usuário. O systemDefault tipo de atividade é uma cadeia reservada e inválida.

activities.activityTypes

Nome Tipo Tamanho máximo Obrigatório Descrição
type Cadeia de caracteres 32 caracteres ✔️ O tipo de notificação.
description Cadeia de caracteres 128 caracteres ✔️ Uma breve descrição da notificação.
templateText Cadeia de caracteres 128 caracteres ✔️ Ex: "{actor} criou a tarefa {taskId} para você"
{
   "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"
         }
      ]
   }
}

configurableProperties

Opcional – Matriz

O bloco configurableProperties define as propriedades do aplicativo que os administradores do Teams podem personalizar. Para obter mais informações, consulte habilitar a personalização do aplicativo.

Observação

Um mínimo de uma propriedade deve ser definido. Você pode definir um máximo de nove propriedades neste bloco.

Você pode definir qualquer uma das seguintes propriedades:

  • name: O nome de exibição do aplicativo.
  • shortDescription: A breve descrição do aplicativo.
  • longDescription: descrição detalhada do aplicativo.
  • smallImageUrl: O ícone de contorno do aplicativo.
  • largeImageUrl: O ícone de cor do aplicativo.
  • accentColor: a cor a utilizar com e como fundo para os ícones de destaque.
  • developerUrl: A URL HTTPS do site do desenvolvedor.
  • privacyUrl: A URL HTTPS da política de privacidade do desenvolvedor.
  • termsOfUseUrl: A URL HTTPS dos termos de uso do desenvolvedor.

supportedChannelTypes

Opcional – Matriz

Ativa a sua aplicação em canais não padrão. Se seu aplicativo der suporte a um escopo de equipe e esta propriedade for definida, o Teams habilita seu aplicativo em cada tipo de canal adequadamente. Os tipos de canal privado e partilhado são suportados.

Observação

  • Se seu aplicativo der suporte a um escopo de equipe, ele funciona nos canais padrão independentemente dos valores que são definidos nesta propriedade.
  • Seu aplicativo pode levar em conta as propriedades únicas de cada um dos tipos de canal para funcionar corretamente. Para ativar o separador para canais privados e partilhados, veja Obter contexto em canais privados e obter contexto em canais partilhados

defaultBlockUntilAdminAction

Opcional – Booleano

Um valor que indica se uma aplicação está bloqueada por predefinição até que o administrador a permita.
Valor predefinido: false

publisherDocsUrl

Opcional – Cadeia

O https:// URL para a página que fornece informações adicionais sobre a aplicação para os administradores. O comprimento máximo da cadeia é de 2048 carateres.

defaultInstallScope

Opcional – Cadeia

Especifica o escopo de instalação definido para este aplicativo por padrão. O âmbito definido é a opção apresentada no botão quando um utilizador tenta adicionar a aplicação. As opções são:

  • personal
  • team
  • groupChat
  • meetings

defaultGroupCapability

Opcional – Objeto

Quando um âmbito de instalação de grupo é selecionado, define a capacidade predefinida quando o utilizador instala a aplicação. As opções são:

  • team
  • groupchat
  • meetings
Nome Tipo Tamanho máximo Obrigatório Descrição
team Cadeia de caracteres Quando o escopo de instalação selecionado é team, este campo especifica o recurso padrão disponível.
Opções: tab, bot ou connector.
groupchat Cadeia de caracteres Quando o escopo de instalação selecionado é groupChat, este campo especifica o recurso padrão disponível.
Opções: tab, bot ou connector.
meetings Cadeia de caracteres Quando o escopo de instalação selecionado é meetings, este campo especifica o recurso padrão disponível.
Opções: tab, bot ou connector.

subscriptionOffer

Opcional – Objeto

Especifica a oferta de SaaS associada ao seu aplicativo.

Nome Tipo Tamanho máximo Obrigatório Descrição
offerId Cadeia de caracteres 2048 caracteres ✔️ Um identificador exclusivo que inclui a sua ID de editor e ID de oferta, que você pode encontrar no Partner Center. Você deve formatar a cadeia de caracteres como publisherId.offerId.

meetingExtensionDefinition

Opcional – Objeto

Especifique a definição de extensão da reunião. Para obter mais informações, consulte cenas personalizadas do Modo Juntos no Teams.

Nome Tipo Tamanho máximo Obrigatório Descrição
scenes Matriz de objetos 5 Cenas suportadas da reunião.
supportsStreaming Booliano Um valor Booleano que indica se uma aplicação pode transmitir em fluxo o conteúdo de áudio e vídeo da reunião para um ponto final de protocolo de reunião em tempo real (RTMP).
Valor predefinido: false
videoFiltersConfigurationUrl Cadeia de caracteres 2048 caracteres O URL de https:// para configurar os filtros de vídeo.
supportsAnonymousGuestUsers Booliano Um valor Booleano que indica se a aplicação suporta o acesso por utilizadores convidados anónimos.
Valor predefinido: false

meetingExtensionDefinition.scenes

Nome Tipo Tamanho máximo Obrigatório Descrição
id Cadeia de caracteres ✔️ O identificador exclusivo para a cena. Essa ID deve ser um GUID.
name Cadeia de caracteres 128 caracteres ✔️ O nome da cena.
file Cadeia de caracteres 2048 caracteres ✔️ O caminho do arquivo relativo para o arquivo JSON de metadados das cenas.
preview Cadeia de caracteres 2048 caracteres ✔️ O caminho do arquivo relativo para o ícone de visualização PNG das cenas.
maxAudience Número inteiro 50 ✔️ O número máximo de audiências suportadas na cena.
seatsReservedForOrganizersOrPresenters Número inteiro 50 ✔️ O número de assentos reservados para organizadores ou apresentadores.

meetingExtensionDefinition.videoFilters

Este objeto indica filtros de vídeo suportados por reuniões.

Nome Tipo Tamanho máximo Obrigatório Descrição
id Cadeia de caracteres ✔️ O identificador exclusivo do filtro de vídeo. Essa ID deve ser um GUID.
name Cadeia de caracteres 128 caracteres ✔️ O nome do filtro de vídeo.
thumbnail Cadeia de caracteres 2048 caracteres ✔️ O caminho relativo do ficheiro para a miniatura do filtro de vídeo.

autorização

Opcional – Objeto

Observação

authorization só é suportado para a versão 1.12 ou posterior do manifesto da aplicação.

Especifique e consolide as informações relacionadas à autorização para o aplicativo.

Nome Tipo Tamanho máximo Obrigatório Descrição
permissions Objeto Lista de permissões que o aplicativo precisa para funcionar.

authorization.permissions

Nome Tipo Tamanho máximo Obrigatório Descrição
resourceSpecific Matriz de objetos 16 Permissões que protegem o acesso a dados no nível da instância do recurso.

authorization.permissions.resourceSpecific

Nome Tipo Tamanho máximo Obrigatório Descrição
type Cadeia de caracteres ✔️ O tipo de permissão de consentimento específico do recurso (RSC).
Opções: Application e Delegated.
name Cadeia de caracteres 128 caracteres ✔️ O nome da permissão RSC. Para obter mais informações, veja RSC application permissions and RSC delegated permissions (Permissões de aplicações RSC e permissões delegadas do RSC)

Permissões da aplicação RSC

As permissões do aplicativo permitem que o aplicativo acesse dados sem um usuário conectado. Para obter informações sobre permissões de aplicação, veja Permissões RSC para o Microsoft Graph e o Microsoft BotSDK.

Permissões delegadas do RSC

As permissões delegadas permitem que o aplicativo acesse dados em nome do usuário conectado.

  • Permissões delegadas do RSC para uma equipa

    Nome Descrição
    ChannelMeetingParticipant.Read.Group Permite que o aplicativo leia as informações dos participantes, incluindo nome, função, ID, horários de ingresso e de saída, de reuniões de canal associadas a esta equipe, em nome do usuário conectado.
    ChannelMeetingIncomingAudio.Detect.Group Permite que a aplicação detete áudio recebido em reuniões de canal associadas à equipa.
    ChannelMeetingActiveSpeaker.Read.Group Permite que a aplicação leia os participantes que estão a enviar áudio para as reuniões de canal associadas à equipa.
    ChannelMeetingAudioVideo.Stream.Group Permite que a aplicação transmita conteúdos de áudio-vídeo a partir de reuniões de canal associadas à equipa.
    InAppPurchase.Allow.Group Permite que a aplicação mostre ofertas do marketplace aos utilizadores na equipa e conclua as compras na aplicação, em nome do utilizador com sessão iniciada.
    ChannelMeetingStage.Write.Group Permite que a aplicação mostre conteúdo na fase da reunião em reuniões de canal associadas à equipa, em nome do utilizador com sessão iniciada.
    LiveShareSession.ReadWrite.Group Permite que a aplicação crie e sincronize sessões live share para a equipa e obtenha informações relacionadas com o acesso, como o nome e a função, sobre a lista da equipa e quaisquer reuniões associadas, em nome do utilizador com sessão iniciada.
    MeetingParticipantReaction.Read.Group Permite que a aplicação leia as reações dos participantes em reuniões de canal associadas à equipa.
  • Permissões delegadas do RSC para conversas ou reuniões

    Nome Descrição
    InAppPurchase.Allow.Chat Permite que a aplicação mostre ofertas do marketplace aos utilizadores no chat e a qualquer reunião associada e conclua as compras na aplicação, em nome do utilizador com sessão iniciada.
    MeetingStage.Write.Chat Permite que a aplicação mostre conteúdo na fase da reunião em reuniões associadas ao chat, em nome do utilizador com sessão iniciada.
    OnlineMeetingParticipant.Read.Chat Permite que a aplicação leia as informações dos participantes, incluindo o nome, a função, o ID, a adesão e os horários à esquerda, da reunião associada ao chat, em nome do utilizador com sessão iniciada.
    OnlineMeetingParticipant.ToggleIncomingAudio.Chat Permite que a aplicação alterne o áudio recebido para os participantes em reuniões associadas ao chat, em nome do utilizador com sessão iniciada.
    LiveShareSession.ReadWrite.Chat Permite que a aplicação crie e sincronize sessões de Live Share para o chat e obtenha informações relacionadas com o acesso, como o nome e a função, sobre a lista do chat e quaisquer reuniões associadas, em nome do utilizador com sessão iniciada.
    MeetingParticipantReaction.Read.Chat Permite que a aplicação leia as reações dos participantes em reuniões associadas ao chat.
    OnlineMeetingIncomingAudio.Detect.Chat Permite que a aplicação detete alterações na status de áudio recebido em reuniões associadas ao chat, em nome do utilizador com sessão iniciada.
    OnlineMeetingActiveSpeaker.Read.Chat Permite que a aplicação leia os participantes que estão a enviar áudio para as reuniões associadas ao chat.
    OnlineMeetingAudioVideo.Stream.Chat Permite que a aplicação transmita em fluxo conteúdos de áudio-vídeo de reuniões associadas ao chat.
  • Permissões delegadas do RSC para utilizadores

    Nome Descrição
    CameraStream.Read.User Permite que a aplicação leia o fluxo da câmara do utilizador.
    InAppPurchase.Allow.User Permite que o aplicativo mostrar as ofertas do marketplace do usuário e conclua as compras do usuário dentro do aplicativo, em nome do usuário conectado.
    OutgoingVideoStream.Write.User Permite que a aplicação modifique o vídeo de saída do utilizador.
    MicrophoneStream.Read.User Permite que a aplicação leia o fluxo de microfone do utilizador.
    MeetingParticipantReaction.Read.User Permite que a aplicação leia as reações do utilizador durante a participação numa reunião.

extensions

Opcional – Objeto

A extensions propriedade especifica suplementos do Outlook num manifesto de aplicação e simplifica a distribuição e aquisição no ecossistema do Microsoft 365. Cada aplicação suporta apenas uma extensão.

Nome Tipo Tamanho máximo Obrigatório Descrição
requirements Objeto Especifica o conjunto de requisitos de cliente ou anfitrião para a extensão.
runtimes Matriz 20 Configura o conjunto de runtimes e ações que podem ser utilizados por cada ponto de extensão. Para obter mais informações, consulte runtimes nos Suplementos do Office.
ribbons Matriz 20 Define o ponto de extensão dos frisos.
autoRunEvents Matriz 10 Define o ponto de extensão de ativação baseado em eventos.
alternates Matriz 10 Especifica a relação para alternar soluções existentes do Microsoft 365. É utilizado para ocultar ou atribuir prioridades a suplementos do mesmo fabricante com funcionalidades sobrepostas.
audienceClaimUrl Cadeia de caracteres 2048 caracteres Especifica o URL da extensão e é utilizado para validar os tokens de identidade de utilizador do Exchange. Para obter mais informações, veja dentro do token de identidade do Exchange
appDeeplinks Matriz Não usar. Apenas para utilização interna da Microsoft.

Para obter mais informações, consulte o manifesto de Suplementos do Office para o Microsoft 365.

extensions.requirements

O extensions.requirements objeto especifica os âmbitos, os fatores de formulário e os conjuntos de requisitos da Biblioteca JavaScript do Office que têm de ser suportados no cliente do Office para que o suplemento seja instalado. Os requisitos também são suportados nas propriedades subordinadas "ribbon", "runtime", "alternates" e "autoRunEvents" para filtrar seletivamente algumas funcionalidades do suplemento. Para obter mais informações, consulte Especificar os requisitos do Suplemento do Office no manifesto unificado do Microsoft 365.

Nome Tipo Tamanho máximo Obrigatório Descrição
capabilities Matriz 100 Identifica os conjuntos de requisitos.
capabilities.name Cadeia de caracteres ✔️ Identifica o nome do conjunto de requisitos.
capabilities.minVersion Cadeia de caracteres Identifica a versão mínima do conjunto de requisitos.
capabilities.maxVersion Cadeia de caracteres Identifica a versão máxima do conjunto de requisitos.
scopes Matriz de enumerações 1 Identifica os âmbitos nos quais o suplemento pode ser executado e define as aplicações do Microsoft 365 nas quais a extensão pode ser executada. Por exemplo, mail (Outlook).
Valor suportado: mail
formFactors Matriz de enumerações Identifica os fatores de formulário que suportam o suplemento.
Valores suportados: mobile, desktop

extensions.runtimes

Opcional – Matriz

A extensions.runtimes matriz configura os conjuntos de runtimes e ações que cada ponto de extensão pode utilizar.

Nome Tipo Tamanho máximo Obrigatório Descrição
id String 64 caracteres ✔️ Especifica o ID do runtime.
type Enumeração de cadeias ✔️ Especifica o tipo de runtime. O valor de enumeração suportado para o runtime baseado no browser é general.
code Objeto ✔️ Especifica a localização do código para o runtime. Com base no runtime.type, os suplementos podem utilizar um ficheiro JavaScript ou uma página HTML com uma etiqueta incorporada script que especifica o URL de um ficheiro JavaScript. Ambos os URLs são necessários em situações em que o runtime.type é incerto.
code.page Cadeia de caracteres 2048 caracteres ✔️ Especifica o URL da página Web que contém uma etiqueta incorporada script , que especifica o URL de um ficheiro JavaScript (a carregar num runtime baseado no browser).
code.script Cadeia de caracteres 2048 caracteres Especifica o URL do ficheiro JavaScript a carregar no runtime apenas javaScript.
lifetime Enumeração de cadeias Especifica a duração do runtime. Os runtimes com uma short duração não preservam o estado entre execuções enquanto os runtimes com uma long duração o fazem. Para obter mais informações, consulte Runtimes nos Suplementos do Office.
Valor predefinido: short
actions Matriz 20 Especifica o conjunto de ações suportadas pelo runtime. Uma ação está a executar uma função JavaScript ou a abrir uma vista, como um painel de tarefas.
actions.id String 64 caracteres ✔️ Especifica o ID da ação, que é transmitido para o ficheiro de código.
actions.type Cadeia de caracteres ✔️ Especifica o tipo de ação. O executeFunction tipo executa uma função JavaScript sem aguardar que seja concluída e o openPage tipo abre uma página numa determinada vista.
actions.displayName String 64 caracteres Especifica o nome a apresentar da ação e não é a etiqueta de um botão ou item de menu que invoca a ação (que está configurada com tabs.groups.controls.label).
actions.pinnable Booliano Especifica se um painel de tarefas tem suporte para fixação, que mantém o painel de tarefas aberto quando o usuário altera a seleção.
Valor predefinido: false
actions.view String 64 caracteres Especifica a vista onde a página tem de ser aberta. É utilizado apenas quando actions.type é openPage.
actions.multiselect Booliano Especifica se o utilizador final pode selecionar vários itens, como múltiplas mensagens de e-mail, e aplicar a ação a todos eles.
Valor predefinido: false
actions.supportsNoItemContext Booliano Permite que os suplementos do painel de tarefas ativem sem o Painel de Leitura ativado ou uma mensagem selecionada.
Valor predefinido: false
requirements Objeto Especifica os âmbitos, o formulárioFactores e os conjuntos de requisitos da Biblioteca JavaScript do Office que têm de ser suportados no cliente do Office para que o runtime seja incluído no suplemento. Para obter mais informações, consulte Especificar os requisitos do Suplemento do Office no manifesto unificado do Microsoft 365.
requirements.capabilities Matriz Identifica os conjuntos de requisitos.
Opções: name (obrigatório), minVersion, maxVersion
requirements.capabilities.name Cadeia de caracteres ✔️ Identifica o nome do conjunto de requisitos.
requirements.capabilities.minVersion Cadeia de caracteres Identifica a versão mínima do conjunto de requisitos.
requirements.capabilities.maxVersion Cadeia de caracteres Identifica a versão máxima do conjunto de requisitos.
requirements.scopes Matriz de enumerações 1 Identifica os âmbitos nos quais o suplemento pode ser executado e define as aplicações do Microsoft 365 nas quais a extensão pode ser executada. Por exemplo, mail (Outlook).
Valor suportado: mail
requirements.formFactors Matriz de enumerações Identifica os fatores de formulário que suportam o suplemento.
Valores suportados: mobile, desktop

Para utilizar extensions.runtimeso , veja criar comandos de suplementos, configurar o runtime para um painel de tarefas e configurar o runtime para o comando da função.

extensions.ribbons

Opcional – Matriz

A extensions.ribbons propriedade fornece a capacidade de adicionar comandos de suplemento ( botões e itens de menu) ao friso da aplicação do Microsoft 365. A definição do friso é selecionada na matriz com base nos requisitos e na ordem inicial.

Nome Tipo Tamanho máximo Obrigatório Descrição
contexts Matriz 8 Especifica a janela da aplicação do Microsoft 365 na qual a personalização do friso está disponível para o utilizador. Cada item na matriz é um membro de uma matriz de cadeia.
Valores suportados: mailRead, , mailCompose, meetingDetailsOrganizer, meetingDetailsAttendee, onlineMeetingDetailsOrganizer, logEventMeetingDetailsAttendee, , , spamReportingOverridedefault
requirements Objeto Especifica os âmbitos, o formulárioFactores e os conjuntos de requisitos da Biblioteca JavaScript do Office que têm de ser suportados no cliente do Office para que a personalização do friso seja apresentada. Para obter mais informações, consulte Especificar os requisitos do Suplemento do Office no manifesto unificado do Microsoft 365.
requirements.capabilities Matriz Identifica os conjuntos de requisitos.
Opções: name (obrigatório), minVersion, maxVersion
requirements.capabilities.name Cadeia de caracteres ✔️ Identifica o nome do conjunto de requisitos.
requirements.capabilities.minVersion Cadeia de caracteres Identifica a versão mínima do conjunto de requisitos.
requirements.capabilities.maxVersion Cadeia de caracteres Identifica a versão máxima do conjunto de requisitos.
requirements.scopes Matriz de enumerações 1 Identifica os âmbitos nos quais o suplemento pode ser executado e define as aplicações do Microsoft 365 nas quais a extensão pode ser executada. Por exemplo, mail (Outlook).
Valor suportado: mail
requirements.formFactors Matriz de enumerações Identifica os fatores de formulário que suportam o suplemento.
Valores suportados: mobile, desktop
tabs Matriz 20 ✔️ Configura os separadores personalizados no friso da aplicação Microsoft 365.
tabs.id String 64 caracteres Especifica o ID do separador na aplicação.
tabs.builtInTabId String 64 caracteres Especifica o ID de um separador incorporado do friso do Office. Para obter mais informações sobre os valores possíveis, consulte Localizar os IDs dos separadores incorporados do friso do Office. As únicas outras propriedades subordinadas de um objeto de separador que podem ser incluídas nesta propriedade são groups e customMobileRibbonGroups.
tabs.label String 64 caracteres Especifica o texto apresentado para o separador. Apesar do comprimento máximo de 64 carateres, para alinhar corretamente o separador no friso, recomendamos que limite a etiqueta a 16 carateres.
tabs.position Objeto Configura a posição do separador personalizado em relação a outros separadores no friso.
tabs.position.builtInTabId String 64 caracteres ✔️ Especifica o ID do separador incorporado ao qual o separador personalizado deve ser posicionado junto a. Para obter mais informações, veja Localizar os IDs de controlos e grupos de controlo.
tabs.position.align Enumeração de cadeias ✔️ Define o alinhamento do separador personalizado em relação ao separador incorporado especificado.
Valores suportados: after, before
tabs.groups Matriz 10 Define grupos de controlos num separador do friso num dispositivo não móvel. Para dispositivos móveis, consulte tabs.customMobileRibbonGroups abaixo.
tabs.groups.id String 64 caracteres Especifica o ID do grupo de separadores na aplicação. Tem de ser diferente de qualquer ID de grupo incorporado na aplicação do Microsoft 365 e de qualquer outro grupo personalizado.
tabs.groups.label String 64 caracteres Especifica o texto apresentado para o grupo. Apesar do comprimento máximo de 64 carateres, para alinhar corretamente o separador no friso, recomendamos que limite a etiqueta a 16 carateres.
tabs.groups.icons Matriz 3 Especifica os ícones apresentados para o grupo.
tabs.groups.icons.size Número ✔️ Especifica o tamanho do ícone em píxeis, enumerado como 16,20,24,32,40,48,,8064..
Tamanhos de imagem necessários: 16, , 3280.
tabs.groups.icons.url Cadeia de caracteres 2048 caracteres ✔️ Especifica o URL absoluto do ícone.
tabs.groups.controls Matriz Configura os botões e menus no grupo.
tabs.groups.controls.id String 64 caracteres ✔️ Especifica o ID do controlo na aplicação. Tem de ser diferente de qualquer ID de controlo incorporado na aplicação do Microsoft 365 e de qualquer outro controlo personalizado.
tabs.groups.controls.items Matriz Configura os itens para um controlo de menu.
tabs.groups.controls.items.id Cadeia de caracteres ✔️ Especifica o ID de um item de menu.
tabs.groups.controls.items.type Enumeração de cadeias ✔️ Define o tipo de controlo do item de menu.
Valores suportados: button
tabs.groups.controls.items.label String 64 caracteres ✔️ Especifica o texto apresentado para o item de menu.
tabs.groups.controls.items.icons Matriz Configura os ícones do item de menu.
tabs.groups.controls.items.icons.size Número ✔️ Especifica o tamanho do ícone em píxeis, enumerado como 16,20,24,32,40,48,,8064..
Tamanhos de imagem necessários: 16, , 3280.
tabs.groups.controls.items.icons.url URL ✔️ Especifica o URL absoluto do ícone.
tabs.groups.controls.items.supertip ✔️ Configura uma supertipa para o item de menu. Uma supertipa é uma funcionalidade de IU que apresenta uma breve caixa de informações de ajuda sobre um controlo quando o cursor paira sobre o mesmo. A caixa pode conter múltiplas linhas de texto.
tabs.groups.controls.items.supertip.title String 64 caracteres ✔️ Especifica o texto de título da sobretipa.
tabs.groups.controls.items.supertip.description Cadeia de caracteres 128 caracteres ✔️ Especifica a descrição da sobretipa.
tabs.groups.controls.items.actionId String 64 caracteres ✔️ Especifica o ID da ação que é efetuada quando um utilizador seleciona o controlo ou item de menu. O actionId tem de corresponder a algum runtimes.actions.id valor de propriedade.
tabs.groups.controls.items.enabled Booliano Indica se o item de menu está inicialmente ativado.
Valor predefinido: true
tabs.groups.controls.items.overriddenByRibbonApi Booliano Especifica se o item de menu está oculto nas combinações de aplicações e plataformas que suportam a API (Office.ribbon.requestCreateControls). Esta API instala separadores contextuais personalizados no friso.
Valor predefinido: false
tabs.groups.controls.type Cadeia de caracteres ✔️ Define o tipo de controlo.
Valores suportados: button, menu
tabs.groups.controls.builtInControlId String 64 caracteres Especifica o ID de um controlo existente do Microsoft 365. Para obter mais informações, veja Localizar os IDs de controlos e grupos de controlo. Esta propriedade não pode ser combinada com outras propriedades subordinadas do objeto de controlo porque os controlos incorporados não são personalizáveis por um suplemento.
tabs.groups.controls.label String 64 caracteres ✔️ Especifica o texto apresentado para o controlo. Apesar do comprimento máximo de 64 carateres, para alinhar corretamente o separador no friso, recomendamos que limite a etiqueta a 16 carateres.
tabs.groups.controls.icons Matriz ✔️ Define os ícones do controlo. Tem de haver, pelo menos, três objetos subordinados; cada um com size propriedades de 16, 32e 80 píxeis.
tabs.groups.controls.icons.size Número ✔️ Especifica o tamanho do ícone em píxeis, enumerado como 16,20,24,32,40,48,,8064..
Tamanhos de imagem necessários: 16, , 3280
tabs.groups.controls.icons.url URL Especifica o URL absoluto para o ficheiro de ícone.
tabs.groups.controls.supertip Objeto ✔️ Configura uma supertipa para o controlo. Uma supertipa é uma funcionalidade de IU que apresenta uma breve caixa de informações de ajuda sobre um controlo quando o cursor paira sobre o mesmo. A caixa pode conter múltiplas linhas de texto.
tabs.groups.controls.supertip.title String 64 caracteres ✔️ Especifica o texto de título da sobretipa.
tabs.groups.controls.supertip.description Cadeia de caracteres 128 caracteres ✔️ Especifica a descrição da sobretipa.
tabs.groups.controls.actionId String 64 caracteres Necessário se o tipo de controlo for button. Não utilize se o tipo de controlo for menu. Especifica o ID da ação que é efetuada quando um utilizador seleciona o controlo. O actionId tem de corresponder à runtime.actions.id propriedade de uma ação no runtimes objeto.
tabs.groups.controls.enabled Booliano Indica se o controlo está inicialmente ativado.
Valor predefinido: true
tabs.groups.controls.overriddenByRibbonApi Booliano Especifica se o controlo está oculto nas combinações de aplicações e plataformas que suportam a API (Office.ribbon.requestCreateControls). Esta API instala separadores contextuais personalizados no friso.
Valor predefinido: false
tabs.groups.builtInGroupId String 64 caracteres Especifica o ID de um grupo incorporado. Para obter mais informações, veja Localizar os IDs de controlos e grupos de controlo. Esta propriedade não pode ser combinada com outras propriedades subordinadas do objeto de grupo porque os grupos incorporados não são personalizáveis por um suplemento.
tabs.customMobileRibbonGroups Matriz 10 Define grupos de controlos no separador predefinido do friso num dispositivo móvel. Esta propriedade de matriz só pode estar presente em objetos de separador que tenham uma tabs.builtInTabId propriedade definida como DefaultTab. Para dispositivos não móveis, consulte tabs.groups acima.
tabs.customMobileRibbonGroups.id Cadeia de caracteres 250 carateres ✔️ Especifica o ID do grupo. Tem de ser diferente de qualquer ID de grupo incorporado na aplicação do Microsoft 365 e de qualquer outro grupo personalizado.
tabs.customMobileRibbonGroups.label Cadeia de caracteres 32 caracteres ✔️ Especifica a etiqueta no grupo.
tabs.customMobileRibbonGroups.controls Matriz 20 ✔️ Define os controlos no grupo. Apenas os botões móveis são suportados.
tabs.customMobileRibbonGroups.controls.id Cadeia de caracteres 250 carateres ✔️ Especifica o ID do controlo, como msgReadFunctionButton.
tabs.customMobileRibbonGroups.controls.type Enumeração de cadeias ✔️ Especifica o tipo de controlo. MobileButton só é suportado.
tabs.customMobileRibbonGroups.controls.label Cadeia de caracteres 32 caracteres ✔️ Especifica a etiqueta no controlo.
tabs.customMobileRibbonGroups.controls.actionId String 64 caracteres ✔️ Especifica o ID da ação que é efetuada quando um utilizador seleciona o controlo. O actionId tem de corresponder à runtime.actions.id propriedade de uma ação no runtimes objeto.
tabs.customMobileRibbonGroups.controls.icons Matriz 9 ✔️ Especifica os ícones que serão apresentados no controlo consoante as dimensões e o DPI do ecrã do dispositivo móvel. Tem de haver exatamente 9 ícones.
tabs.customMobileRibbonGroups.controls.icons.size Enumeração de números ✔️ Tamanho em píxeis do ícone. Os tamanhos possíveis são 25, 32 e 48. Tem de existir exatamente um de cada tamanho para cada valor possível da propriedade dos scale ícones.
tabs.customMobileRibbonGroups.controls.icons.url Cadeia de caracteres 2048 caracteres ✔️ O URL completo e absoluto do ficheiro de imagem do ícone.
tabs.customMobileRibbonGroups.controls.icons.scale Enumeração de números ✔️ Especifica a propriedade UIScreen.scale para dispositivos iOS. Os valores possíveis são 1, 2 e 3. Tem de existir exatamente um de cada valor para cada valor possível da propriedade dos size ícones.
fixedControls Matriz 1 Configura o botão de um suplemento integrado de relatórios de spam no Outlook. Tem de configurar se spamReportingOverride for especificado na extensions.ribbons.contexts matriz.
fixedControls.id String 64 caracteres ✔️ Especifica o ID exclusivo do botão de um suplemento spam-reporting.
fixedControls.type Cadeia de caracteres ✔️ Define o tipo de controlo de um suplemento spam-reporting.
Valor suportado: button
fixedControls.label String 64 caracteres ✔️ Especifica o texto que aparece no botão de um suplemento spam-reporting.
fixedControls.enabled Booliano ✔️ Esta propriedade tem de ser especificada no fixedControls objeto . No entanto, não afeta a funcionalidade de um suplemento de relatórios de spam.
Valor predefinido: True
fixedControls.icons Matriz 3 ✔️ Define os ícones do botão de um suplemento spam-reporting. Tem de existir, pelo menos, três objetos subordinados, cada um com tamanhos de ícone de 16, 32e 80 píxeis, respetivamente.
fixedControls.icons.size Número ✔️ Especifica o tamanho do ícone em píxeis, enumerado como 16, 20, 24, 32, 40, 48, 64e 80.
Tamanhos de imagem necessários: 16, , 3280
fixedControls.icons.url Cadeia de caracteres 2048 caracteres ✔️ Especifica o URL absoluto para o ícone.
fixedControls.supertip Objeto ✔️ Configura uma supertipa para o botão de um suplemento spam-reporting.
fixedControls.supertip.title String 64 caracteres ✔️ Especifica o texto de título da sobretipa.
fixedControls.supertip.description Cadeia de caracteres 250 carateres ✔️ Especifica a descrição da sobretipa.
fixedControls.actionId String 64 caracteres ✔️ Especifica o ID da ação executada quando um utilizador seleciona o botão de um suplemento spam-reporting. O actionId tem de corresponder à runtime.actions.id propriedade de uma ação no runtimes objeto.
spamPreProcessingDialog Objeto Configura a caixa de diálogo de pré-processamento de um suplemento integrado de relatórios de spam no Outlook.
spamPreProcessingDialog.title Cadeia de caracteres 128 caracteres ✔️ Especifica o título personalizado da caixa de diálogo de pré-processamento de um suplemento spam-reporting.
spamPreProcessingDialog.description Cadeia de caracteres 250 carateres ✔️ Especifica o texto personalizado que aparece na caixa de diálogo de pré-processamento de um suplemento spam-reporting.
spamPreProcessingDialog.spamReportingOptions Objeto Especifica até cinco opções que um utilizador pode selecionar na caixa de diálogo de pré-processamento para fornecer um motivo para comunicar uma mensagem.
spamPreProcessingDialog.spamReportingOptions.title Cadeia de caracteres 128 caracteres ✔️ Especifica o texto ou título personalizado para descrever as opções de relatório fornecidas na caixa de diálogo de pré-processamento.
spamPreProcessingDialog.spamReportingOptions.options Matriz de cadeias de caracteres 5 opções

128 carateres por opção
✔️ Especifica uma opção personalizada com uma caixa de verificação que um utilizador pode selecionar na caixa de diálogo de pré-processamento para fornecer um motivo para comunicar uma mensagem. Tem de especificar pelo menos uma opção. Pode ser incluído um máximo de cinco opções.
spamPreProcessingDialog.spamFreeTextSectionTitle Cadeia de caracteres 128 caracteres Adiciona uma caixa de texto à caixa de diálogo de pré-processamento para os utilizadores fornecerem informações adicionais sobre a mensagem que estão a comunicar. A cadeia fornecida nesta propriedade aparece acima da caixa de texto.
spamPreProcessingDialog.spamMoreInfo Objeto Configura uma ligação para fornecer recursos informativos a um utilizador. Na caixa de diálogo de pré-processamento, a ligação é apresentada abaixo do texto fornecido em spamPreProcessingDialog.description.
spamPreProcessingDialog.spamMoreInfo.text Cadeia de caracteres 128 caracteres ✔️ Especifica o texto da ligação para um URL que direciona os utilizadores para recursos informativos a partir da caixa de diálogo de pré-processamento.
spamPreProcessingDialog.spamMoreInfo.url Cadeia de caracteres 2048 caracteres ✔️ Especifica o URL HTTPS de um site que contém recursos informativos.

Para utilizar extensions.ribbonso , veja criar comandos de suplemento,configurar a IU para o comando do painel de tarefas e configurar a IU para o comando de função.

extensions.autoRunEvents

Opcional – Matriz

A extensions.autoRunEvents propriedade define pontos de extensão de ativação baseados em eventos.

Nome Tipo Tamanho máximo Obrigatório Descrição
events Matriz 20 ✔️ Configura o evento que faz com que as ações num Suplemento do Outlook são executadas automaticamente. Por exemplo, veja Utilizar alertas inteligentes e os OnMessageSend eventos e OnAppointmentSend nos seus Suplementos do Outlook.
events.type String 64 caracteres Especifica o tipo de evento. Para tipos suportados, veja eventos suportados.
events.actionId String 64 caracteres Identifica a ação que é efetuada quando o evento é acionado. O actionId tem de corresponder a runtime.actions.id.
events.options Objeto Configura a forma como o Outlook responde ao evento.
events.options.sendMode Cadeia de caracteres ✔️ Especifica as ações a efetuar durante uma ação de envio de correio.
Valores suportados: promptUser, , blocksoftBlock. Para obter mais informações, veja opções de modo de envio disponíveis.
requirements Objeto Especifica os âmbitos, formFactors e conjuntos de requisitos da Biblioteca JavaScript do Office que têm de ser suportados no cliente do Office para que o código de processamento de eventos seja executado. Para obter mais informações, consulte Especificar os requisitos do Suplemento do Office no manifesto unificado do Microsoft 365.
requirements.capabilities Matriz Identifica os conjuntos de requisitos.
Opções: name (obrigatório), minVersion, maxVersion
requirements.capabilities.name Cadeia de caracteres ✔️ Identifica o nome do conjunto de requisitos.
requirements.capabilities.minVersion Cadeia de caracteres Identifica a versão mínima do conjunto de requisitos.
requirements.capabilities.maxVersion Cadeia de caracteres Identifica a versão máxima do conjunto de requisitos.
requirements.scopes Matriz de enumerações 1 Identifica os âmbitos nos quais o suplemento pode ser executado e define as aplicações do Microsoft 365 nas quais a extensão pode ser executada. Por exemplo, mail (Outlook).
Valor suportado: mail
requirements.formFactors Matriz de enumerações Identifica os fatores de formulário que suportam o suplemento.
Valores suportados: mobile, desktop

extensions.alternates

A extensions.alternates propriedade é utilizada para ocultar ou atribuir prioridades a suplementos específicos no mercado quando tiver publicado vários suplementos com funcionalidades sobrepostas.

Nome Tipo Tamanho máximo Obrigatório Descrição
prefer Objeto Especifica a retrocompatibilidade com um suplemento COM equivalente, suplemento XLL ou ambos.
prefer.comAddin Objeto Especifica um suplemento COM que tem de ser utilizado em vez do Suplemento Web do Microsoft 365 para Windows.
prefer.comAddin.progId String 64 caracteres ✔️ Identifica o tipo de aplicação no qual a extensão pode ser executada.
hide Objeto Configura como ocultar outro suplemento que publicou sempre que o suplemento está instalado, para que os utilizadores não vejam ambos na IU do Microsoft 365. Por exemplo, utilize esta propriedade quando tiver publicado anteriormente um suplemento que utilize o manifesto da aplicação XML antigo e estiver a substituí-lo por uma versão que utilize o novo manifesto da aplicação JSON.
hide.storeOfficeAddin Objeto Especifica um Suplemento do Microsoft 365 disponível no Microsoft AppSource.
hide.storeOfficeAddin.officeAddinId String 64 caracteres ✔️ Especifica o ID do suplemento no mercado a ocultar. O GUID é retirado da propriedade do manifesto id da aplicação se o suplemento no mercado utilizar o manifesto da aplicação JSON. O GUID é retirado do <Id> elemento se o suplemento no mercado utilizar o manifesto da aplicação XML.
hide.storeOfficeAddin.assetId String 64 caracteres ✔️ Especifica o ID do recurso do AppSource do suplemento no mercado para ocultar.
hide.customOfficeAddin Objeto Configura como ocultar um suplemento no mercado que não é distribuído através do AppSource.
hide.customOfficeAddin.officeAddinId String 64 caracteres ✔️ Especifica o ID do suplemento no mercado a ocultar. O GUID é retirado da propriedade do manifesto id da aplicação se o suplemento no mercado utilizar o manifesto da aplicação JSON. O GUID é retirado do <Id> elemento se o suplemento no mercado utilizar o manifesto da aplicação XML.
requirements Objeto Especifica os âmbitos, formFactors e conjuntos de requisitos da Biblioteca JavaScript do Office que têm de ser suportados no cliente do Office para que as propriedades "ocultar", "preferir" ou "alternateIcons" entrem em vigor. Para obter mais informações, consulte Especificar os requisitos do Suplemento do Office no manifesto unificado do Microsoft 365.
requirements.capabilities Matriz Identifica os conjuntos de requisitos.
Opções: name (obrigatório), minVersion, maxVersion
requirements.capabilities.name Cadeia de caracteres ✔️ Identifica o nome do conjunto de requisitos.
requirements.capabilities.minVersion Cadeia de caracteres Identifica a versão mínima do conjunto de requisitos.
requirements.capabilities.maxVersion Cadeia de caracteres Identifica a versão máxima do conjunto de requisitos.
requirements.scopes Matriz de enumerações 1 Identifica os âmbitos nos quais o suplemento pode ser executado e define as aplicações do Microsoft 365 nas quais a extensão pode ser executada. Por exemplo, mail (Outlook).
Valor suportado: mail
requirements.formFactors Matriz de enumerações Identifica os fatores de formulário que suportam o suplemento.
Valores suportados: mobile, desktop
alternateIcons Objeto Especifica os ícones de main utilizados para representar o suplemento em versões mais antigas do Office. Esta propriedade é necessária se o suplemento do Office for instalável no Office para Mac, licenças perpétuas do Office e versões de subscrição do Microsoft 365 do Office no Windows anteriores à 2304 (Compilação 16320.00000).
alternateIcons.icon Objeto ✔️ Especifica as propriedades do ficheiro de imagem utilizado para representar o suplemento.
alternateIcons.icon.size Enumeração de números ✔️ Especifica o tamanho do ícone em píxeis, enumerado como 16,20,24,32,40,48,,8064..
Tamanhos de imagem necessários: 16, , 3280.
alternateIcons.icon.url Cadeia de caracteres 2048 caracteres ✔️ Especifica o URL absoluto completo do ficheiro de imagem que é utilizado para representar o suplemento. A imagem do ícone tem de ter 64 x 64 píxeis e utilizar um dos seguintes formatos de ficheiro: GIF, JPG, PNG, EXIF, BMP, TIFF.
alternateIcons.highResolutionIcon Objeto ✔️ Especifica as propriedades do ficheiro de imagem utilizado para representar o suplemento em ecrãs de PPP elevados.
alternateIcons.highResolutionIcon.size Enumeração de números ✔️ Especifica o tamanho do ícone em píxeis, enumerado como 16,20,24,32,40,48,,8064..
Tamanhos de imagem necessários: 16, , 3280.
alternateIcons.highResolutionIcon.url Cadeia de caracteres 2048 caracteres ✔️ Especifica o URL completo e absoluto do ficheiro de imagem que é utilizado para representar o suplemento em ecrãs de PPP elevados. A imagem do ícone tem de ter 128 x 128 píxeis e utilizar um dos seguintes formatos de ficheiro: GIF, JPG, PNG, EXIF, BMP, TIFF.

actions

Observação

O objeto é uma matriz de objetos de ação. Este bloco é necessário apenas para soluções que fornecem Ações.

Nome Tipo Tamanho máximo Obrigatório Descrição
id String 64 caracteres ✔️ Uma cadeia de identificador na região predefinida que é utilizada para catalogar ações. Tem de ser exclusivo em todas as ações para esta aplicação. Por exemplo, openDocInContoso.
displayName Cadeia de caracteres 64 caracteres ✔️ Um nome a apresentar para a ação. Colocar em maiúscula a primeira letra e o nome da marca. Por exemplo, Adicionar a fornecedores, Abrir na Contoso e Pedir assinaturas.
description Cadeia de caracteres ✔️ Especifica a descrição das ações.
intent Enumeração de cadeias ✔️ Especifica o tipo de intenção. Os valores de enumeração suportados são open, addToe custom.
handlers Matriz de objetos ✔️ Uma matriz de objetos de processador define como as Ações são geridas. Na pré-visualização pública atual, adicione um único processador para cada ação.

actions.handlers

Define os processadores da Ação. Os processadores são uma matriz de objetos de processador. Cada Ação tem de ter, pelo menos, um processador.

Nome Tipo Tamanho máximo Obrigatório Descrição
supportedObjects Objeto Objetos que definem que objetos podem acionar esta Ação.
type Enumeração de cadeias ✔️ Especifica o tipo de processador de Ações. O valor de enumeração suportado é openPage.
pageInfo Objeto Necessário se o tipo de processador for openPage. Objeto que contém metadados da página a abrir.

actions.handlers.supportedObjects

Os tipos de objeto suportados que podem acionar esta Ação.

Nome Tipo Tamanho máximo Obrigatório Descrição
file Objeto Tipos de ficheiro suportados.
file.extensions Matriz de cadeias de caracteres Matriz de cadeias. Extensões de ficheiro do tipo de ficheiro que a Ação pode acionar. Por exemplo, pdf e docx.

actions.handlers.pageInfo

Necessário se o tipo de processador for openPage. Objeto que contém metadados da página a abrir.

Nome Tipo Tamanho máximo Obrigatório Descrição
PageId Cadeia de caracteres Mapeia para o EntityId do separador estático.
SubPageId Cadeia de caracteres Mapeia para o SubEntityId do separador estático.

dashboardCards

Opcional – Matriz

Define uma lista de cartões que podem ser afixados a um dashboard, como Microsoft Viva Connections, para fornecer uma vista resumida das informações da aplicação. Para obter mais informações sobre como criar cartões para Viva Connections Dashboard, veja Descrição geral das Extensões de Cartão Adaptável Com Tecnologia de Bot.

A dashboardCards propriedade é uma matriz de elementos do tipo object.

dashboardCards.dashboardCard

Define um único dashboard card e as respetivas propriedades.

Nome Tipo Tamanho máximo Obrigatório Descrição
id Cadeia de caracteres ✔️ Um identificador exclusivo para este dashboard card. O ID tem de ser um GUID.
displayName Cadeia de caracteres 255 caracteres ✔️ Nome a apresentar do card.
description Cadeia de caracteres 255 caracteres ✔️ Descrição do card.
pickerGroupId Cadeia de caracteres ✔️ ID do grupo no seletor de card. O ID tem de ser um GUID.
icon Objeto Especifica o ícone do card.
contentSource Objeto ✔️ Especifica a origem do conteúdo do card
defaultSize Cadeia de caracteres ✔️ Tamanho da composição do dashboard card. Opções: medium ou large.

dashboardCards.dashboardCard.icon

Define as propriedades do ícone de um determinado dashboard card.

Nome Tipo Tamanho máximo Obrigatório Descrição
iconUrl Cadeia de caracteres 2048 caracteres Localização do ícone da card, a apresentar na caixa de ferramentas e card barra.
officeUIFabricIconName Cadeia de caracteres 255 caracteres Nome amigável do ícone da IU fluente ou UI Fabric do Office para o card. Este valor é utilizado se iconUrl não for especificado.

dashboardCards.dashboardCard.contentSource

Define a origem de conteúdo de uma determinada dashboard card.

Nome Tipo Tamanho máximo Obrigatório Descrição
sourceType Cadeia de caracteres Representa a origem do conteúdo de um card. Opção: bot.
botConfiguration Objeto A configuração da origem do bot. Necessário se estiver sourceType definido como bot.

dashboardCards.dashboardCard.contentSource.botConfiguration

Nome Tipo Tamanho máximo Obrigatório Descrição
botId Cadeia de caracteres O ID exclusivo do aplicativo Microsoft para o bot conforme registrado na estrutura do bot. O ID tem de ser um GUID.

Confira também