Microsoft Teams の組み込みタブ タイプの構成Configuring the built-in tab types in Microsoft Teams

Microsoft Graph API を使用して Microsoft Teams タブを作成または構成するには、アプリの teamsAppId と、その種類のアプリ用に提供される entityIdcontentUrlremoveUrlwebsiteUrl について理解しておく必要があります。To create or configure a Microsoft Teams tab using Microsoft Graph APIs, you need to know the teamsAppId of the app, and the entityId, contentUrl, removeUrl, and websiteUrl to provide for that kind of app. この記事では、組み込みタブ タイプのこれらの値を取得する方法について説明します。This article explains how to get those values for the built-in tab types.

カスタム タブCustom tabs

Microsoft Graph を使用して、作成したタブ プロバイダー と関連付けるタブを構成するには、アプリの構成 UI が Microsoft Teams に提供する entityIdcontentUrlremoveUrlwebsiteUrl を識別し、同じ entityIdcontentUrlremoveUrlwebsiteUrl の値を Microsoft Graph に渡します。To use Microsoft Graph to configure a tab associated with a tab provider that you wrote, identify the entityId, contentUrl, removeUrl, and websiteUrl that the app's configuration UI provides to Microsoft Teams, and pass the same entityId, contentUrl, removeUrl, and websiteUrl values to Microsoft Graph.

teamsAppId は、Microsoft Teams のアプリ マニフェスト スキーマid と同じです。The teamsAppId is the same as the id in the app manifest schema for Microsoft Teams.

Web サイトのタブWebsite tabs

Web サイトのタブの場合、teamsAppIdcom.microsoft.teamspace.tab.web です。For website tabs, the teamsAppId is com.microsoft.teamspace.tab.web. 構成を次に示します。The following is the configuration.

プロパティProperty Type 説明Description
entityIdentityId stringstring NullNull
contentUrlcontentUrl stringstring Web サイトの URLURL of the website
removeUrlremoveUrl stringstring NullNull
websiteUrlwebsiteUrl stringstring Web サイトの URLURL of the website

Planner のタブPlanner tabs

Planner のタブの場合、teamsAppId は com.microsoft.teamspace.tab.planner です。For Planner tabs, the teamsAppId is com.microsoft.teamspace.tab.planner. 構成を次に示します。The following is the configuration.

プロパティProperty Type 説明Description
entityIdentityId stringstring プラン ID (GET /planner/plans/{id} で使用する ID)。The plan ID (the ID to use with GET /planner/plans/{id}).
contentUrlcontentUrl stringstring https://tasks.office.com/{tenantName}/Home/PlannerFrame?page=7&planId={planId}。ここで、{tenantName} はテナントの名前 (example.onmicrosoft.com など) で、{planId} はエンティティ ID と同じです。https://tasks.office.com/{tenantName}/Home/PlannerFrame?page=7&planId={planId}, where {tenantName} is the name of the tenant (such as example.onmicrosoft.com), and {planId} is the same as the entity ID.
removeUrlremoveUrl stringstring contentUrl と同じ値。Same value as the contentUrl.
websiteUrlwebsiteUrl stringstring contentUrl と同じ値。Same value as the contentUrl.

Planner タブに表示される新しいプランを作成するには、「plannerPlan の作成」を参照してください。To create a new plan to display in your planner tab, see create plannerPlan.

Microsoft Stream のタブMicrosoft Stream tabs

Microsoft Stream のタブの場合、teamsAppIdcom.microsoftstream.embed.skypeteamstab です。For Microsoft Stream tabs, the teamsAppId is com.microsoftstream.embed.skypeteamstab. 構成は以下のとおりです。The following is the configuration.

