Configurar os tipos de guia interno no Microsoft Teams

  • Artigo

Para criar ou configurar uma guia do Microsoft Teams usando o Microsoft API do Graph, você precisa saber o teamsAppId do aplicativo e o entityId, contentUrl, removeUrle websiteUrl para fornecer esse tipo de aplicativo. Este artigo explica como obter esses valores para os tipos internos de guia.

Guias personalizadas

Para usar o Microsoft Graph para configurar uma guia associada a um provedor de guia que você escreveu, identifique o entityId, o contentUrl, o removeUrl e o websiteUrl que a interface do usuário de configuração do aplicativo fornece ao Microsoft Teams e passe os mesmos valores de entityId, contentUrl, removeUrl, e websiteUrl valores para o Microsoft Graph.

O teamsAppId é igual a id no esquema manifesto de aplicativo do Microsoft Teams.

Guias de site

Para as guias de site, o teamsAppId é com.microsoft.teamspace.tab.web. A configuração é a mostrada a seguir.

Propriedade Tipo Descrição
entityId string Nulo
contentUrl string URL do site
removeUrl string Nulo
websiteUrl string URL do site

Guias do Word, Excel, PowerPoint e PDF

A tabela a seguir lista o teamsAppId para cada aplicativo.

App teamsAppId tipo (extensão)
Word com.microsoft.teamspace.tab.file.staticviewer.word docx
Excel com.microsoft.teamspace.tab.file.staticviewer.excel xlsx
PowerPoint com.microsoft.teamspace.tab.file.staticviewer.powerpoint pptx
PDF com.microsoft.teamspace.tab.file.staticviewer.pdf pdf

A configuração é a mostrada a seguir.

Propriedade Tipo Descrição
entityId string A ID de sourceDoc do arquivo. Para encontrá-la, abra o arquivo no SharePoint e procure a barra de endereços - a URL terá uma cláusula sourcedoc=%7B{sourceDocId}%7D. Você também pode derivar isso na webUrl do item de unidade do SharePoint para o documento. Para saber mais, confira GET /groups/{group-id}/drive/items/{item-id}.
contentUrl string A URL do arquivo no formato {folder-webUrl}/{item-name}. {folder-webUrl} é a webUrl da pasta do SharePoint que contém o arquivo. Para localizá-la, abra o arquivo no SharePoint e procure na barra de endereços, ou use a propriedade webUrl em GET /groups/{group-id}/drive/items/{folder-item-id}. {item-name} é o nome do arquivo (por exemplo, file.docx), que é a propriedade name em GET /groups/{group-id}/drive/items/{item-id}.
removeUrl string Nulo
websiteUrl string Nulo

Exemplo: criar uma guia configurada do Word

O exemplo a seguir criar uma guia configurada do Word.

POST https://graph.microsoft.com/v1.0/teams/{team-id}/channels/{channel-id}/tabs
{
  "displayName": "word",
  "teamsApp@odata.bind" : "https://graph.microsoft.com/v1.0/appCatalogs/teamsApps/com.microsoft.teamspace.tab.file.staticviewer.word",
  "configuration": {
     "entityId": "115A90F4-AC9C-4F79-9837-36D1EFB3BE08",
     "contentUrl": "https://m365x165177.sharepoint.com/sites/4NewCloneWithClonableParts/Shared%20Documents/General/Employee Handbook.docx",
     "removeUrl": null,
     "websiteUrl": null
  }
}

Guias de biblioteca de documentos

Para as guias de biblioteca de documentos, o teamsAppId é com.microsoft.teamspace.tab.files.sharepoint. A configuração é a mostrada a seguir.

Propriedade Tipo Descrição
entityId cadeia de caracteres Cadeia de caracteres vazia ("")
contentUrl cadeia de caracteres A URL da pasta raiz da biblioteca de documentos. Você pode encontrar essa URL abrindo a pasta do SharePoint no navegador, copiando a URL e excluindo "/Forms/AllItems.aspx" e tudo depois disso.
removeUrl string Nulo
websiteUrl string Nulo

Exemplo: criar uma guia de biblioteca de documentos configurada

O exemplo a seguir cria uma guia de biblioteca de documentos configurada.

POST https://graph.microsoft.com/v1.0/teams/{team-id}/channels/{channel-id}/tabs
{
    "displayName": "Document%20Library1",
    "teamsApp@odata.bind": "https://graph.microsoft.com/v1.0/appCatalogs/teamsApps/com.microsoft.teamspace.tab.files.sharepoint",
    "configuration": {
        "entityId": "",
        "contentUrl": "https://microsoft.sharepoint.com/teams/WWWtest/Shared%20Documents",
        "removeUrl": null,
        "websiteUrl": null
    }
}

Guias da wiki

Para as guias da wiki, o teamsAppId é com.microsoft.teamspace.tab.wiki. As guias wiki não dão suporte à configuração por meio do Microsoft Graph. Observe, no entanto, que não há muito a ser configurado - em uma guia wiki não configurada, o primeiro usuário só precisa selecionar a guia Configurar para configurá-la.

Guias do Planner

Para guias Planner, o teamsAppId é com.microsoft.teamspace.tab.planner. Essa configuração não é compatível.

Guias do Microsoft Stream

Para as guias do Microsoft Stream, o teamsAppId é com.microsoftstream.embed.skypeteamstab. Essa configuração não é compatível.

Guias do Microsoft Forms

Para as guias do Microsoft Forms, o teamsAppId é 81fef3a6-72aa-4648-a763-de824aeafb7d. Essa configuração não é compatível.

Guias do OneNote

Para as guias do OneNote, o teamsAppId é 0d820ecd-def2-4297-adad-78056cde7c78. Essa configuração não é compatível.

Guias do Power BI

Para as guias do Power BI, o teamsAppId é com.microsoft.teamspace.tab.powerbi. Essa configuração não é compatível.

Guias de lista e de página do SharePoint

Para as guias de lista e de página do SharePoint, o teamsAppId é 2a527703-1f6f-4559-a332-d8a7d288cd88. Essa configuração não é compatível.

guias baseadas em Estrutura do SharePoint

Guias personalizadas criadas usando Estrutura do SharePoint podem ser criadas usando o Microsoft Graph, mas a configuração não tem suporte.

Conteúdo relacionado