Office 共通 API の要件セット
要件セットは、API メンバーの名前付きグループです。 Office アドインでは、マニフェストで指定されている要件セットを使用するか、ランタイム チェックを使用して、Office アプリケーションがアドインに必要な API をサポートしているかどうかを判断します。 詳細については、「 Office のバージョンと要件セット」を参照してください。
ヒント
アプリケーション固有の API 要件セットをお探しですか? 次の API 要件セットを参照してください。
- Excel JavaScript API 要件セット (ExcelApi)
- Word JavaScript API 要件セット (WordApi)
- OneNote JavaScript API 要件セット (OneNoteApi)
- PowerPoint JavaScript API 要件セット (PowerPointApi)
- Outlook API 要件セットについて (Mailbox)
共通 API の要件セット
次のセクションでは、共通 API 要件セット、各セット内のメソッド、およびその要件セットをサポートする Office クライアント アプリケーションを示します。 特に指定がない限り、これらの API 要件セットのバージョンはすべて 1.1 です。
ヒント
アドインと要件セットが Office アプリケーションとバージョンでサポートされている場所に関する情報が必要ですか? 「Office アドインの Office クライアント アプリケーションとプラットフォームの可用性」を参照してください。
ActiveView
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint |
- Document.getActiveViewAsync |
AddInCommands
「アドイン コマンドの要件セット」を参照してください。
BindingEvents
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- Binding.addHandlerAsync - Binding.removeHandlerAsync |
CompressedFile
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2016 - Excel on the web - Excel on Mac - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getFileAsync メソッドを使用するときの、 バイト配列 (Office.FileType.Compressed) としての Office Open XML (OOXML) 形式への出力をサポートします。 |
CustomXmlParts
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- CustomXmlNode.getNodesAsync - CustomXmlNode.getNodeValueAsync - CustomXmlNode.getTextAsync - CustomXmlNode.getXmlAsync - CustomXmlNode.setNodeValueAsync - CustomXmlNode.setTextAsync - CustomXmlNode.setXmlAsync - CustomXmlPart.addHandlerAsync - CustomXmlPart.deleteAsync - CustomXmlPart.getNodesAsync - CustomXmlPart.getXmlAsync - CustomXmlPart.removeHandlerAsync - CustomXmlParts.addAsync - CustomXmlParts.getByIdAsync - CustomXmlParts.getByNamespaceAsync - CustomXmlPrefixMappings.addNamespaceAsync - CustomXmlPrefixMappings.getNamespaceAsync - CustomXmlPrefixMappings.getPrefixAsync |
DialogApi
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| 「ダイアログ API の要件セット」を参照してください。 | - UI.messageParent - UI.displayDialogAsync - UI.closeContainer -Ui。] ダイアログ |
DialogOrigin
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| ダイアログ配信元要件セットに関するページを参照してください。 | クロスドメイン のサポート: - UI.messageParent -Ui。Dialog.messageChild |
DocumentEvents
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - OneNote on the web - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- Document.addHandlerAsync - Document.removeHandlerAsync |
File
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- Document.getFileAsync - File.closeAsync - File.getSliceAsync |
HtmlCoercion
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - OneNote on the web - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、HTML への強制型変換 (Office.CoercionType.Html) をサポートします。 |
IdentityAPI
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| 「Identity API の要件セット」を参照してください。 | - Auth.getAccessToken |
ImageCoercion
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| 「画像強制型変換要件セット」を参照してください。 | - Document.setSelectedDataAsync |
KeyboardShortcuts
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| 「 キーボード ショートカットの要件セット」を参照してください。 | - Office.actions.areShortcutsInUse - Office.actions.getShortcuts - Office.actions.replaceShortcuts |
Mailbox
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Outlook on Windows -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - 新しい Outlook on Windows (プレビュー) - Outlook on the web - Android 上の Outlook - Outlook on Mac - iOS 上の Outlook |
「Outlook API 要件セットについて」をご覧ください。 |
MatrixBindings
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Web 上のWord - iPad のWord - Mac でWord |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.getDataAsync - Binding.setDataAsync |
MatrixCoercion
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、"matrix" (配列の配列) データ構造への強制型変換 (Office.CoercionType.Matrix) をサポートします。 |
OoxmlCoercion
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、Open Office XML (OOXML) 形式への強制型変換 (Office.CoercionType.Ooxml) をサポートします。 |
OpenBrowserWindowApi
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| 「 ブラウザー ウィンドウ API 要件セットを開く」を参照してください。 | - Office.context.ui.openBrowserWindow |
PartialTableBindings
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| なし。 |
PdfFile
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - Excel on Mac - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getFileAsync メソッドを使用するときの、 PDF 形式 (Office.FileType.Pdf) への出力をサポートします。 |
RibbonApi
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| リボン API 要件セットに関するページを参照してください。 | - Office.ribbon.requestUpdate |
Selection
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows 上のプロジェクト -- ボリューム ライセンスの永続的な Office 2013 - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- Document.getSelectedDataAsync - Document.setSelectedDataAsync |
Settings
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - OneNote on the web - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- Settings.get - Settings.remove - Settings.saveAsync - Settings.set |
SharedRuntime
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| 「共有ランタイム要件セット」を参照してください。 | - Office.addin.getStartupBehavior - Office.addin.hide - Office.addin.onVisibilityModeChanged - Office.addin.setStartupBehavior - Office.addin.showAsTaskpane - Office.BeforeDocumentCloseNotification.disable - Office.BeforeDocumentCloseNotification.enable - Office.BeforeDocumentCloseNotification.onCloseActionCancelled |
TableBindings
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.addColumnsAsync - Binding.addRowsAsync - Binding.deleteAllDataValuesAsync - Binding.getDataAsync - Binding.setDataAsync |
TableCoercion
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、"table" データ構造への強制型変換 (Office.CoercionType.Table) をサポートします。 |
TextBindings
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.getDataAsync - Binding.setDataAsync |
TextCoercion
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - OneNote on the web - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows 上のプロジェクト -- ボリューム ライセンスの永続的な Office 2013 - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、テキスト形式への強制型変換 (Office.CoercionType.Text) をサポートします。 |
TextFile
| Office アプリケーションの最小サポート | セット内のメソッド |
|---|---|
| - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Mac でWord - Web 上のWord - iPad のWord |
Document.getFileAsync メソッドを使用するとき、テキスト形式 (Office.FileType.Text) への出力をサポートします。 |
要件セットの一部ではないメソッド
Office JavaScript API の次のメソッドは、要件セットの一部ではありません。 アドインでこれらのメソッドのいずれかが必要な場合は、アドインのマニフェストの Methods> 要素と Method 要素を使用<して、それらが必須であることを宣言するか、ステートメントを使用してランタイム チェックをif実行します。>< 詳細については、「 Office アプリケーションと API の要件を指定する」を参照してください。
| メソッド名 | Office アプリケーションの最小サポート |
|---|---|
| Bindings.addFromPromptAsync | - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac |
| Document.getFilePropertiesAsync | - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Web 上のWord - iPad のWord - Mac でWord |
| Document.getProjectFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getResourceFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedResourceAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedTaskAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedViewAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getTaskAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getTaskFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.goToByIdAsync | - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - iPad 上の PowerPoint - Mac 上の PowerPoint - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Web 上のWord - iPad のWord - Mac でWord |
| Settings.addHandlerAsync | - Excel on the web |
| Settings.refreshAsync | - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - Windows 上の PowerPoint -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - PowerPoint on the web - Windows でのWord -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Web 上のWord |
| Settings.removeHandlerAsync | - Excel on the web |
| TableBinding.clearFormatsAsync | - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac |
| TableBinding.setFormatsAsync | - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac |
| TableBinding.setTableOptionsAsync | - Windows 上の Excel -- Microsoft 365 サブスクリプション -- 永続的な Office 2013 - Excel on the web - iPad 上の Excel - Excel on Mac |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示