プロパティProperty Type 説明Description
entityIdentityId stringstring NullNull
contentUrlcontentUrl stringstring https://web.microsoftstream.com/embed/video/{id}?autoplay=false&showinfo=true&app=microsoftteams&l={locale}。ここで、{id} は、ビデオ ストリームの ID です。https://web.microsoftstream.com/embed/video/{id}?autoplay=false&showinfo=true&app=microsoftteams&l={locale}, where {id} is the ID of the video stream. ストリームの {id} を見つけるには、ブラウザーでストリームを開いて、URL を調べます。形式は、https://{domain}.microsoftstream.com/video/{id} になります。To find the {id} of a stream, open the stream in your browser and look at you the URL – it will be of the form https://{domain}.microsoftstream.com/video/{id}.
removeUrlremoveUrl stringstring NullNull
websiteUrlwebsiteUrl stringstring https://web.microsoftstream.com/video/{id}。ここで、{id} は、ビデオ ストリームの ID です。https://web.microsoftstream.com/video/{id}, where {id} is the ID of the video stream.

Microsoft Forms のタブMicrosoft Forms tabs

Microsoft Forms のタブの場合、teamsAppId81fef3a6-72aa-4648-a763-de824aeafb7d です。For Microsoft Forms tabs, the teamsAppId is 81fef3a6-72aa-4648-a763-de824aeafb7d. 構成を次に示します。The following is the configuration.

プロパティProperty Type 説明Description
entityIdentityId stringstring フォームの ID。The ID of the form. この値を定義し、Forms Web サイトのフォームに移動して、フォームの URL (https://forms.office.com/Pages/DesignPage.aspx#FormId={formId}) を見つけます。Define this value, navigate to the form in the Forms website, and find the URL of the form https://forms.office.com/Pages/DesignPage.aspx#FormId={formId}.
contentUrlcontentUrl stringstring https://forms.office.com/Pages/TeamsDesignPage.aspx?Host=Teams&lang={locale}&groupId={groupId}&tid={tid}&teamsTheme={theme}&upn={upn}&fragment=FormId%3D{formId}。ここで、{formId} はエンティティ ID と同じで、{locale}、{groupId}、{tid}、{upn} はリテラルです。https://forms.office.com/Pages/TeamsDesignPage.aspx?Host=Teams&lang={locale}&groupId={groupId}&tid={tid}&teamsTheme={theme}&upn={upn}&fragment=FormId%3D{formId}, where {formId} is the same as the entity ID, and {locale}, {groupId}, {tid}, {upn} are literals.
removeUrlremoveUrl stringstring NullNull
websiteUrlwebsiteUrl stringstring https://forms.office.com

Word、Excel、PowerPoint、PDF のタブWord, Excel, PowerPoint, and PDF tabs

次の表は、各アプリの teamsAppId の一覧を示しています。The following table lists the teamsAppId for each app.

アプリApp teamsAppIdteamsAppId 種類 (拡張子)type (extension)
WordWord com.microsoft.teamspace.tab.file.staticviewer.word docx
ExcelExcel com.microsoft.teamspace.tab.file.staticviewer.excel xlsx
PowerPointPowerPoint com.microsoft.teamspace.tab.file.staticviewer.powerpoint pptx
PDFPDF com.microsoft.teamspace.tab.file.staticviewer.pdf pdf

構成を次に示します。The following is the configuration.

プロパティProperty Type 説明Description
entityIdentityId stringstring ファイルの sourceDoc ID。The sourceDoc ID of the file. これは、SharePoint でファイルを開き、アドレス バーを見ると確認できます。URL に sourcedoc=%7B{sourceDocId}%7D 句があります。You can find this by opening the file in SharePoint and looking at the address bar – the URL will have a sourcedoc=%7B{sourceDocId}%7D clause. これは、ドキュメントの SharePoint ドライブ項目の webUrl から派生させることもできます。You can also derive this from the webUrl of the SharePoint drive item for the document. 詳細については、「GET /groups/{group-id}/drive/items/{item-id}」を参照してください。For details, see GET /groups/{group-id}/drive/items/{item-id}.
contentUrlcontentUrl 文字列string ファイルの URL ({folder-webUrl}/{item-name} 形式)。The URL of file in the format {folder-webUrl}/{item-name}. {folder-webUrl} はファイルを含む SharePoint フォルダーの webUrl です。これは SharePoint でファイルを開いてアドレス バーを確認するか、GET /groups/{group-id}/drive/items/{folder-item-id} から webUrl プロパティを使用することで確認できます。{folder-webUrl} is the webUrl of the SharePoint folder containing the file, which can be found by opening the file in SharePoint and looking at the address bar, or by using the webUrl property from GET /groups/{group-id}/drive/items/{folder-item-id}. {item-name} はファイル名です (例: file.docx)。これは GET /groups/{group-id}/drive/items/{item-id}name プロパティです。{item-name} is the file name (for example, file.docx), which is the name property in GET /groups/{group-id}/drive/items/{item-id}.
removeUrlremoveUrl stringstring NullNull
websiteUrlwebsiteUrl stringstring NullNull

例: 構成された Word タブを作成するExample: Create a configured Word tab

次の例では、構成された Word タブを作成します。The following example creates a configured Word tab.

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
  }
}

