App-Manifest für öffentliche Entwicklervorschau
Informationen zum Aktivieren der Entwicklervorschau finden Sie unter Öffentliche Entwicklervorschau für Microsoft Teams.
Hinweis
Wenn Sie keine Entwicklervorschaufeatures verwenden, einschließlich der Ausführung persönlicher Teams-Registerkarten und Nachrichtenerweiterungen in Outlook und Microsoft 365-Apps, verwenden Sie stattdessen das App-Manifest (früher Teams-App-Manifest genannt) für allgemein verfügbare Features (GA).
App-Manifest beschreibt, wie die App in die Microsoft Teams-Plattform integriert wird. Ihr App-Manifest muss dem Schema entsprechen, das auf https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json
gehostet wird.
Beispiel-App-Manifest
{
"$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
}
]
}
}
Das Schema definiert die folgenden Eigenschaften:
$schema
Optional (aber empfohlen) – Zeichenfolge
Die https:// URL, die auf das JSON-Schema für das App-Manifest verweist.
manifestVersion
Erforderlich – Zeichenfolge
Die Version des App-Manifestschemas, das dieses Manifest verwendet.
Version
Erforderlich – Zeichenfolge
Die Version der jeweiligen App. Wenn Sie etwas in Ihrem App-Manifest aktualisieren, muss auch die Version erhöht werden. Auf diese Weise überschreibt das neue App-Manifest bei der Installation das vorhandene Manifest, und der Benutzer erhält die neue Funktionalität. Wenn diese App an den Microsoft Teams Store übermittelt wurde, muss das neue App-Manifest erneut übermittelt und erneut überprüft werden. Dann erhalten Benutzer dieser App das neue aktualisierte App-Manifest automatisch innerhalb weniger Stunden, nachdem es genehmigt wurde.
Wenn sich die von der App angeforderten Berechtigungen ändern, werden Benutzer aufgefordert, ein Upgrade durchzuführen und der App erneut zuzustimmen.
Diese Versionszeichenfolge muss dem SemVer-Standard entsprechen (MAJOR.MINOR.PATCH).
Hinweis
Wenn Ihre App ein Office-Add-In enthält, ist jedes Segment der Versionszeichenfolge auf maximal fünf Ziffern beschränkt. Die Zeichenfolgenerweiterungen für die Vorabversion und die Metadatenversion des Semver-Standards werden nicht unterstützt.
id
Erforderlich : Microsoft-App-ID
Die eindeutige, von Microsoft generierte Kennung für diese App. Das Format der ID ist GUID. Wenn Sie einen Bot über Microsoft Bot Framework registriert haben oder sich die Web-App Ihrer Registerkarte bereits bei Microsoft anmeldet, verfügen Sie möglicherweise bereits über eine ID und müssen sie hier eingeben. Andernfalls müssen Sie eine neue ID im Microsoft Application Registration Portal (Meine Anwendungen) generieren, hier eingeben und dann wiederverwenden, wenn Sie einen Bot hinzufügen.
developer
Erforderlich – Objekt
Gibt Informationen über den Entwickler und sein Unternehmen an. Für Teams Store-Apps muss der Wert mit den Werten übereinstimmen, die Sie im Partner Center-App-Übermittlungsformular angeben.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
name |
Zeichenfolge | 32 Zeichen | ✔️ | Der Anzeigename für den Entwickler. |
websiteUrl |
Zeichenfolge | 2048 Zeichen | ✔️ | Die https:// URL zur app-spezifischen Seite auf Ihrer Website. |
privacyUrl |
Zeichenfolge | 2048 Zeichen | ✔️ | Die https:// URL zur Datenschutzrichtlinie der App. |
termsOfUseUrl |
Zeichenfolge | 2048 Zeichen | ✔️ | Die https:// URL zu den Nutzungsbedingungen der App. |
mpnId |
String | 10 Zeichen | Die CCP-ID (Microsoft Cloud Partner Program) (früher als Microsoft Partner Network (MPN)-ID bezeichnet), die den Partner identifiziert, organization die App erstellt. Optional | |
contactInfo |
Objekt | Kontaktinformationen des App-Entwicklers. |
developer.contactInfo
Optional – Objekt
Ihre Kontaktinformationen, die von Kunden verwendet werden, um Sie über Teams-Chat oder E-Mail zu kontaktieren. Kunden benötigen möglicherweise zusätzliche Informationen, wenn sie Ihre App auswerten oder Abfragen zu Ihrer App haben, wenn sie nicht funktioniert. Kunden können Sich über den Teams-Chat mit Ihnen in Verbindung setzen. Bitten Sie daher Ihre IT-Administratoren, die externe Kommunikation in Ihrem organization zu aktivieren. Weitere Informationen finden Sie unter Vom Entwickler bereitgestellte App und Kontaktinformationen.
Hinweis
Sie müssen nur eine Kontakt-E-Mail-Adresse angeben.
Es wird empfohlen, Ihre Kundenabfragen rechtzeitig zu selektieren und diese intern in Ihrem organization weiterzuleiten, z. B. an andere Funktionen, um die Antworten zu erhalten. Es trägt dazu bei, die App-Einführung zu verbessern, das Vertrauen der Entwickler zu schaffen und den Umsatz zu steigern, wenn Sie die App monetarisieren.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
defaultsupport |
Object | ✔️ | Die Standardkontaktinformationen für Ihre App. | |
defaultsupport.userEmailsForChatSupport |
Array | 10 | ✔️ | Email Adresse, um Kundenanfragen über den Teams-Chat zu empfangen. Während das App-Manifest bis zu 10 E-Mail-Adressen zulässt, verwendet Teams nur die erste E-Mail-Adresse, damit IT-Administratoren mit Ihnen kommunizieren können. Das Objekt ist ein Array mit allen Elementen des Typs Zeichenfolge. Die maximale Länge von E-Mails beträgt 80 Zeichen. |
defaultsupport.emailsForEmailSupport |
Array | 1 | ✔️ | Kontakt-E-Mail für Kundenanfrage (Minimum: 1; maximum: 1). Das Objekt ist ein Array mit allen Elementen des Typs Zeichenfolge. Die maximale Länge von E-Mails beträgt 80 Zeichen. |
localizationInfo
Optional – Objekt
Ermöglicht die Angabe einer Standardsprache und Zeiger auf zusätzliche Sprachdateien. Siehe Lokalisierung.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
defaultLanguageTag |
String | ✔️ | Das Sprachtag für die Zeichenfolgen in dieser App-Manifestdatei. Beispiel: en |
|
defaultLanguageFile |
Zeichenfolge | 2048 Zeichen | Ein relativer Dateipfad zur .json Datei, die die Zeichenfolgen enthält. Wenn nicht angegeben, werden Zeichenfolgen direkt aus der App-Manifestdatei übernommen. Für Copilot-Agents, die mehrere Sprachen unterstützen, ist eine Standardsprachdatei erforderlich. |
localizationInfo.additionalLanguages
Ein Array von -Objekten mit den folgenden Eigenschaften, um zusätzliche Sprachübersetzungen anzugeben.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
languageTag |
String | ✔️ | Das Sprachtag der Zeichenfolgen in der bereitgestellten Datei. Beispiel: es |
|
file |
Zeichenfolge | 2048 Zeichen | ✔️ | Ein relativer Dateipfad zur .json Datei, die die übersetzten Zeichenfolgen enthält. |
name
Erforderlich – Objekt
Der Name Ihrer App-Lösung, der Benutzern in der Microsoft Teams-Umgebung angezeigt wird. Für Apps, die an AppSource übermittelt werden, müssen diese Werte mit den Informationen in Ihrem AppSource-Eintrag übereinstimmen. Die Werte von short
und full
müssen unterschiedlich sein.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
short |
String | 30 Zeichen | ✔️ | Der Kurzanzeigename für die App. |
full |
String | 100 Zeichen | ✔️ | Der vollständige Name der App. Sie wird verwendet, wenn der vollständige App-Name 30 Zeichen überschreitet. |
abbreviated |
String | 15 Zeichen | Abgekürzter Name für die App; wird als Anzeigename auf der App-Leiste auf der linken Seite der Benutzeroberfläche verwendet. Wenn nicht angegeben, short wird der Name auf der App-Leiste verwendet. |
description
Erforderlich – Objekt
Beschreibt Ihre App für Benutzer. Für Apps, die an AppSource übermittelt werden, müssen diese Werte mit den Informationen in Ihrem AppSource-Eintrag übereinstimmen.
Stellen Sie sicher, dass Ihre Beschreibung Ihre Erfahrung genau beschreibt und Informationen bereitstellt, die potenziellen Kunden helfen, zu verstehen, was Ihre Erfahrung bewirkt. Sie müssen in der vollständigen Beschreibung angeben, ob ein externes Konto für die Verwendung der App erforderlich ist. Die Werte von short
und full
müssen unterschiedlich sein. Ihre Kurzbeschreibung darf innerhalb der Langbeschreibung nicht wiederholt werden und keinen anderen App-Namen enthalten.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
short |
String | 80 Zeichen | ✔️ | Eine kurze Beschreibung der App; wird verwendet, wenn der Platz begrenzt ist. |
full |
String | 4.000 Zeichen | ✔️ | Die vollständige Beschreibung Ihrer App. |
Symbole
Erforderlich – Objekt
Symbole, die in der Microsoft Teams-App verwendet werden. Die Symboldateien müssen als Teil des Uploadpakets enthalten sein.
Name | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|
outline |
2048 Zeichen | ✔️ | Ein relativer Dateipfad zu einem transparenten, 32 x 32 Pixel großen PNG-Kontursymbol. Die Rahmenfarbe muss weiß sein. |
color |
2048 Zeichen | ✔️ | Ein relativer Dateipfad zu einem farbigen, 192 x 192 Pixel großen PNG-Symbol. |
color32x32 |
2048 Zeichen | Ein relativer Dateipfad zu einem vollfarbigen 32x32 PNG-Symbol mit transparentem Hintergrund. Wird verwendet, wenn die App in Outlook und der Microsoft 365-App angeheftet wird. |
accentColor
Erforderlich – Zeichenfolge
Eine Farbe, die mit und als Hintergrund für Ihre Gliederungssymbole verwendet werden soll.
Bei dem Wert muss es sich um einen gültigen HTML-Farbcode handeln, der mit "#" beginnt, z. B. #4464ee
.
elementRelationshipSet
Optional – Objekt
Beschreibt Beziehungen zwischen einzelnen App-Funktionen, einschließlich staticTabs
, configurableTabs
, composeExtensions
und bots
. Es wird verwendet, um Laufzeitabhängigkeiten anzugeben, um sicherzustellen, dass die App nur in entsprechenden Microsoft 365-Hosts wie Teams, Outlook und der Microsoft 365 (Office)-App gestartet wird. Weitere Informationen finden Sie unter Angeben von Laufzeitanforderungen in Ihrem App-Manifest.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
oneWayDependencies |
Array | Definiert eine oder mehrere unidirektionale Abhängigkeitsbeziehungen zwischen App-Komponenten (die jeweils durch ein oneWayDependency -Objekt mit einem abhängigenelement und einem dependsOn element dargestellt werden). |
||
mutualDependencies |
Array | Definiert eine oder mehrere gegenseitige Abhängigkeitsbeziehungen zwischen App-Funktionen (die jeweils durch ein mutualDependency Array von element -Objekten dargestellt werden). |
Element
Optional – Objekt
Beschreibt eine App-Funktion (element
) in einem elementRelationshipSet
.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
name |
Zeichenfolgenenumeration | ✔️ | Der Typ der App-Funktion. Unterstützte Werte: bots , staticTabs , composeExtensions , configurableTabs |
|
id |
String | ✔️ | Wenn mehrere Instanzen eines Bots, einer Registerkarte oder einer Nachrichtenerweiterung vorhanden sind, definiert diese Eigenschaft eine bestimmte instance der Funktion. Sie wird botId für Bots, entityId für statische Registerkarten und id für konfigurierbare Registerkarten und Nachrichtenerweiterungen zugeordnet. |
|
commandIds |
Array aus Zeichenfolgen | Liste mit einem oder mehreren Nachrichtenerweiterungsbefehlen, die von der angegebenen dependsOn Funktion abhängig sind. Verwenden Sie nur für Nachrichtenerweiterungen. |
elementRelationshipSet.oneWayDependency
Beschreibt die unidirektionale Abhängigkeit einer App-Funktion (X) zu einer anderen (Y). Wenn ein Microsoft 365-Laufzeithost keine erforderliche Funktion (Y) unterstützt, wird die abhängige Funktion (X) nicht geladen oder für den Benutzer angezeigt.
Optional – Objekt
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
element |
Object | ✔️ | Stellt eine einzelne App-Funktion (dargestellt durch element ) dar, die eine unidirektionale Laufzeitabhängigkeit von einer anderen geladenen Funktion aufweist. |
|
dependsOn |
Array | ✔️ | Definiert eine oder mehrere App-Funktionen (jeweils dargestellt durch element ), die zum Laden des angegebenen element erforderlich sind. |
elementRelationshipSet.mutualDependencies
Beschreibt eine Reihe von gegenseitigen Abhängigkeiten zwischen zwei oder mehr App-Funktionen. Ein Microsoft 365-Laufzeithost muss alle erforderlichen Funktionen unterstützen, damit diese Funktionen für Benutzer auf diesem Host verfügbar sind.
Optional : Array von Arrays (jedes enthält zwei oder mehr element
Objekte)
copilotAgents
Optional – Objekt
Definiert einen oder mehrere Agents zum Microsoft 365 Copilot (früher bekannt als copilotExtensions
).
Deklarative Agents sind Anpassungen von Microsoft 365 Copilot, die auf demselben Orchestrator- und Basismodell (früher bekannt als declarativeCopilots
) ausgeführt werden.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
declarativeAgents |
Array mit Objekten | 1 | ✔️ | Array von Objekten, die jeweils einen deklarativen Agent definieren. |
declarativeAgents
Stellt eine Anpassung von Microsoft 365 Copilot dar, wie durch die Manifestdatei definiert.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | ✔️ | Eindeutiger Bezeichner für den Agent. Wenn Sie Microsoft Copilot Studio zum Erstellen von Agents verwenden, wird dies automatisch generiert. Andernfalls weisen Sie den Wert manuell gemäß Ihren eigenen Konventionen oder Präferenzen zu. | |
file |
String | ✔️ | Relativer Pfad innerhalb des App-Pakets zur Manifestdatei des deklarativen Agents . |
configurableTabs
Optional – Array
Wird verwendet, wenn Ihre App-Erfahrung über eine Teamkanalregisterkarte verfügt, die eine zusätzliche Konfiguration erfordert, bevor sie hinzugefügt wird. Konfigurierbare Registerkarten werden nur im Teams-Bereich unterstützt, und es wird nur eine Registerkarte pro App unterstützt.
Das Objekt ist ein Array, wobei alle Elemente vom Typ object
sind. Dieser Block ist nur für Lösungen erforderlich, die eine konfigurierbare Channel-Tab-Lösung bereitstellen.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | Eindeutiger Bezeichner für die konfigurierbare Registerkarte. Wird beim Definieren unidirektionaler und gegenseitiger Abhängigkeiten von App-Funktionen unter elementRelationshipSet verwendet. | ||
configurationUrl |
Zeichenfolge | 2048 Zeichen | ✔️ | Die https:// URL, die beim Konfigurieren der Registerkarte verwendet werden soll. |
canUpdateConfiguration |
Boolesch | Der Wert, der angibt, ob eine Instanz der Registerkartenkonfiguration nach der Erstellung vom Benutzer aktualisiert werden kann. Standardwert: true |
||
scopes |
Array von Enumerationen | 2 | ✔️ | Konfigurierbare Registerkarten unterstützen nur die team Bereiche und groupChat . |
context |
Array von Enumerationen | 8 | Die Gruppe von contextItem -Bereichen, in denen eine Registerkarte unterstützt wird. Standardwerte: channelTab , privateChatTab , meetingChatTab , meetingDetailsTab , meetingSidePanel , meetingStage , , . personalTab |
|
sharePointPreviewImage |
Zeichenfolge | 2048 Zeichen | Ein relativer Dateipfad zu einem Registerkartenvorschaubild zur Verwendung in SharePoint. Größe: 1024 x 768. | |
supportedSharePointHosts |
Array von Enumerationen | 2 | Definiert, wie Ihre Registerkarte in SharePoint zur Verfügung gestellt wird. Optionen sind sharePointFullPage , sharePointWebPart |
|
meetingSurfaces |
Array von Enumerationen | 2 | Der Satz von meetingSurfaceItem Bereichen, zu denen eine Registerkarte gehört. Standardwerte: sidePanel , stage |
|
supportedPlatform |
Array von Enumerationen | 3 | Der Satz von supportedPlatform Bereichen, zu denen eine Registerkarte gehört. Standardwerte: desktop , mobile , teamsMeetingDevices |
staticTabs
Optional – Array
Definiert einen Satz von Registerkarten, die standardmäßig angeheftet werden können, ohne dass der Benutzer sie manuell hinzufügt. Im personal
-Bereich deklarierte statische Registerkarten werden immer an die persönliche Benutzeroberfläche der App angeheftet. Die angehefteten Registerkarten können jedoch neu angeordnet werden, indem die Details der Registerkarte in der gewünschten Reihenfolge hinzugefügt werden. Weitere Informationen finden Sie unter Neuanordnen statischer persönlicher Registerkarten.
Mit dieser Eigenschaft können Sie auch die Standardzielfunktion für eine App festlegen, die sowohl Registerkarten- als auch Botfunktionen im persönlichen Bereich unterstützt. Weitere Informationen finden Sie unter Konfigurieren der Standardzielfunktion.
Rendern Sie Registerkarten mit adaptiven Karten, contentBotId
indem Sie anstelle contentUrl
von im staticTabs-Block angeben.
Das Objekt ist ein Array (maximal 16 Elemente) mit allen Elementen vom Typ object
. Dieser Block ist nur für Lösungen erforderlich, die eine Lösung mit statischen Registerkarten bereitstellen.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
entityId |
String | 64 Zeichen | ✔️ | Ein eindeutiger Bezeichner für die Entität, die auf der Registerkarte angezeigt wird. |
name |
Zeichenfolge | 128 Zeichen | Der Anzeigename der Registerkarte. | |
contentUrl |
Zeichenfolge | 2048 Zeichen | Die https:// URL, die auf die Entitäts-UI verweist, die im Teams-Canvas angezeigt werden soll. | |
contentBotId |
String | Die für den Bot im Bot Framework-Portal angegebene Microsoft Teams-App-ID. | ||
websiteUrl |
Zeichenfolge | 2048 Zeichen | Die https:// URL, auf die verweist, wenn ein Benutzer sich für die Anzeige in einem Browser entscheidet. | |
scopes |
Array von Enumerationen | 3 | ✔️ | Statische Registerkarten unterstützen die personal Bereiche , team und groupChat , was bedeutet, dass sie als Teil der persönlichen Benutzeroberfläche, des Gruppenchats und der Kanalbesprechungen bereitgestellt werden können. |
searchUrl |
Zeichenfolge | 2048 Zeichen | Die https:// URL, um die Suchabfragen eines Benutzers zu leiten. | |
context |
Array von Enumerationen | 8 | Der Satz von contextItem Bereichen, zu denen eine Registerkarte gehört. Standardwerte: personalTab , channelTab , privateChatTab , meetingChatTab , meetingDetailsTab , meetingSidePanel , , meetingStage teamLevelApp |
|
supportedPlatform |
Array von Enumerationen | 3 | Der Satz von supportedPlatform Bereichen, zu denen eine Registerkarte gehört. Standardwerte: desktop , mobile , teamsMeetingDevices |
|
requirementSet |
Objekt | Laufzeitanforderungen für die ordnungsgemäße Funktion der Registerkarte in der Microsoft 365-Hostanwendung. Wenn mindestens eine der Anforderungen vom Laufzeithost nicht unterstützt wird, lädt der Host die Registerkarte nicht. |
staticTabs.requirementSet
Optional – Objekt
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
requirementSet.hostMustSupportFunctionalities |
Array mit Objekten | ✔️ | Gibt mindestens eine Laufzeitfunktion an, die die Registerkarte benötigt, um ordnungsgemäß zu funktionieren. Unterstützte Werte: dialogUrl , dialogUrlBot , dialogAdaptiveCard , dialogAdaptiveCardBot . Weitere Informationen finden Sie unter Angeben von Laufzeitanforderungen in Ihrem App-Manifest. |
Bots
Optional – Array
Definiert eine Bot-Lösung zusammen mit optionalen Informationen wie Standardbefehlseigenschaften.
Das Objekt ist ein Array (maximal 1 Element – nur ein Bot ist pro App zulässig) mit allen Elementen des Typs object
. Dieser Block ist nur für Lösungen erforderlich, die einen Bot umfassen.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
botId |
String | ✔️ | Die eindeutige Microsoft-App-ID für den Bot, wie bei Bot Framework registriert. Die ID kann mit der Gesamt-App-IDübereinstimmen. | |
needsChannelSelector |
Boolesch | Beschreibt, ob der Bot einen Benutzerhinweis verwendet, um den Bot einem bestimmten Kanal hinzuzufügen. Standardwert: false |
||
isNotificationOnly |
Boolesch | Gibt an, ob ein Bot ein unidirektionaler Bot ausschließlich für Benachrichtigungen ist (im Gegensatz zu einem dialogorientierten Bot). Standardwert: false |
||
supportsFiles |
Boolesch | Gibt an, ob der Bot die Möglichkeit zum Hochladen/Herunterladen von Dateien in persönliche Chats unterstützt. Standardwert: false |
||
scopes |
Array von Enumerationen | 3 | ✔️ | Gibt an, ob der Bot eine Umgebung im Kontext eines Kanals in einem team oder Gruppenchat (groupChat ) ist, oder aber eine Umgebung einzig für einen bestimmten Benutzer (personal ). Diese Optionen sind nicht eindeutig. |
supportsCalling |
Boolesch | Ein Wert, der angibt, wo ein Bot Audioanrufe unterstützt.
WICHTIG: Diese Eigenschaft ist experimentell. Experimentelle Eigenschaften sind möglicherweise unvollständig und werden möglicherweise geändert, bevor sie vollständig verfügbar sind. Die Eigenschaft wird nur zu Test- und Erforschungszwecken bereitgestellt und darf nicht in Produktionsanwendungen verwendet werden. Standardwert: false |
||
supportsVideo |
Boolescher Wert | Ein Wert, der angibt, wo ein Bot Videoanrufe unterstützt.
WICHTIG: Diese Eigenschaft ist experimentell. Experimentelle Eigenschaften sind möglicherweise unvollständig und werden möglicherweise geändert, bevor sie vollständig verfügbar sind. Die Eigenschaft wird nur zu Test- und Erforschungszwecken bereitgestellt und darf nicht in Produktionsanwendungen verwendet werden. Standardwert: false |
||
requiresSecurityEnabledGroup |
Boolesch | Ein Wert, der angibt, ob die Office-Gruppe des Teams sicherheitsfähig sein muss. Standardwert: false |
||
requirementSet |
Objekt | Laufzeitanforderungen für die ordnungsgemäße Funktion des Bots in der Microsoft 365-Hostanwendung. Wenn mindestens eine der Anforderungen vom Laufzeithost nicht unterstützt wird, lädt der Host den Bot nicht. |
bots.configuration
Optional – Objekt
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
team.fetchTask |
Boolescher Wert | ✔️ | Ein boolescher Wert, der angibt, ob der Dialog (in TeamsJS v1.x als Aufgabenmodul bezeichnet) dynamisch abgerufen werden soll. Standardwert: false |
|
team.taskInfo |
Objekt | ✔️ | Das Dialogfeld, das bei Verwendung eines Bots vorab geladen werden soll. | |
team.taskInfo.title |
String | 64 Zeichen | ✔️ | Titel des ersten Dialogfelds. |
team.taskInfo.width |
Zeichenfolge | 16 Zeichen | Die Dialogbreite ist entweder eine Zahl in Pixel oder ein Standardlayout wie large , medium oder small . |
|
team.taskInfo.height |
String | 16 Zeichen | Die Höhe des Dialogfelds ist entweder eine Zahl in Pixel oder ein Standardlayout wie large , medium oder small . |
|
team.taskInfo.url |
Zeichenfolge | 2048 Zeichen | Anfängliche WebView-URL. | |
groupChat.fetchTask |
Boolesch | ✔️ | Ein boolescher Wert, der angibt, ob der Dialog dynamisch abgerufen werden soll. Standardwert: false |
|
groupChat.taskInfo |
Objekt | Dialogfeld, das gestartet werden soll, wenn der Abruftask auf false festgelegt ist. Standardwert: false |
||
groupChat.taskInfo.title |
String | 64 Zeichen | ✔️ | Titel des ersten Dialogfelds. |
groupChat.taskInfo.width |
Zeichenfolge | 16 Zeichen | Die Dialogbreite ist entweder eine Zahl in Pixel oder ein Standardlayout wie large , medium oder small . |
|
groupChat.taskInfo.height |
String | 16 Zeichen | Die Höhe des Dialogfelds ist entweder eine Zahl in Pixel oder ein Standardlayout wie large , medium oder small . |
|
groupChat.taskInfo.url |
Zeichenfolge | 2048 Zeichen | Anfängliche WebView-URL. |
bots.commandLists
Optional – Array
Eine optionale Liste von Befehlen, die Ihr Bot Benutzern vorschlagen kann. Das Objekt ist ein Array (maximal 3 Elemente) mit allen Elementen des Typs object
. Sie müssen eine separate Befehlsliste für jeden Bereich definieren, den Ihr Bot unterstützt. Weitere Informationen finden Sie unter Bot-Menüs.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
scopes |
Array von Enumerationen | 3 | ✔️ | Gibt den Bereich an, für den die Befehlsliste gültig ist. Mögliche Optionen sind team , personal und groupChat . |
commands |
Array mit Objekten | 10 | ✔️ | Ein Array von Befehlen, die der Bot unterstützt. |
bots.commandLists.commands
Erforderlich – Array
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
title |
Zeichenfolge | 32 Zeichen | ✔️ | Der Name des Bot-Befehls. |
description |
Zeichenfolge | 128 Zeichen | ✔️ | Eine einfache Textbeschreibung oder ein Beispiel für die Befehlssyntax und zugehörige Argumente. |
bots.requirementSet
Optional – Objekt
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
requirementSet.hostMustSupportFunctionalities |
Array mit Objekten | ✔️ | Gibt eine oder mehrere Laufzeitfunktionen an, die der Bot benötigt, um ordnungsgemäß zu funktionieren. Unterstützte Werte: dialogUrl , dialogUrlBot , dialogAdaptiveCard , dialogAdaptiveCardBot . Weitere Informationen finden Sie unter Angeben von Laufzeitanforderungen in Ihrem App-Manifest. |
connectors
Optional – Array
Der connectors
-Block definiert einen Connector für Microsoft 365-Gruppen für die App.
Das Objekt ist ein Array (maximal 1 Element) mit allen Elementen vom Typ object
. Dieser Block ist nur für Lösungen erforderlich, die einen Connector bereitstellen. Pro App wird nur ein Connector unterstützt.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
configurationUrl |
Zeichenfolge | 2048 Zeichen | Die https:// URL, die beim Konfigurieren des Connectors mithilfe der Inlinekonfiguration verwendet werden soll. | |
connectorId |
String | 64 Zeichen | ✔️ | Ein eindeutiger Bezeichner für den Connector, der seiner ID im Connectors Developer Dashboard entspricht. |
scopes |
Array von Enumerationen | 1 | ✔️ | Gibt an, ob der Connector eine Umgebung im Kontext eines Kanals in einem team oder aber eine Umgebung einzig für einen bestimmten Benutzer (personal ) bietet. Der team Bereich wird nur unterstützt. |
composeExtensions
Optional – Array
Definiert eine Nachrichtenerweiterung für die App.
Hinweis
Der Name des Features wurde im November 2017 von "Compose-Erweiterung" in "Nachrichtenerweiterung" geändert, aber der Name des App-Manifests bleibt unverändert, sodass vorhandene Erweiterungen weiterhin funktionieren.
Das Objekt ist ein Array (maximal 1 Element) mit allen Elementen vom Typ object
. Dieser Block ist nur für Lösungen erforderlich, die eine Nachrichtenerweiterung bereitstellen.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | Eindeutiger Bezeichner für die Nachrichtenerweiterung. Wird beim Definieren unidirektionaler und gegenseitiger Abhängigkeiten von App-Funktionen unter elementRelationshipSet verwendet. | ||
botId |
String | Die eindeutige Microsoft-App-ID für den Bot, welcher der Nachrichtenerweiterung zugeordnet ist, wie beim Bot Framework registriert. Die ID kann mit der Gesamt-App-IDübereinstimmen. | ||
composeExtensionType |
String | Typ der Nachrichtenerweiterung. Enumerationswerte sind botBased und apiBased . |
||
authorization |
Objekt | 2 | Autorisierungsbezogene Informationen für die API-basierte Nachrichtenerweiterung | |
authorization.authType |
String | Enumeration möglicher Autorisierungstypen. Unterstützte Werte sind none , apiSecretServiceAuth und microsoftEntra . |
||
authorization.microsoftEntraConfiguration |
Objekt | Objekterfassungsdetails, die für den MicrosoftEntra-Authentifizierungsfluss erforderlich sind. Gilt nur, wenn der Authentifizierungstyp ist microsoftEntra . |
||
authorization.microsoftEntraConfiguration.supportsSingleSignOn |
Boolesch | Ein Wert, der angibt, ob einmaliges Anmelden für die App konfiguriert ist. | ||
authorization.apiSecretServiceAuthConfiguration |
Objekt | Objekterfassungsdetails, die für die Dienstauthentifizierung erforderlich sind. Gilt nur, wenn der Authentifizierungstyp ist apiSecretServiceAuth . |
||
authorization.apiSecretServiceAuthConfiguration.apiSecretRegistrationId |
Zeichenfolge | 128 Zeichen | Die Registrierungs-ID wird zurückgegeben, wenn der Entwickler den API-Schlüssel über das Entwicklerportal übermittelt. | |
apiSpecificationFile |
Zeichenfolge | 2048 Zeichen | Ein relativer Dateipfad zur API-Spezifikationsdatei im Manifestpaket. | |
canUpdateConfiguration |
Boolesch | Ein Wert, der angibt, ob die Konfiguration einer Nachrichtenerweiterung vom Benutzer aktualisiert werden kann. Standardwert: true |
||
commands |
Array mit Objekten | 10 | Array von Befehlen, die von der Nachrichtenerweiterung unterstützt werden. | |
messageHandlers |
Array mit Objekten | 5 | Eine Liste von Handlern, mit denen Apps aufgerufen werden können, wenn bestimmte Bedingungen erfüllt sind. Domänen müssen auch in validDomains aufgeführt sein. |
|
messageHandlers.type |
String | Der Typ des Nachrichtenhandlers. Muss link sein. |
||
messageHandlers.value.domains |
Array von Zeichenfolgen | 2048 Zeichen | Array von Domänen, für die sich der Link-Nachrichtenhandler registrieren kann. | |
messageHandlers.supportsAnonymizedPayloads |
Boolesch | Ein boolescher Wert, der angibt, ob der Linknachrichtenhandler der App anonymen Aufrufflow unterstützt. Standardwert: false Um keine Installation für die Linkentflechtung zu aktivieren, muss der Wert auf true festgelegt werden. Hinweis: Die -Eigenschaft supportAnonymousAccess wird durch supportsAnonymizedPayloads ersetzt. |
||
type |
Typ der Nachrichtenerweiterung. Unterstützte Werte sind apiBased oder botBased . |
|||
requirementSet |
Objekt | Laufzeitanforderungen für die ordnungsgemäße Funktion der Nachrichtenerweiterung in der Microsoft 365-Hostanwendung. Wenn mindestens eine der Anforderungen vom Laufzeithost nicht unterstützt wird, lädt der Host die Nachrichtenerweiterung nicht. |
composeExtensions.commands
Ihre Nachrichtenerweiterung muss einen oder mehrere Befehle deklarieren. Jeder Befehl wird in Teams als potenzielle Interaktion vom BENUTZEROBERFLÄCHEN-basierten Einstiegspunkt angezeigt. Es gibt maximal 10 Befehle.
Jedes Befehlselement ist ein Objekt mit folgender Struktur:
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | 64 Zeichen | ✔️ | Die ID für den Befehl. |
type |
String | 64 Zeichen | Der Befehlstyp. Entweder query oder action . Standard: query |
|
samplePrompts |
Array | 5 | Eigenschaft, die von Microsoft 365 Copilot verwendet wird, um vom Plug-In unterstützte Eingabeaufforderungen für den Benutzer anzuzeigen. Für Microsoft 365 Copilot Szenarien ist diese Eigenschaft erforderlich, um die App-Überprüfung für die Store-Übermittlung zu bestehen. | |
samplePrompts.text |
string | 128 Zeichen | ✔️ | Inhalt der Beispielaufforderung. |
apiResponseRenderingTemplateFile |
Zeichenfolge | 2048 Zeichen | Ein relativer Dateipfad für die API-Antwortrendering-Vorlagendatei , die zum Formatieren der JSON-Antwortantwort von der API des Entwicklers in die Antwort adaptiver Karten verwendet wird. | |
context |
Array von Zeichenfolgen | 3 Zeichen | Definiert, wo die Nachrichtenerweiterung aufgerufen werden kann. Jede Kombination von compose , commandBox , message . Standardwerte: compose, commandBox |
|
title |
Zeichenfolge | 32 Zeichen | ✔️ | Der benutzerfreundliche Name des Befehls. |
description |
Zeichenfolge | 128 Zeichen | Die Beschreibung, die Benutzern angezeigt wird, um den Zweck dieses Befehls anzugeben. | |
semanticDescription |
String | 5000 Zeichen | Semantische Beschreibung des Befehls für die Verwendung durch Microsoft 365 Copilot mithilfe von LLMs (Large Language Models). | |
initialRun |
Boolesch | Ein boolescher Wert, der angibt, ob der Befehl anfänglich ohne Parameter ausgeführt wird. Standardwert: false |
||
fetchTask |
Boolesch | Ein boolescher Wert, der angibt, ob der Dialog dynamisch abgerufen werden muss. Standardwert: false |
||
taskInfo |
Objekt | Geben Sie bei Verwendung eines Nachrichtenerweiterungsbefehls das Dialogfeld an, das vorab laden soll. | ||
taskInfo.title |
String | 64 Zeichen | Titel des ersten Dialogfelds. | |
taskInfo.width |
Zeichenfolge | 16 Zeichen | Dialogbreite: Entweder eine Zahl in Pixel oder ein Standardlayout wie large , medium oder small . |
|
taskInfo.height |
String | 16 Zeichen | Dialoghöhe: Entweder eine Zahl in Pixel oder ein Standardlayout wie large , medium oder small . |
|
taskInfo.url |
Zeichenfolge | 2048 Zeichen | Anfängliche WebView-URL. | |
parameters |
Array mit Objekten | 5 | Die Liste der Parameter, die der Befehl verwendet. | |
parameters.name |
String | 64 Zeichen | ✔️ | Der Name des Parameters, wie er im Client angezeigt wird. Dies ist in der Benutzeranforderung enthalten.
Für die API-basierte Nachrichtenerweiterung muss der Name dem parameters.name in der OpenAPI-Beschreibung zugeordnet werden. Wenn Sie auf eine Eigenschaft im Anforderungstextschema verweisen, muss der Name oder abfrageparametern zugeordnet properties.name werden. |
parameters.title |
Zeichenfolge | 32 Zeichen | ✔️ | Benutzerfreundlicher Titel für den Parameter. |
parameters.description |
Zeichenfolge | 128 Zeichen | Benutzerfreundliche Zeichenfolge, die den Zweck dieses Parameters beschreibt. | |
parameters.semanticDescription |
Zeichenfolge | 2000 Zeichen | Semantische Beschreibung des Parameters für die Verwendung durch die großen Sprachmodelle (LLMs). | |
parameters.inputType |
String | Definiert den Typ des Steuerelements, das in einem Dialogfeld für fetchTask: false angezeigt wird. Der Eingabewert kann nur einer von text , , textarea , date number , , time , toggle seinchoiceset . Standardwert: text |
||
parameters.value |
String | 512 Zeichen | Anfangswert für den Parameter. | |
parameters.choices |
Array mit Objekten | 10 | Die Auswahloptionen für choiceset . Wird nur verwendet, wenn parameters.inputType choiceset ist. |
|
parameters.choices.title |
Zeichenfolge | 128 Zeichen | ✔️ | Titel der Auswahl. |
parameters.choices.value |
Zeichenfolge | 512 Zeichen | ✔️ | Value of the choice. |
composeExtensions.requirementSet
Optional – Objekt
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
requirementSet.hostMustSupportFunctionalities |
Array mit Objekten | ✔️ | Gibt eine oder mehrere Laufzeitfunktionen an, die die Nachrichtenerweiterung benötigt, um ordnungsgemäß zu funktionieren. Unterstützte Werte: dialogUrl , dialogUrlBot , dialogAdaptiveCard , dialogAdaptiveCardBot . Weitere Informationen finden Sie unter Angeben von Laufzeitanforderungen in Ihrem App-Manifest. |
scopeConstraints
Die Bereichseinschränkungen, die einer App auferlegt werden, um anzugeben, in welchen Threads Sie die App installieren können. Wenn keine Einschränkungen angegeben sind, können Sie die App für alle Threads innerhalb des spezifischen Bereichs installieren.
Optional – Objekt
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
teams |
Array | 128 | Eine Liste der Teamthread-IDs, auf die Ihre App beschränkt ist. | |
teams.id |
String | 64 Zeichen | ✔️ | Thread-ID des Teams. |
groupChats |
Array | 128 | Eine Liste der Chatthread-IDs, auf die Ihre App beschränkt ist. | |
groupChats.id |
String | 64 Zeichen | ✔️ | Die Thread-ID des Chats. |
Berechtigungen
Optional : Array von Zeichenfolgen
Ein Array von string
, das angibt, welche Berechtigungen die App anfordert, sodass Endbenutzer wissen, wie die Erweiterung funktioniert. Die folgenden Optionen sind nicht eindeutig:
-
identity
Erfordert Benutzeridentitätsinformationen. -
messageTeamMembers
Erfordert die Berechtigung zum Senden von direkten Nachrichten an Teammitglieder.
Wenn Sie diese Berechtigungen beim Aktualisieren Ihrer App ändern, müssen Ihre Benutzer den Zustimmungsprozess wiederholen, wenn sie die aktualisierte App zum ersten Mal ausführen.
devicePermissions
Optional : Array von Zeichenfolgen
Gibt die nativen Features auf dem Gerät eines Benutzers an, auf die Ihre App Zugriff anfordern kann. Mögliche Optionen sind:
geolocation
media
notifications
midi
openExternal
validDomains
Optional, außer Erforderlich, wo angegeben
Eine Liste gültiger Domänen, von denen die App erwartet, Inhalte zu laden. Domain-Auflistungen können Platzhalter enthalten, zum Beispiel *.example.com
. Die gültige Domäne entspricht genau einem Segment der Domäne. Wenn sie a.b.example.com
entsprechen muss, verwenden Sie *.*.example.com
. Wenn Die Registerkartenkonfiguration oder die Inhalts-UI zu einer anderen Domäne wechseln muss, die nicht für die Registerkartenkonfiguration verwendet wird, muss diese Domäne hier angegeben werden.
Hinweis
Office-Add-Ins, die mit einer extensions
Eigenschaft im Manifest konfiguriert sind, ignorieren Domänen, die einen Wildcard enthalten. Wenn Ihre App ein Office-Add-In enthält, geben Sie den vollständigen Domänennamen für die Domänen an, auf die das Add-In zugreift.
Es ist jedoch nicht erforderlich, die Domänen von Identitätsanbietern, die Sie unterstützen möchten, in Ihre App einzuschließen. Wenn Sie sich beispielsweise mit einer Google-ID authentifizieren möchten, müssen Sie zu accounts.google.com umleiten. Sie dürfen jedoch nicht accounts.google.com in validDomains[]
einschließen.
Wichtig
Fügen Sie keine Domänen hinzu, die außerhalb Ihrer Kontrolle liegen, weder direkt noch über Platzhalter. Beispielsweise yourapp.onmicrosoft.com
ist gültig, aber *.onmicrosoft.com
nicht gültig.
Das Objekt ist ein Array, wobei alle Elemente vom Typ string
sind. Das maximale Element des Objekts ist 16 und die maximale Länge beträgt 2048 Zeichen.
webApplicationInfo
Optional – Objekt
Geben Sie Ihre Microsoft Entra App-ID und Graph-Informationen an, damit sich Benutzer nahtlos bei Ihrer Microsoft Entra-App anmelden können.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | ✔️ | Microsoft Entra Anwendungs-ID der App. Diese ID muss eine GUID sein. | |
resource |
Zeichenfolge | 2048 Zeichen | Ressourcen-URL der App zum Abrufen des Authentifizierungstokens für SSO. |
graphConnector
Optional – Objekt
Geben Sie die Graph-Connectorkonfiguration der App an. Wenn dies vorhanden ist, muss auch webApplicationInfo.id angegeben werden.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
notificationUrl |
Zeichenfolge | 2048 Zeichen | ✔️ | Die https:// URL, an die Graph-connector-Benachrichtigungen für die Anwendung gesendet werden müssen. |
showLoadingIndicator
Optional – Boolescher Wert
Gibt an, ob der Ladeindikator angezeigt werden soll, wenn eine App oder Registerkarte geladen wird.
Standardwert: false
Hinweis
- Wenn Sie in Ihrem App-Manifest die Option true auswählen
showLoadingIndicator
, ändern Sie die Inhaltsseiten Ihrer Registerkarten und Dialogfelder, um die Seite ordnungsgemäß zu laden, wie unter Anzeigen eines nativen Ladeindikatordokuments beschrieben. - Wenn Sie die Inhaltsseiten ihrer Registerkarte nicht ändern, wird die Registerkarten-App nicht geladen und zeigt den Fehler
There was a problem reaching this app
an.
isFullScreen
Optional – Boolescher Wert
Gibt an, wo eine persönliche App mit oder ohne Registerkartenkopfleiste gerendert wird.
Standardwert: false
Hinweis
isFullScreen
funktioniert nur für Apps, die in Ihrer Organisation veröffentlicht wurden.
Aktivitäten
Optional – Objekt
Definiert die Eigenschaften, die Ihre App zum Posten eines Benutzeraktivitätsfeeds verwendet.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
activityTypes |
Array mit Objekten | 128 | Geben Sie die Arten von Aktivitäten an, die Ihre App in einem Benutzeraktivitätsfeed veröffentlichen kann. Der systemDefault Aktivitätstyp ist eine reservierte und ungültige Zeichenfolge. |
activities.activityTypes
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
type |
Zeichenfolge | 32 Zeichen | ✔️ | Der Benachrichtigungstyp. |
description |
Zeichenfolge | 128 Zeichen | ✔️ | Eine kurze Beschreibung der Benachrichtigung. |
templateText |
Zeichenfolge | 128 Zeichen | ✔️ | Beispiel: "{actor} hat die Aufgabe {taskId} für Sie erstellt." |
{
"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
Optional – Array
Der configurableProperties
-Block definiert die App-Eigenschaften, die Microsoft Teams-Administratoren anpassen können. Weitere Informationen finden Sie unter Aktivieren der App-Anpassung.
Hinweis
Es muss mindestens eine Eigenschaft definiert werden. Sie können in diesem Block maximal neun Eigenschaften definieren.
Sie können eine der folgenden Eigenschaften definieren:
-
name
: Der Anzeigename der App. -
shortDescription
: Die Kurzbeschreibung der App. -
longDescription
: Die detaillierte Beschreibung der App. -
smallImageUrl
: Das Kontursymbol der App. -
largeImageUrl
: Das Farbsymbol der App. -
accentColor
: Die Farbe, die mit und als Hintergrund für Ihre Gliederungssymbole verwendet werden soll. -
developerUrl
: Die HTTPS-URL der Website des Entwicklers. -
privacyUrl
: Die HTTPS-URL der Datenschutzerklärung des Entwicklers. -
termsOfUseUrl
: Die HTTPS-URL der Nutzungsbedingungen des Entwicklers.
supportedChannelTypes
Optional – Array
Aktiviert Ihre App in nicht standardmäßigen Kanälen. Wenn Ihre App einen Teambereich unterstützt und diese Eigenschaft definiert ist, aktiviert Microsoft Teams Ihre App in jedem Kanaltyp entsprechend. Die Typen privater und freigegebener Kanal werden unterstützt.
Hinweis
- Wenn Ihre App einen Teambereich unterstützt, funktioniert dieser in den Standardkanälen unabhängig von den in dieser Eigenschaft definierten Werten.
- Ihre Anwendung kann die individuellen Eigenschaften der einzelnen Kanaltypen berücksichtigen, um ordnungsgemäß zu funktionieren. Informationen zum Aktivieren Ihrer Registerkarte für private und freigegebene Kanäle finden Sie unter Abrufen des Kontexts in privaten Kanälen und Abrufen von Kontext in freigegebenen Kanälen.
defaultBlockUntilAdminAction
Optional – Boolescher Wert
Ein -Wert, der angibt, ob eine App standardmäßig blockiert wird, bis der Administrator sie zulässt.
Standardwert: false
publisherDocsUrl
Optional – Zeichenfolge
Die https:// URL zu der Seite, die zusätzliche App-Informationen für die Administratoren bereitstellt. Die maximale Länge der Zeichenfolge beträgt 2048 Zeichen.
defaultInstallScope
Optional – Zeichenfolge
Gibt den standardmäßig für diese App definierten Installationsbereich an. Der definierte Bereich ist die Option, die auf der Schaltfläche angezeigt wird, wenn ein Benutzer versucht, die App hinzuzufügen. Mögliche Optionen sind:
personal
team
groupChat
meetings
defaultGroupCapability
Optional – Objekt
Wenn ein Gruppeninstallationsbereich ausgewählt ist, wird die Standardfunktion definiert, wenn der Benutzer die App installiert. Mögliche Optionen sind:
team
groupchat
meetings
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
team |
String | Wenn der ausgewählte Installationsbereich team ist, gibt dieses Feld die verfügbare Standardfunktion an. Optionen: tab , bot oder connector . |
||
groupchat |
String | Wenn der ausgewählte Installationsbereich groupChat ist, gibt dieses Feld die verfügbare Standardfunktion an. Optionen: tab , bot oder connector . |
||
meetings |
String | Wenn der ausgewählte Installationsbereich meetings ist, gibt dieses Feld die verfügbare Standardfunktion an. Optionen: tab , bot oder connector . |
subscriptionOffer
Optional – Objekt
Gibt das Ihrer App zugeordnete SaaS-Angebot an.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
offerId |
Zeichenfolge | 2048 Zeichen | ✔️ | Ein eindeutiger Bezeichner, der Ihre Publisher-ID und Angebots-ID enthält. Diese finden Sie im Partner Center. Sie müssen die Zeichenfolge als publisherId.offerId formatieren. |
meetingExtensionDefinition
Optional – Objekt
Geben Sie die Besprechungserweiterungsdefinition an. Weitere Informationen finden Sie unter benutzerdefinierten Szenen im Zusammen-Modus in Teams.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
scenes |
Array mit Objekten | 5 | Unterstützte Besprechungsszenen. | |
supportsStreaming |
Boolesch | Ein boolescher Wert, der angibt, ob eine App die Audio- und Videoinhalte der Besprechung an einen RTMP-Endpunkt (Real-Time Meeting Protocol) streamen kann. Standardwert: false |
||
videoFiltersConfigurationUrl |
Zeichenfolge | 2048 Zeichen | Die https:// -URL zum Konfigurieren der Videofilter. | |
supportsAnonymousGuestUsers |
Boolesch | Ein boolescher Wert, der angibt, ob die App den Zugriff durch anonyme Gastbenutzer unterstützt. Standardwert: false |
meetingExtensionDefinition.scenes
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | ✔️ | Der eindeutige Bezeichner für die Szene. Diese ID muss eine GUID sein. | |
name |
Zeichenfolge | 128 Zeichen | ✔️ | Der Name der Szene. |
file |
Zeichenfolge | 2048 Zeichen | ✔️ | Der relative Dateipfad zur JSON-Metadatendatei der Szenen. |
preview |
Zeichenfolge | 2048 Zeichen | ✔️ | Der relative Dateipfad zum PNG-Vorschausymbol der Szenen. |
maxAudience |
Ganze Zahl | 50 | ✔️ | Die maximale Anzahl von Zielgruppen, die in der Szene unterstützt werden. |
seatsReservedForOrganizersOrPresenters |
Ganze Zahl | 50 | ✔️ | Die Anzahl der Plätze, die für Organisatoren oder Moderatoren reserviert sind. |
meetingExtensionDefinition.videoFilters
Dieses Objekt gibt von Besprechungen unterstützte Videofilter an.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | ✔️ | Der eindeutige Bezeichner für den Videofilter. Diese ID muss eine GUID sein. | |
name |
Zeichenfolge | 128 Zeichen | ✔️ | Der Name des Videofilters. |
thumbnail |
Zeichenfolge | 2048 Zeichen | ✔️ | Der relative Dateipfad zur Miniaturansicht des Videofilters. |
Autorisierung
Optional – Objekt
Hinweis
authorization
wird nur für die App-Manifestversion 1.12 oder höher unterstützt.
Spezifizieren und konsolidieren Sie autorisierungsbezogene Informationen für die App.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
permissions |
Object | Liste der Berechtigungen, welche die App benötigt, um zu funktionieren. |
authorization.permissions
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
resourceSpecific |
Array mit Objekten | 16 | Berechtigungen, die den Datenzugriff auf Ebene der Ressourceninstanz schützen. |
authorization.permissions.resourceSpecific
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
type |
String | ✔️ | Der Typ der ressourcenspezifischen Zustimmung (RSC)-Berechtigung. Optionen: Application und Delegated . |
|
name |
Zeichenfolge | 128 Zeichen | ✔️ | Der Name der RSC-Berechtigung. Weitere Informationen finden Sie unter RSC-Anwendungsberechtigungen und delegierte RSC-Berechtigungen. |
RSC-Anwendungsberechtigungen
Anwendungsberechtigungen ermöglichen der App den Zugriff auf Daten, ohne dass ein Benutzer angemeldet ist. Informationen zu Anwendungsberechtigungen finden Sie unter RSC-Berechtigungen für Microsoft Graph und Microsoft BotSDK.
Delegierte RSC-Berechtigungen
Delegierte Berechtigungen ermöglichen der App den Zugriff auf Daten im Namen des angemeldeten Benutzers.
Delegierte RSC-Berechtigungen für ein Team
Name Beschreibung ChannelMeetingParticipant.Read.Group
Ermöglicht es der App, im Namen des angemeldeten Benutzers die Teilnehmerinformationen (Name, Rolle, ID, Beitritts- und Abwesenheitszeiten) von Channel-Meetings zu lesen, die mit diesem Team verbunden sind. ChannelMeetingIncomingAudio.Detect.Group
Ermöglicht der App das Erkennen eingehender Audiodaten in Kanalbesprechungen, die dem Team zugeordnet sind. ChannelMeetingActiveSpeaker.Read.Group
Ermöglicht der App das Lesen der Teilnehmer, die Audiodaten an die Kanalbesprechungen senden, die dem Team zugeordnet sind. ChannelMeetingAudioVideo.Stream.Group
Ermöglicht der App das Streamen von Audio-Video-Inhalten aus Kanalbesprechungen, die dem Team zugeordnet sind. InAppPurchase.Allow.Group
Ermöglicht es der App, Marketplace-Angebote für Benutzer im Team anzuzeigen und ihre Einkäufe innerhalb der App im Namen des angemeldeten Benutzers abzuschließen. ChannelMeetingStage.Write.Group
Ermöglicht der App das Anzeigen von Inhalten auf der Besprechungsphase in Kanalbesprechungen, die dem Team zugeordnet sind, im Namen des angemeldeten Benutzers. LiveShareSession.ReadWrite.Group
Ermöglicht der App, Live Share-Sitzungen für das Team zu erstellen und zu synchronisieren und im Namen des angemeldeten Benutzers Zugriffsinformationen wie Name und Rolle, über die Teamliste und alle zugehörigen Besprechungen abzurufen. MeetingParticipantReaction.Read.Group
Ermöglicht der App das Lesen von Reaktionen von Teilnehmern in Kanalbesprechungen, die dem Team zugeordnet sind. DELEGIERTE RSC-Berechtigungen für Chats oder Besprechungen
Name Beschreibung InAppPurchase.Allow.Chat
Ermöglicht es der App, Marketplace-Angebote für die Benutzer im Chat und jede zugehörige Besprechung anzuzeigen und ihre Einkäufe innerhalb der App im Namen des angemeldeten Benutzers abzuschließen. MeetingStage.Write.Chat
Ermöglicht der App das Anzeigen von Inhalten auf der Besprechungsphase in Besprechungen, die dem Chat zugeordnet sind, im Namen des angemeldeten Benutzers. OnlineMeetingParticipant.Read.Chat
Ermöglicht der App das Lesen von Teilnehmerinformationen, einschließlich Name, Rolle, ID, Beigetretener und verlassener Zeiten, der Besprechung, die dem Chat zugeordnet ist, im Namen des angemeldeten Benutzers. OnlineMeetingParticipant.ToggleIncomingAudio.Chat
Ermöglicht der App das Umschalten eingehender Audiodaten für Teilnehmer an Besprechungen, die dem Chat zugeordnet sind, im Namen des angemeldeten Benutzers. LiveShareSession.ReadWrite.Chat
Ermöglicht der App, Live Share-Sitzungen für den Chat zu erstellen und zu synchronisieren und im Namen des angemeldeten Benutzers zugriffsbezogene Informationen wie Name und Rolle, über die Chatliste und alle zugehörigen Besprechungen zu erhalten. MeetingParticipantReaction.Read.Chat
Ermöglicht der App das Lesen von Reaktionen von Teilnehmern in Besprechungen, die dem Chat zugeordnet sind. OnlineMeetingIncomingAudio.Detect.Chat
Ermöglicht der App das Erkennen von Änderungen im status eingehender Audiodaten in Besprechungen, die dem Chat zugeordnet sind, im Namen des angemeldeten Benutzers. OnlineMeetingActiveSpeaker.Read.Chat
Ermöglicht der App das Lesen von Teilnehmern, die Audiodaten an die Besprechungen senden, die dem Chat zugeordnet sind. OnlineMeetingAudioVideo.Stream.Chat
Ermöglicht der App das Streamen von Audiovideoinhalten von Besprechungen, die dem Chat zugeordnet sind. Delegierte RSC-Berechtigungen für Benutzer
Name Beschreibung CameraStream.Read.User
Ermöglicht der App das Lesen des Kameradatenstroms des Benutzers. InAppPurchase.Allow.User
Ermöglicht es der App, dem Benutzer Angebote auf dem Marktplatz zu zeigen und die Einkäufe des Benutzers innerhalb der App im Namen des angemeldeten Benutzers abzuschließen. OutgoingVideoStream.Write.User
Ermöglicht der App, das ausgehende Video des Benutzers zu ändern. MicrophoneStream.Read.User
Ermöglicht der App das Lesen des Mikrofonstreams des Benutzers. MeetingParticipantReaction.Read.User
Ermöglicht der App, die Reaktionen von Benutzern während der Teilnahme an einer Besprechung zu lesen.
Erweiterungen
Optional – Objekt
Die extensions
Eigenschaft gibt Outlook-Add-Ins innerhalb eines App-Manifests an und vereinfacht die Verteilung und den Erwerb im gesamten Microsoft 365-Ökosystem. Jede App unterstützt nur eine Erweiterung.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
requirements |
Object | Gibt die Client- oder Hostanforderungen für die Erweiterung an. | ||
runtimes |
Array | 20 | Konfiguriert die Laufzeiten und Aktionen, die von jedem Erweiterungspunkt verwendet werden können. Weitere Informationen finden Sie unter Laufzeiten in Office-Add-Ins. | |
ribbons |
Array | 20 | Definiert den Erweiterungspunkt des Menübands. | |
autoRunEvents |
Array | 10 | Definiert den ereignisbasierten Aktivierungserweiterungspunkt. | |
alternates |
Array | 10 | Gibt die Beziehung zu alternativen vorhandenen Microsoft 365-Lösungen an. Es wird verwendet, um Add-Ins desselben Herausgebers mit überlappender Funktionalität auszublenden oder zu priorisieren. | |
audienceClaimUrl |
Zeichenfolge | 2048 Zeichen | Gibt die URL für Ihre Erweiterung an und wird zum Überprüfen von Exchange-Benutzeridentitätstoken verwendet. Weitere Informationen finden Sie unter Innerhalb des Exchange-Identitätstokens. | |
appDeeplinks |
Array | Nicht verwenden. Nur für die interne Verwendung von Microsoft. |
Weitere Informationen finden Sie unter Office-Add-Ins-Manifest für Microsoft 365.
extensions.requirements
Das extensions.requirements
-Objekt gibt die Bereiche, Formfaktoren und Anforderungssätze der Office JavaScript-Bibliothek an, die auf dem Office-Client unterstützt werden müssen, damit das Add-In installiert werden kann. Anforderungen werden auch für die untergeordneten Eigenschaften "ribbon", "runtime", "alternates" und "autoRunEvents" unterstützt, um selektiv einige Features des Add-Ins herauszufiltern. Weitere Informationen finden Sie unter Angeben von Office-Add-In-Anforderungen im einheitlichen Manifest für Microsoft 365.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
capabilities |
Array | 100 | Identifiziert die Anforderungssätze. | |
capabilities.name |
String | ✔️ | Gibt den Namen des Anforderungssatzes an. | |
capabilities.minVersion |
String | Gibt die Mindestversion für den Anforderungssatz an. | ||
capabilities.maxVersion |
String | Gibt die maximale Version für den Anforderungssatz an. | ||
scopes |
Array von Enumerationen | 1 | Identifiziert die Bereiche, in denen das Add-In ausgeführt werden kann, und definiert die Microsoft 365-Anwendungen, in denen die Erweiterung ausgeführt werden kann. Beispiel mail : (Outlook). Unterstützter Wert: mail |
|
formFactors |
Array von Enumerationen | Identifiziert die Formfaktoren, die das Add-In unterstützen. Unterstützte Werte: mobile , desktop |
extensions.runtimes
Optional – Array
Das extensions.runtimes
Array konfiguriert die Sätze von Laufzeiten und Aktionen, die jeder Erweiterungspunkt verwenden kann.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | 64 Zeichen | ✔️ | Gibt die ID für die Runtime an. |
type |
Zeichenfolgenenumeration | ✔️ | Gibt den Typ der Laufzeit an. Der unterstützte Enumerationswert für die browserbasierte Runtime ist general . |
|
code |
Objekt | ✔️ | Gibt den Speicherort des Codes für die Runtime an. Basierend auf runtime.type können Add-Ins entweder eine JavaScript-Datei oder eine HTML-Seite mit einem eingebetteten script Tag verwenden, das die URL einer JavaScript-Datei angibt. Beide URLs sind in Situationen erforderlich, in denen unsicher runtime.type ist. |
|
code.page |
Zeichenfolge | 2048 Zeichen | ✔️ | Gibt die URL der Webseite an, die ein eingebettetes script Tag enthält, das die URL einer JavaScript-Datei angibt (die in eine browserbasierte Runtime geladen werden soll). |
code.script |
Zeichenfolge | 2048 Zeichen | Gibt die URL der JavaScript-Datei an, die in die reine JavaScript-Runtime geladen werden soll. | |
lifetime |
Zeichenfolgenenumeration | Gibt die Lebensdauer der Laufzeit an. Laufzeiten mit einer short Lebensdauer behalten den Zustand nicht über Alle Ausführungen hinweg bei, während Laufzeiten mit einer long Lebensdauer dies tun. Weitere Informationen finden Sie unter Runtimes in Office-Add-Ins.Standardwert: short |
||
actions |
Array | 20 | Gibt den Satz von Aktionen an, die von der Runtime unterstützt werden. Eine Aktion führt entweder eine JavaScript-Funktion aus oder öffnet eine Ansicht, z. B. einen Aufgabenbereich. | |
actions.id |
String | 64 Zeichen | ✔️ | Gibt die ID für die Aktion an, die an die Codedatei übergeben wird. |
actions.type |
String | ✔️ | Gibt den Aktionstyp an. Der executeFunction Typ führt eine JavaScript-Funktion aus, ohne darauf zu warten, dass sie abgeschlossen ist, und der openPage Typ öffnet eine Seite in einer bestimmten Ansicht. |
|
actions.displayName |
String | 64 Zeichen | Gibt den Anzeigenamen der Aktion an, und es ist nicht die Bezeichnung einer Schaltfläche oder eines Menüelements, die die Aktion aufruft (die mit tabs.groups.controls.label konfiguriert ist). |
|
actions.pinnable |
Boolesch | Gibt an, dass ein Aufgabenbereich das Anheften unterstützt, sodass der Aufgabenbereich geöffnet bleibt, wenn der Benutzer die Auswahl ändert. Standardwert: false |
||
actions.view |
String | 64 Zeichen | Gibt die Ansicht an, in der die Seite geöffnet werden muss. Sie wird nur verwendet, wenn actions.type ist openPage . |
|
actions.multiselect |
Boolesch | Gibt an, ob der Endbenutzer mehrere Elemente auswählen kann, z. B. mehrere E-Mail-Nachrichten, und die Aktion auf alle anwenden kann. Standardwert: false |
||
actions.supportsNoItemContext |
Boolesch | Ermöglicht die Aktivierung von Aufgabenbereich-Add-Ins, ohne dass der Lesebereich aktiviert oder eine Nachricht ausgewählt ist. Standardwert: false |
||
requirements |
Objekt | Gibt die Bereiche, formFactors und Anforderungssätze der Office JavaScript-Bibliothek an, die auf dem Office-Client unterstützt werden müssen, damit die Runtime in das Add-In eingeschlossen werden kann. Weitere Informationen finden Sie unter Angeben von Office-Add-In-Anforderungen im einheitlichen Manifest für Microsoft 365. | ||
requirements.capabilities |
Array | Identifiziert die Anforderungssätze. Optionen: name (erforderlich), minVersion , maxVersion |
||
requirements.capabilities.name |
String | ✔️ | Gibt den Namen des Anforderungssatzes an. | |
requirements.capabilities.minVersion |
String | Gibt die Mindestversion für den Anforderungssatz an. | ||
requirements.capabilities.maxVersion |
String | Gibt die maximale Version für den Anforderungssatz an. | ||
requirements.scopes |
Array von Enumerationen | 1 | Identifiziert die Bereiche, in denen das Add-In ausgeführt werden kann, und definiert die Microsoft 365-Anwendungen, in denen die Erweiterung ausgeführt werden kann. Beispiel mail : (Outlook). Unterstützter Wert: mail |
|
requirements.formFactors |
Array von Enumerationen | Identifiziert die Formfaktoren, die das Add-In unterstützen. Unterstützte Werte: mobile , desktop |
Informationen zur Verwendung extensions.runtimes
von finden Sie unter Erstellen von Add-In-Befehlen, Konfigurieren der Runtime für einen Aufgabenbereich und Konfigurieren der Laufzeit für den Funktionsbefehl.
extensions.ribbons
Optional – Array
Die extensions.ribbons
-Eigenschaft bietet die Möglichkeit, Add-In-Befehle (Schaltflächen und Menüelemente) zum Menüband der Microsoft 365-Anwendung hinzuzufügen. Die Menübanddefinition wird aus dem Array basierend auf den Anforderungen und der ersten Reihenfolge ausgewählt.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
contexts |
Array | 8 | Gibt das Microsoft 365-Anwendungsfenster an, in dem die Menübandanpassung für den Benutzer verfügbar ist. Jedes Element im Array ist ein Element eines Zeichenfolgenarrays. Unterstützte Werte: mailRead , mailCompose , meetingDetailsOrganizer , meetingDetailsAttendee , onlineMeetingDetailsOrganizer , logEventMeetingDetailsAttendee , , spamReportingOverride default |
|
requirements |
Objekt | Gibt die Bereiche, formFactors und Office JavaScript Library-Anforderungssätze an, die auf dem Office-Client unterstützt werden müssen, damit die Menübandanpassung angezeigt wird. Weitere Informationen finden Sie unter Angeben von Office-Add-In-Anforderungen im einheitlichen Manifest für Microsoft 365. | ||
requirements.capabilities |
Array | Identifiziert die Anforderungssätze. Optionen: name (erforderlich), minVersion , maxVersion |
||
requirements.capabilities.name |
String | ✔️ | Gibt den Namen des Anforderungssatzes an. | |
requirements.capabilities.minVersion |
String | Gibt die Mindestversion für den Anforderungssatz an. | ||
requirements.capabilities.maxVersion |
String | Gibt die maximale Version für den Anforderungssatz an. | ||
requirements.scopes |
Array von Enumerationen | 1 | Identifiziert die Bereiche, in denen das Add-In ausgeführt werden kann, und definiert die Microsoft 365-Anwendungen, in denen die Erweiterung ausgeführt werden kann. Beispiel mail : (Outlook). Unterstützter Wert: mail |
|
requirements.formFactors |
Array von Enumerationen | Identifiziert die Formfaktoren, die das Add-In unterstützen. Unterstützte Werte: mobile , desktop |
||
tabs |
Array | 20 | ✔️ | Konfiguriert die benutzerdefinierten Registerkarten im Menüband der Microsoft 365-Anwendung. |
tabs.id |
String | 64 Zeichen | Gibt die ID für die Registerkarte in der App an. | |
tabs.builtInTabId |
String | 64 Zeichen | Gibt die ID einer integrierten Registerkarte des Office-Menübands an. Weitere Informationen zu möglichen Werten finden Sie unter Suchen der IDs der integrierten Registerkarten des Office-Menübands. Die einzigen anderen untergeordneten Eigenschaften eines Tab-Objekts, die in diese Eigenschaft eingeschlossen werden können, sind groups und customMobileRibbonGroups . |
|
tabs.label |
String | 64 Zeichen | Gibt den Text an, der für die Registerkarte angezeigt wird. Trotz der maximalen Länge von 64 Zeichen empfiehlt es sich, die Bezeichnung auf 16 Zeichen zu beschränken, um die Registerkarte im Menüband ordnungsgemäß auszurichten. | |
tabs.position |
Objekt | Konfiguriert die Position der benutzerdefinierten Registerkarte relativ zu anderen Registerkarten im Menüband. | ||
tabs.position.builtInTabId |
String | 64 Zeichen | ✔️ | Gibt die ID der integrierten Registerkarte an, neben der die benutzerdefinierte Registerkarte positioniert werden soll. Weitere Informationen finden Sie unter Suchen der IDs von Steuerelementen und Steuerelementgruppen. |
tabs.position.align |
Zeichenfolgenenumeration | ✔️ | Definiert die Ausrichtung der benutzerdefinierten Registerkarte relativ zur angegebenen integrierten Registerkarte. Unterstützte Werte: after , before |
|
tabs.groups |
Array | 10 | Definiert Gruppen von Steuerelementen auf einer Registerkarte des Menübands auf einem nicht mobilen Gerät. Informationen zu mobilen Geräten finden Sie tabs.customMobileRibbonGroups unten. |
|
tabs.groups.id |
String | 64 Zeichen | Gibt die ID für die Registerkartengruppe innerhalb der App an. Sie muss sich von jeder integrierten Gruppen-ID in der Microsoft 365-Anwendung und jeder anderen benutzerdefinierten Gruppe unterscheiden. | |
tabs.groups.label |
String | 64 Zeichen | Gibt den text an, der für die Gruppe angezeigt wird. Trotz der maximalen Länge von 64 Zeichen empfiehlt es sich, die Bezeichnung auf 16 Zeichen zu beschränken, um die Registerkarte im Menüband ordnungsgemäß auszurichten. | |
tabs.groups.icons |
Array | 3 | Gibt die Symbole an, die für die Gruppe angezeigt werden. | |
tabs.groups.icons.size |
Zahl | ✔️ | Gibt die Größe des Symbols in Pixeln an, das als 16 ,,,,24 32 ,40 ,48 ,,64 80 aufgezählt20 wird. Erforderliche Imagegrößen: 16 , 32 , 80 . |
|
tabs.groups.icons.url |
Zeichenfolge | 2048 Zeichen | ✔️ | Gibt die absolute URL des Symbols an. |
tabs.groups.controls |
Array | Konfiguriert die Schaltflächen und Menüs in der Gruppe. | ||
tabs.groups.controls.id |
String | 64 Zeichen | ✔️ | Gibt die ID für das Steuerelement innerhalb der App an. Sie muss sich von jeder integrierten Steuerelement-ID in der Microsoft 365-Anwendung und jedem anderen benutzerdefinierten Steuerelement unterscheiden. |
tabs.groups.controls.items |
Array | Konfiguriert die Elemente für ein Menüsteuerelement. | ||
tabs.groups.controls.items.id |
String | ✔️ | Gibt die ID für ein Menüelement an. | |
tabs.groups.controls.items.type |
Zeichenfolgenenumeration | ✔️ | Definiert den Steuerelementtyp des Menüelements. Unterstützte Werte: button |
|
tabs.groups.controls.items.label |
String | 64 Zeichen | ✔️ | Gibt den text an, der für das Menüelement angezeigt wird. |
tabs.groups.controls.items.icons |
Array | Konfiguriert die Symbole für das Menüelement. | ||
tabs.groups.controls.items.icons.size |
Zahl | ✔️ | Gibt die Größe des Symbols in Pixeln an, das als 16 ,,,,24 32 ,40 ,48 ,,64 80 aufgezählt20 wird. Erforderliche Imagegrößen: 16 , 32 , 80 . |
|
tabs.groups.controls.items.icons.url |
URL | ✔️ | Gibt die absolute URL des Symbols an. | |
tabs.groups.controls.items.supertip |
✔️ | Konfiguriert einen Supertip für das Menüelement. Ein Supertip ist ein Benutzeroberflächenfeature, das ein kurzes Feld mit Hilfeinformationen zu einem Steuerelement anzeigt, wenn der Cursor darauf zeigt. Das Feld kann mehrere Textzeilen enthalten. | ||
tabs.groups.controls.items.supertip.title |
String | 64 Zeichen | ✔️ | Gibt den Titeltext des Supertips an. |
tabs.groups.controls.items.supertip.description |
Zeichenfolge | 128 Zeichen | ✔️ | Gibt die Beschreibung des Supertips an. |
tabs.groups.controls.items.actionId |
String | 64 Zeichen | ✔️ | Gibt die ID der Aktion an, die ausgeführt wird, wenn ein Benutzer das Steuerelement oder das Menüelement auswählt. Die actionId muss mit einem runtimes.actions.id Eigenschaftswert übereinstimmen. |
tabs.groups.controls.items.enabled |
Boolesch | Gibt an, ob das Menüelement anfänglich aktiviert ist. Standardwert: true |
||
tabs.groups.controls.items.overriddenByRibbonApi |
Boolesch | Gibt an, ob das Menüelement in Anwendungs- und Plattformkombinationen ausgeblendet wird, die die API (Office.ribbon.requestCreateControls) unterstützen. Diese API installiert benutzerdefinierte kontextbezogene Registerkarten auf dem Menüband. Standardwert: false |
||
tabs.groups.controls.type |
String | ✔️ | Definiert den Steuerelementtyp. Unterstützte Werte: button , menu |
|
tabs.groups.controls.builtInControlId |
String | 64 Zeichen | Gibt die ID eines vorhandenen Microsoft 365-Steuerelements an. Weitere Informationen finden Sie unter Suchen der IDs von Steuerelementen und Steuerelementgruppen. Diese Eigenschaft kann nicht mit anderen untergeordneten Eigenschaften des Steuerelementobjekts kombiniert werden, da integrierte Steuerelemente nicht von einem Add-In angepasst werden können. | |
tabs.groups.controls.label |
String | 64 Zeichen | ✔️ | Gibt den für das Steuerelement angezeigten Text an. Trotz der maximalen Länge von 64 Zeichen empfiehlt es sich, die Bezeichnung auf 16 Zeichen zu beschränken, um die Registerkarte im Menüband ordnungsgemäß auszurichten. |
tabs.groups.controls.icons |
Array | ✔️ | Definiert die Symbole für das Steuerelement. Es müssen mindestens drei untergeordnete Objekte vorhanden sein; eine mit size jeweils den Eigenschaften 16 , 32 und 80 Pixeln. |
|
tabs.groups.controls.icons.size |
Zahl | ✔️ | Gibt die Größe des Symbols in Pixeln an, das als 16 ,,,,24 32 ,40 ,48 ,,64 80 aufgezählt20 wird. Erforderliche Imagegrößen: 16 , 32 , 80 |
|
tabs.groups.controls.icons.url |
URL | Gibt die absolute URL zur Symboldatei an. | ||
tabs.groups.controls.supertip |
Objekt | ✔️ | Konfiguriert einen Supertip für das Steuerelement. Ein Supertip ist ein Benutzeroberflächenfeature, das ein kurzes Feld mit Hilfeinformationen zu einem Steuerelement anzeigt, wenn der Cursor darauf zeigt. Das Feld kann mehrere Textzeilen enthalten. | |
tabs.groups.controls.supertip.title |
String | 64 Zeichen | ✔️ | Gibt den Titeltext des Supertips an. |
tabs.groups.controls.supertip.description |
Zeichenfolge | 128 Zeichen | ✔️ | Gibt die Beschreibung des Supertips an. |
tabs.groups.controls.actionId |
String | 64 Zeichen | Erforderlich, wenn der Steuerelementtyp ist button . Verwenden Sie nicht, wenn der Steuerelementtyp ist menu . Gibt die ID der Aktion an, die ausgeführt wird, wenn ein Benutzer das Steuerelement auswählt. Der actionId muss mit der runtime.actions.id -Eigenschaft einer Aktion im runtimes -Objekt übereinstimmen. |
|
tabs.groups.controls.enabled |
Boolesch | Gibt an, ob das Steuerelement anfänglich aktiviert ist. Standardwert: true |
||
tabs.groups.controls.overriddenByRibbonApi |
Boolesch | Gibt an, ob das Steuerelement in Anwendungs- und Plattformkombinationen ausgeblendet wird, die die API (Office.ribbon.requestCreateControls) unterstützen. Diese API installiert benutzerdefinierte kontextbezogene Registerkarten auf dem Menüband. Standardwert: false |
||
tabs.groups.builtInGroupId |
String | 64 Zeichen | Gibt die ID einer integrierten Gruppe an. Weitere Informationen finden Sie unter Suchen der IDs von Steuerelementen und Steuerelementgruppen. Diese Eigenschaft kann nicht mit anderen untergeordneten Eigenschaften des Gruppenobjekts kombiniert werden, da integrierte Gruppen nicht durch ein Add-In angepasst werden können. | |
tabs.customMobileRibbonGroups |
Array | 10 | Definiert Gruppen von Steuerelementen auf der Standardregisterkarte des Menübands auf einem mobilen Gerät. Diese Arrayeigenschaft kann nur auf Registerkartenobjekten vorhanden sein, die über eine tabs.builtInTabId -Eigenschaft verfügen, die auf DefaultTab festgelegt ist. Für nicht mobile Geräte siehe tabs.groups oben. |
|
tabs.customMobileRibbonGroups.id |
String | 250 Zeichen | ✔️ | Gibt die ID der Gruppe an. Sie muss sich von jeder integrierten Gruppen-ID in der Microsoft 365-Anwendung und jeder anderen benutzerdefinierten Gruppe unterscheiden. |
tabs.customMobileRibbonGroups.label |
Zeichenfolge | 32 Zeichen | ✔️ | Gibt die Bezeichnung für die Gruppe an. |
tabs.customMobileRibbonGroups.controls |
Array | 20 | ✔️ | Definiert die Steuerelemente in der Gruppe. Es werden nur mobile Schaltflächen unterstützt. |
tabs.customMobileRibbonGroups.controls.id |
String | 250 Zeichen | ✔️ | Gibt die ID des Steuerelements an, z msgReadFunctionButton . B. . |
tabs.customMobileRibbonGroups.controls.type |
Zeichenfolgenenumeration | ✔️ | Gibt den Typ des Steuerelements an.
MobileButton wird nur unterstützt. |
|
tabs.customMobileRibbonGroups.controls.label |
Zeichenfolge | 32 Zeichen | ✔️ | Gibt die Bezeichnung des Steuerelements an. |
tabs.customMobileRibbonGroups.controls.actionId |
String | 64 Zeichen | ✔️ | Gibt die ID der Aktion an, die ausgeführt wird, wenn ein Benutzer das Steuerelement auswählt. Der actionId muss mit der runtime.actions.id -Eigenschaft einer Aktion im runtimes -Objekt übereinstimmen. |
tabs.customMobileRibbonGroups.controls.icons |
Array | 9 | ✔️ | Gibt die Symbole an, die abhängig von den Abmessungen und dpi des Bildschirms des mobilen Geräts auf dem Steuerelement angezeigt werden. Es müssen genau 9 Symbole vorhanden sein. |
tabs.customMobileRibbonGroups.controls.icons.size |
Zahlenenumerung | ✔️ | Größe des Symbols in Pixel. Die möglichen Größen sind 25, 32 und 48. Für jeden möglichen Wert der -Eigenschaft der Symbole scale muss genau eine größe vorhanden sein. |
|
tabs.customMobileRibbonGroups.controls.icons.url |
Zeichenfolge | 2048 Zeichen | ✔️ | Die vollständige, absolute URL der Bilddatei des Symbols. |
tabs.customMobileRibbonGroups.controls.icons.scale |
Zahlenenumerung | ✔️ | Gibt die UIScreen.scale-Eigenschaft für iOS-Geräte an. Die möglichen Werte sind 1, 2 und 3. Für jeden möglichen Wert der Eigenschaft der Symbole size muss genau ein Wert vorhanden sein. |
|
fixedControls |
Array | 1 | Konfiguriert die Schaltfläche eines integrierten Spamberichts-Add-Ins in Outlook. Muss konfigurieren, wenn spamReportingOverride im extensions.ribbons.contexts Array angegeben ist. |
|
fixedControls.id |
String | 64 Zeichen | ✔️ | Gibt die eindeutige ID der Schaltfläche eines Add-Ins zur Spamberichterstattung an. |
fixedControls.type |
String | ✔️ | Definiert den Steuerelementtyp eines Add-Ins für die Spamberichterstattung. Unterstützter Wert: button |
|
fixedControls.label |
String | 64 Zeichen | ✔️ | Gibt den Text an, der auf der Schaltfläche eines Add-Ins für die Spamberichterstattung angezeigt wird. |
fixedControls.enabled |
Boolesch | ✔️ | Diese Eigenschaft muss im fixedControls -Objekt angegeben werden. Dies wirkt sich jedoch nicht auf die Funktionalität eines Add-Ins für die Spamberichterstattung aus.Standardwert: True |
|
fixedControls.icons |
Array | 3 | ✔️ | Definiert die Symbole für die Schaltfläche eines Add-Ins zur Spamberichterstattung. Es müssen mindestens drei untergeordnete Objekte vorhanden sein, die jeweils die Symbolgrößen 16 , 32 und 80 Pixel aufweisen. |
fixedControls.icons.size |
Zahl | ✔️ | Gibt die Größe des Symbols in Pixeln an, das als 16 , , 20 , 24 , 32 , 64 40 48 und 80 aufgezählt wird.Erforderliche Imagegrößen: 16 , 32 , 80 |
|
fixedControls.icons.url |
Zeichenfolge | 2048 Zeichen | ✔️ | Gibt die absolute URL zum Symbol an. |
fixedControls.supertip |
Objekt | ✔️ | Konfiguriert einen Supertip für die Schaltfläche eines Add-Ins für die Spamberichterstattung. | |
fixedControls.supertip.title |
String | 64 Zeichen | ✔️ | Gibt den Titeltext des Supertips an. |
fixedControls.supertip.description |
String | 250 Zeichen | ✔️ | Gibt die Beschreibung des Supertips an. |
fixedControls.actionId |
String | 64 Zeichen | ✔️ | Gibt die ID der Aktion an, die ausgeführt wird, wenn ein Benutzer die Schaltfläche eines Add-Ins für die Spamberichterstattung auswählt. Der actionId muss mit der runtime.actions.id -Eigenschaft einer Aktion im runtimes -Objekt übereinstimmen. |
spamPreProcessingDialog |
Objekt | Konfiguriert das Vorverarbeitungsdialogfeld eines integrierten Spamberichts-Add-Ins in Outlook. | ||
spamPreProcessingDialog.title |
Zeichenfolge | 128 Zeichen | ✔️ | Gibt den benutzerdefinierten Titel des Vorverarbeitungsdialogfelds eines Spamberichterstattungs-Add-Ins an. |
spamPreProcessingDialog.description |
String | 250 Zeichen | ✔️ | Gibt den benutzerdefinierten Text an, der im Vorverarbeitungsdialogfeld eines Add-Ins für die Spamberichterstattung angezeigt wird. |
spamPreProcessingDialog.spamReportingOptions |
Objekt | Gibt bis zu fünf Optionen an, die ein Benutzer im Vorverarbeitungsdialogfeld auswählen kann, um einen Grund für das Melden einer Nachricht anzugeben. | ||
spamPreProcessingDialog.spamReportingOptions.title |
Zeichenfolge | 128 Zeichen | ✔️ | Gibt den benutzerdefinierten Text oder Titel an, um die Berichtsoptionen zu beschreiben, die im Vorverarbeitungsdialogfeld bereitgestellt werden. |
spamPreProcessingDialog.spamReportingOptions.options |
Array aus Zeichenfolgen | 5 Optionen 128 Zeichen pro Option |
✔️ | Gibt eine benutzerdefinierte Option mit einem Kontrollkästchen an, das ein Benutzer im Vorverarbeitungsdialogfeld auswählen kann, um einen Grund für das Melden einer Nachricht anzugeben. Es muss mindestens eine Option angegeben werden. Maximal fünf Optionen können einbezogen werden. |
spamPreProcessingDialog.spamFreeTextSectionTitle |
Zeichenfolge | 128 Zeichen | Fügt dem Vorverarbeitungsdialogfeld ein Textfeld für Benutzer hinzu, um zusätzliche Informationen zu der Nachricht bereitzustellen, die sie melden. Die in dieser Eigenschaft angegebene Zeichenfolge wird über dem Textfeld angezeigt. | |
spamPreProcessingDialog.spamMoreInfo |
Objekt | Konfiguriert einen Link zum Bereitstellen von Informationsressourcen für einen Benutzer. Im Vorverarbeitungsdialogfeld wird der Link unterhalb des in spamPreProcessingDialog.description bereitgestellten Texts angezeigt. |
||
spamPreProcessingDialog.spamMoreInfo.text |
Zeichenfolge | 128 Zeichen | ✔️ | Gibt den Linktext für eine URL an, der Benutzer aus dem Vorverarbeitungsdialogfeld zu Informationsressourcen leitet. |
spamPreProcessingDialog.spamMoreInfo.url |
Zeichenfolge | 2048 Zeichen | ✔️ | Gibt die HTTPS-URL einer Website an, die Informationsressourcen enthält. |
Informationen zur Verwendung extensions.ribbons
von finden Sie unter Erstellen von Add-In-Befehlen, Konfigurieren der Benutzeroberfläche für den Aufgabenbereichbefehl und Konfigurieren der Benutzeroberfläche für den Funktionsbefehl.
extensions.autoRunEvents
Optional – Array
Die extensions.autoRunEvents
-Eigenschaft definiert ereignisbasierte Aktivierungserweiterungspunkte.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
events |
Array | 20 | ✔️ | Konfiguriert das Ereignis, das bewirkt, dass Aktionen in einem Outlook-Add-In automatisch ausgeführt werden. Weitere Informationen finden Sie beispielsweise unter Verwenden intelligenter Warnungen und der OnMessageSend Ereignisse und OnAppointmentSend in Ihren Outlook-Add-Ins. |
events.type |
String | 64 Zeichen | Gibt den Ereignistyp an. Informationen zu unterstützten Typen finden Sie unter Unterstützte Ereignisse. | |
events.actionId |
String | 64 Zeichen | Identifiziert die Aktion, die ausgeführt wird, wenn das Ereignis ausgelöst wird. Die actionId muss mit runtime.actions.id übereinstimmen. |
|
events.options |
Objekt | Konfiguriert, wie Outlook auf das Ereignis reagiert. | ||
events.options.sendMode |
String | ✔️ | Gibt die Aktionen an, die während einer E-Mail-Sendeaktion ausgeführt werden sollen. Unterstützte Werte: promptUser , softBlock , block . Weitere Informationen finden Sie unter Verfügbare Sendemodusoptionen. |
|
requirements |
Objekt | Gibt die Bereiche, formFactors und Anforderungssätze der Office JavaScript-Bibliothek an, die auf dem Office-Client unterstützt werden müssen, damit der Ereignisbehandlungscode ausgeführt werden kann. Weitere Informationen finden Sie unter Angeben von Office-Add-In-Anforderungen im einheitlichen Manifest für Microsoft 365. | ||
requirements.capabilities |
Array | Identifiziert die Anforderungssätze. Optionen: name (erforderlich), minVersion , maxVersion |
||
requirements.capabilities.name |
String | ✔️ | Gibt den Namen des Anforderungssatzes an. | |
requirements.capabilities.minVersion |
String | Gibt die Mindestversion für den Anforderungssatz an. | ||
requirements.capabilities.maxVersion |
String | Gibt die maximale Version für den Anforderungssatz an. | ||
requirements.scopes |
Array von Enumerationen | 1 | Identifiziert die Bereiche, in denen das Add-In ausgeführt werden kann, und definiert die Microsoft 365-Anwendungen, in denen die Erweiterung ausgeführt werden kann. Beispiel mail : (Outlook). Unterstützter Wert: mail |
|
requirements.formFactors |
Array von Enumerationen | Identifiziert die Formfaktoren, die das Add-In unterstützen. Unterstützte Werte: mobile , desktop |
extensions.alternates
Die extensions.alternates
-Eigenschaft wird verwendet, um bestimmte marktinterne Add-Ins auszublenden oder zu priorisieren, wenn Sie mehrere Add-Ins mit überlappenden Funktionen veröffentlicht haben.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
prefer |
Object | Gibt die Abwärtskompatibilität mit einem entsprechenden COM-Add-In, XLL-Add-In oder beidem an. | ||
prefer.comAddin |
Objekt | Gibt ein COM-Add-In an, das anstelle des Microsoft 365-Web-Add-Ins für Windows verwendet werden muss. | ||
prefer.comAddin.progId |
String | 64 Zeichen | ✔️ | Gibt den Anwendungstyp an, in dem die Erweiterung ausgeführt werden kann. |
hide |
Objekt | Konfiguriert, wie ein anderes Add-In ausgeblendet wird, das Sie bei jeder Installation des Add-Ins veröffentlicht haben, damit Benutzer nicht beides auf der Microsoft 365-Benutzeroberfläche sehen. Verwenden Sie diese Eigenschaft beispielsweise, wenn Sie zuvor ein Add-In veröffentlicht haben, das das alte XML-App-Manifest verwendet, und Sie es durch eine Version ersetzen, die das neue JSON-App-Manifest verwendet. | ||
hide.storeOfficeAddin |
Objekt | Gibt ein in Microsoft AppSource verfügbares Microsoft 365-Add-In an. | ||
hide.storeOfficeAddin.officeAddinId |
String | 64 Zeichen | ✔️ | Gibt die ID des auszublendenden Add-Ins im Markt an. Die GUID stammt aus der App-Manifesteigenschaft id , wenn das marktinterne Add-In das JSON-App-Manifest verwendet. Die GUID wird aus dem <Id> -Element übernommen, wenn das marktinterne Add-In das XML-App-Manifest verwendet. |
hide.storeOfficeAddin.assetId |
String | 64 Zeichen | ✔️ | Gibt die AppSource-Ressourcen-ID des im Markt befindlichen Add-Ins an, das ausgeblendet werden soll. |
hide.customOfficeAddin |
Objekt | Konfiguriert das Ausblenden eines marktinternen Add-Ins, das nicht über AppSource verteilt wird. | ||
hide.customOfficeAddin.officeAddinId |
String | 64 Zeichen | ✔️ | Gibt die ID des auszublendenden Add-Ins im Markt an. Die GUID stammt aus der App-Manifesteigenschaft id , wenn das marktinterne Add-In das JSON-App-Manifest verwendet. Die GUID wird aus dem <Id> -Element übernommen, wenn das marktinterne Add-In das XML-App-Manifest verwendet. |
requirements |
Objekt | Gibt die Bereiche, formFactors und Office JavaScript Library-Anforderungssätze an, die auf dem Office-Client unterstützt werden müssen, damit die Eigenschaften "hide", "prefer" oder "alternateIcons" wirksam werden. Weitere Informationen finden Sie unter Angeben von Office-Add-In-Anforderungen im einheitlichen Manifest für Microsoft 365. | ||
requirements.capabilities |
Array | Identifiziert die Anforderungssätze. Optionen: name (erforderlich), minVersion , maxVersion |
||
requirements.capabilities.name |
String | ✔️ | Gibt den Namen des Anforderungssatzes an. | |
requirements.capabilities.minVersion |
String | Gibt die Mindestversion für den Anforderungssatz an. | ||
requirements.capabilities.maxVersion |
String | Gibt die maximale Version für den Anforderungssatz an. | ||
requirements.scopes |
Array von Enumerationen | 1 | Identifiziert die Bereiche, in denen das Add-In ausgeführt werden kann, und definiert die Microsoft 365-Anwendungen, in denen die Erweiterung ausgeführt werden kann. Beispiel mail : (Outlook). Unterstützter Wert: mail |
|
requirements.formFactors |
Array von Enumerationen | Identifiziert die Formfaktoren, die das Add-In unterstützen. Unterstützte Werte: mobile , desktop |
||
alternateIcons |
Objekt | Gibt die Standard Symbole an, die verwendet werden, um das Add-In in älteren Versionen von Office darzustellen. Diese Eigenschaft ist erforderlich , wenn das Office-Add-In in Office auf Mac, unbefristeten Office-Lizenzen und Microsoft 365-Abonnementversionen von Office unter Windows vor 2304 (Build 16320.00000) installiert werden kann. | ||
alternateIcons.icon |
Objekt | ✔️ | Gibt die Eigenschaften der Bilddatei an, die zum Darstellen des Add-Ins verwendet wird. | |
alternateIcons.icon.size |
Zahlenenumerung | ✔️ | Gibt die Größe des Symbols in Pixeln an, das als 16 ,,,,24 32 ,40 ,48 ,,64 80 aufgezählt20 wird. Erforderliche Imagegrößen: 16 , 32 , 80 . |
|
alternateIcons.icon.url |
Zeichenfolge | 2048 Zeichen | ✔️ | Gibt die vollständige, absolute URL der Bilddatei an, die zum Darstellen des Add-Ins verwendet wird. Das Symbolbild muss 64 x 64 Pixel groß sein und eines der folgenden Dateiformate verwenden: GIF, JPG, PNG, EXIF, BMP, TIFF. |
alternateIcons.highResolutionIcon |
Objekt | ✔️ | Gibt die Eigenschaften der Bilddatei an, die verwendet wird, um das Add-In auf Bildschirmen mit hohem DPI-Wert darzustellen. | |
alternateIcons.highResolutionIcon.size |
Zahlenenumerung | ✔️ | Gibt die Größe des Symbols in Pixeln an, das als 16 ,,,,24 32 ,40 ,48 ,,64 80 aufgezählt20 wird. Erforderliche Imagegrößen: 16 , 32 , 80 . |
|
alternateIcons.highResolutionIcon.url |
Zeichenfolge | 2048 Zeichen | ✔️ | Gibt die vollständige, absolute URL der Bilddatei an, die verwendet wird, um das Add-In auf Bildschirmen mit hohem DPI-Wert darzustellen. Das Symbolbild muss 128 x 128 Pixel groß sein und eines der folgenden Dateiformate verwenden: GIF, JPG, PNG, EXIF, BMP, TIFF. |
Aktionen
Hinweis
Aktionen für Microsoft 365 sind in der öffentlichen Entwicklervorschau verfügbar.
Aktionen werden für die Microsoft 365 (Office)-App für Web und Desktop unterstützt.
Das -Objekt ist ein Array von Aktionsobjekten. Dieser Block ist nur für Lösungen erforderlich, die Aktionen enthalten.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | 64 Zeichen | ✔️ | Eine Bezeichnerzeichenfolge im Standardgebietsschema, die zum Katalogisieren von Aktionen verwendet wird. Muss für alle Aktionen für diese App eindeutig sein. Beispiel: openDocInContoso . |
displayName |
String | 64 Zeichen | ✔️ | Ein Anzeigename für die Aktion. Großbuchstaben des Ersten Buchstabens und des Markennamens. Beispiel: Zu Lieferanten hinzufügen, In Contoso öffnen und Signaturen anfordern. |
description |
String | ✔️ | Gibt die Beschreibung der Aktionen an. | |
intent |
Zeichenfolgenenumeration | ✔️ | Gibt den Typ der Absicht an. Die unterstützten Enumerationswerte sind open , addTo und custom . |
|
handlers |
Array mit Objekten | ✔️ | Ein Array von Handlerobjekten definiert, wie Aktionen verwaltet werden. Fügen Sie in der aktuellen öffentlichen Vorschau einen einzelnen Handler für jede Aktion hinzu. |
actions.handlers
Definiert die Handler der Aktion. Die Handler sind ein Array von Handlerobjekten. Jede Aktion muss über mindestens einen Handler verfügen.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
supportedObjects |
Object | Objekte, die definieren, welche Objekte diese Aktion auslösen können. | ||
type |
Zeichenfolgenenumeration | ✔️ | Gibt den Handlertyp von Aktionen an. Der unterstützte Enumerationswert ist openPage . |
|
pageInfo |
Objekt | Erforderlich, wenn der Handlertyp ist openPage . Objekt, das Metadaten der zu öffnenden Seite enthält. |
actions.handlers.supportedObjects
Die unterstützten Objekttypen, die diese Aktion auslösen können.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
file |
Object | Unterstützte Dateitypen. | ||
file.extensions |
Array aus Zeichenfolgen | Array von Zeichenfolgen. Dateierweiterungen des Dateityps, den die Aktion auslösen kann. Beispiel: pdf und docx. |
actions.handlers.pageInfo
Erforderlich, wenn der Handlertyp ist openPage
. Objekt, das Metadaten der zu öffnenden Seite enthält.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
PageId |
String | Wird der EntityId der statischen Registerkarte zugeordnet. |
||
SubPageId |
String | Wird der SubEntityId der statischen Registerkarte zugeordnet. |
dashboardCards
Optional – Array
Definiert eine Liste von Karten, die an eine Dashboard angeheftet werden können, z. B. Microsoft Viva Connections, um eine zusammengefasste Ansicht von App-Informationen bereitzustellen. Weitere Informationen zum Erstellen von Karten für Viva Connections Dashboard finden Sie unter Übersicht über botgestützte Erweiterungen für adaptive Karten.
Die dashboardCards
-Eigenschaft ist ein Array von Elementen des Typs object
.
dashboardCards.dashboardCard
Definiert eine einzelne Dashboard Karte und deren Eigenschaften.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
id |
String | ✔️ | Ein eindeutiger Bezeichner für diesen Dashboard Karte. Die ID muss eine GUID sein. | |
displayName |
String | 255 Zeichen | ✔️ | Anzeigename des Karte. |
description |
String | 255 Zeichen | ✔️ | Beschreibung des Karte. |
pickerGroupId |
String | ✔️ | ID der Gruppe in der Karte-Auswahl. Die ID muss eine GUID sein. | |
icon |
Objekt | Gibt das Symbol für die Karte an. | ||
contentSource |
Objekt | ✔️ | Gibt die Quelle des Inhalts des Karte an | |
defaultSize |
String | ✔️ | Renderinggröße für die Dashboard Karte. Optionen: medium oder large . |
dashboardCards.dashboardCard.icon
Definiert die Symboleigenschaften eines bestimmten Dashboard Karte.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
iconUrl |
Zeichenfolge | 2048 Zeichen | Position des Symbols für die Karte, die in der Toolbox und Karte angezeigt werden soll. | |
officeUIFabricIconName |
String | 255 Zeichen | Anzeigename des Office UI Fabric- oder Fluent-UI-Symbols für die Karte. Dieser Wert wird verwendet, wenn iconUrl nicht angegeben ist. |
dashboardCards.dashboardCard.contentSource
Definiert die Inhaltsquelle einer bestimmten Dashboard Karte.
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
sourceType |
String | Stellt die Quelle des Inhalts eines Karte dar. Option: bot . |
||
botConfiguration |
Objekt | Die Konfiguration für die Botquelle. Erforderlich, wenn auf sourceType festgelegt bot ist. |
dashboardCards.dashboardCard.contentSource.botConfiguration
Name | Typ | Maximale Größe | Erforderlich | Beschreibung |
---|---|---|---|---|
botId |
String | Die eindeutige Microsoft-App-ID für den Bot, wie bei Bot Framework registriert. Die ID muss eine GUID sein. |