Wiki のタブWiki tabs

Wiki のタブの場合、teamsAppIdcom.microsoft.teamspace.tab.wiki です。For wiki tabs, the teamsAppId is com.microsoft.teamspace.tab.wiki. Wiki のタブは、Graph による構成をサポートしていません。Wiki tabs do not support configuration through Graph. ただし、構成が必要なものはそれほど多くありません。構成されていない Wiki のタブで、最初のユーザーが [セット アップ] タブを選択するだけで構成できます。Note, however, that there isn't much to configure -- in an un-configured wiki tab, the first user just needs to select Set up tab to configure it.

ドキュメント ライブラリのタブDocument library tabs

ドキュメント ライブラリのタブの場合、teamsAppIdcom.microsoft.teamspace.tab.files.sharepoint です。For document library tabs, the teamsAppId is com.microsoft.teamspace.tab.files.sharepoint. 構成を次に示します。The following is the configuration.

プロパティProperty Type 説明Description
entityIdentityId stringstring 空の文字列 ("")Empty string ("")
contentUrlcontentUrl stringstring ドキュメントライブラリのルートフォルダーの URL。The URL of the root folder of the document library. この URL を確認するには、ブラウザーで SharePoint フォルダーを開き、URL をコピーして、"/"/"/" を削除します。You can find this URL by opening the SharePoint folder in your browser, copying the URL, and deleting "/Forms/AllItems.aspx" and everything after that.
removeUrlremoveUrl stringstring NullNull
websiteUrlwebsiteUrl stringstring NullNull

例: 構成されたドキュメントライブラリタブを作成するExample: Create a configured document library tab

次の例では、構成された Word タブを作成します。The following example creates a configured Word tab.

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
    }
}

OneNote のタブOneNote tabs

OneNote のタブの場合、teamsAppId0d820ecd-def2-4297-adad-78056cde7c78 です。For OneNote tabs, the teamsAppId is 0d820ecd-def2-4297-adad-78056cde7c78. 構成は以下のとおりです。The following is the configuration.

プロパティProperty Type 説明Description
entityIdentityId stringstring {randomGuid}_{notebookId}。ここで、{randomGuid} は、生成する GUID です。{randomGuid}_{notebookId}, where {randomGuid} is a GUID you generate.
contentUrlcontentUrl stringstring フォームhttps://www.onenote.com/teams/TabContent?entityid=%7BentityId%7D&subentityid=%7BsubEntityId%7D&auth_upn=%7Bupn%7D&notebookSource=New&notebookSelfUrl=https%3A%2F%2Fwww.onenote.com%2Fapi%2Fv1.0%2FmyOrganization%2Fgroups%2F{groupId}%2Fnotes%2Fnotebooks%2F{notebookId}&oneNoteWebUrl={oneNoteWebUrl}&notebookName=note&ui={locale}&tenantId={tid}の URL。ここ{notebookId} {oneNoteWebUrl}で、はGET/groups/{id}/onenote/notebooksにあります。A URL of the form https://www.onenote.com/teams/TabContent?entityid=%7BentityId%7D&subentityid=%7BsubEntityId%7D&auth_upn=%7Bupn%7D&notebookSource=New&notebookSelfUrl=https%3A%2F%2Fwww.onenote.com%2Fapi%2Fv1.0%2FmyOrganization%2Fgroups%2F{groupId}%2Fnotes%2Fnotebooks%2F{notebookId}&oneNoteWebUrl={oneNoteWebUrl}&notebookName=note&ui={locale}&tenantId={tid}, where {notebookId} and {oneNoteWebUrl} can be found in GET /groups/{id}/onenote/notebooks. スラッシュは、エスケープする必要があります。Slashes must be escaped. {groupId}、{locale}、{tid} はリテラルです。{groupId}, {locale}, and {tid} are literals.
removeUrlremoveUrl stringstring フォームhttps://www.onenote.com/teams/TabRemove?entityid=%7BentityId%7D&subentityid=%7BsubEntityId%7D&auth_upn=%7Bupn%7D&notebookSource=New&notebookSelfUrl=https%3A%2F%2Fwww.onenote.com%2Fapi%2Fv1.0%2FmyOrganization%2Fgroups%2F{groupId}%2Fnotes%2Fnotebooks%2F{notebookId}&oneNoteWebUrl={oneNoteWebUrl}&notebookName=note&ui={locale}&tenantId={tid}の URL。ここ{notebookId} {oneNoteWebUrl}で、はGET/groups/{id}/onenote/notebooksにあります。A URL of the form https://www.onenote.com/teams/TabRemove?entityid=%7BentityId%7D&subentityid=%7BsubEntityId%7D&auth_upn=%7Bupn%7D&notebookSource=New&notebookSelfUrl=https%3A%2F%2Fwww.onenote.com%2Fapi%2Fv1.0%2FmyOrganization%2Fgroups%2F{groupId}%2Fnotes%2Fnotebooks%2F{notebookId}&oneNoteWebUrl={oneNoteWebUrl}&notebookName=note&ui={locale}&tenantId={tid}, where {notebookId} and {oneNoteWebUrl} can be found in GET /groups/{id}/onenote/notebooks. スラッシュは、エスケープする必要があります。Slashes must be escaped. {groupId}、{locale}、{tid} はリテラルです。{groupId}, {locale} and {tid} are literals.
websiteUrlwebsiteUrl 文字列string フォームの URL https://www.onenote.com/teams/TabRedirect?redirectUrl={oneNoteWebUrl}。ここで、oneNoteWebUrl は、GET /groups/{id}/onenote/notebooks で見つけることができます。A URL of the form https://www.onenote.com/teams/TabRedirect?redirectUrl={oneNoteWebUrl}, where oneNoteWebUrl can be found in GET /groups/{id}/onenote/notebooks

Power BI のタブPower BI tabs

Power BI のタブの場合、teamsAppIdcom.microsoft.teamspace.tab.powerbi です。For Power BI tabs, the teamsAppId is com.microsoft.teamspace.tab.powerbi. 構成はサポートされていません。Configuration is not supported.

SharePoint のページとリスト タブSharePoint page and list tabs

SharePoint のページとリスト タブの場合、teamsAppId2a527703-1f6f-4559-a332-d8a7d288cd88 です。For SharePoint page and list tabs, the teamsAppId is 2a527703-1f6f-4559-a332-d8a7d288cd88. 構成はサポートされていません。Configuration is not supported. タブを構成する必要がある場合は、Web サイトのタブの使用を検討してください。If you want to configure the tab, consider using a Website tab.