Office 共通 API の要件セットOffice Common API requirement sets
要件セットは、API メンバーの名前付きグループです。Office アドインは、マニフェストで指定されている要件セットを使用するか、ランタイム チェックを使用して、Office ホストがアドインに必要な API をサポートしているかどうかを判別します。詳しくは、「Office のバージョンと要件セット」をご覧ください。Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office host supports APIs that an add-in needs. For more information, see Office versions and requirement sets.
Office ホストによってアドインがサポートされる場所に関する情報が必要ですか?Need information about where add-ins are supported by Office host? 「Office アドインのホストとプラットフォームの可用性」を参照してください。See Office Add-in host and platform availability.
ホスト固有の API 要件セットをお探しですか?Looking for the host-specific API requirement sets? 次の API 要件セットを参照してください。See the following API requirement sets:
- Excel JavaScript API 要件セット (ExcelApi)Excel JavaScript API requirement sets (ExcelApi)
- Word JavaScript API 要件セット (WordApi)Word JavaScript API requirement sets (WordApi)
- OneNote JavaScript API 要件セット (OneNoteApi)OneNote JavaScript API requirement sets (OneNoteApi)
- PowerPoint JavaScript API 要件セット (PowerPointApi)PowerPoint JavaScript API requirement sets (PowerPointApi)
- Outlook API 要件セットについて (Mailbox)Understanding Outlook API requirement sets (Mailbox)
重要
SharePoint で Access Web アプリとデータベースを作成して使用することは推奨されなくなりました。We no longer recommend that you create and use Access web apps and databases in SharePoint. 代わりに、Microsoft PowerApps を使用して、コード作成が不要な Web とモバイル デバイス用ビジネス ソリューションをビルドすることをお勧めします。As an alternative, we recommend that you use Microsoft PowerApps to build no-code business solutions for web and mobile devices.
共通 API の要件セットCommon API requirement sets
次のセクションは、共通 API の要件セット、各セットのメソッド、その要件セットをサポートする Office ホスト アプリケーションの一覧です。The following sections list the Common API requirement sets, the methods in each set, and the Office host applications that support that requirement set. 特に指定がない限り、これらの API 要件セットのバージョンはすべて 1.1 です。All of these API requirement sets are version 1.1, unless otherwise specified.
ActiveViewActiveView
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac |
Document.getActiveViewAsyncDocument.getActiveViewAsync |
AddInCommandsAddInCommands
「アドイン コマンドの要件セット」を参照してください。See Add-in command requirement sets.
BindingEventsBindingEvents
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Access Web AppAccess Web Apps Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Binding.addHandlerAsyncBinding.addHandlerAsync Binding.removeHandlerAsyncBinding.removeHandlerAsync |
CompressedFileCompressedFile
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on MacExcel on Mac PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getFileAsync メソッドを使用するときの、Supports output to Office Open XML (OOXML) format as a byte array バイト配列 (Office.FileType.Compressed) としての Office Open XML (OOXML) 形式への出力をサポートします。(Office.FileType.Compressed) when using the Document.getFileAsync method. |
CustomXmlPartsCustomXmlParts
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
CustomXmlNode.getNodesAsyncCustomXmlNode.getNodesAsync CustomXmlNode.getNodeValueAsyncCustomXmlNode.getNodeValueAsync CustomXmlNode.getTextAsyncCustomXmlNode.getTextAsync CustomXmlNode.getXmlAsyncCustomXmlNode.getXmlAsync CustomXmlNode.setNodeValueAsyncCustomXmlNode.setNodeValueAsync CustomXmlNode.setTextAsyncCustomXmlNode.setTextAsync CustomXmlNode.setXmlAsyncCustomXmlNode.setXmlAsync CustomXmlPart.addHandlerAsyncCustomXmlPart.addHandlerAsync CustomXmlPart.deleteAsyncCustomXmlPart.deleteAsync CustomXmlPart.getNodesAsyncCustomXmlPart.getNodesAsync CustomXmlPart.getXmlAsyncCustomXmlPart.getXmlAsync CustomXmlPart.removeHandlerAsyncCustomXmlPart.removeHandlerAsync CustomXmlParts.addAsyncCustomXmlParts.addAsync CustomXmlParts.getByIdAsyncCustomXmlParts.getByIdAsync CustomXmlParts.getByNamespaceAsyncCustomXmlParts.getByNamespaceAsync CustomXmlPrefixMappings.addNamespaceAsyncCustomXmlPrefixMappings.addNamespaceAsync CustomXmlPrefixMappings.getNamespaceAsyncCustomXmlPrefixMappings.getNamespaceAsync CustomXmlPrefixMappings.getPrefixAsyncCustomXmlPrefixMappings.getPrefixAsync |
DialogApiDialogApi
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| 「ダイアログ API の要件セット」を参照してください。See Dialog API requirement sets. | UI.messageParentUI.messageParent UI.displayDialogAsyncUI.displayDialogAsync UI.closeContainerUI.closeContainer UI.DialogUI.Dialog |
DocumentEventsDocumentEvents
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac OneNote on the webOneNote on the web PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.addHandlerAsyncDocument.addHandlerAsync Document.removeHandlerAsyncDocument.removeHandlerAsync |
FileFile
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getFileAsyncDocument.getFileAsync File.closeAsyncFile.closeAsync File.getSliceAsyncFile.getSliceAsync |
HtmlCoercionHtmlCoercion
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| OneNote on the webOneNote on the web Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、HTML への強制型変換 (Office.CoercionType.Html) をサポートします。Supports coercion to HTML (Office.CoercionType.Html) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods. |
IdentityAPIIdentityAPI
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| 「Identity API の要件セット」を参照してください。See Identity API requirement sets. | Auth.getAccessTokenAuth.getAccessToken |
ImageCoercionImageCoercion
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| 「画像強制型変換要件セット」を参照してください。See Image Coercion requirement sets. | Document.setSelectedDataAsync メソッドDocument.setSelectedDataAsync method |
MailboxMailbox
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Windows での OutlookOutlook on Windows Outlook on the webOutlook on the web Outlook on AndroidOutlook on Android Outlook on MacOutlook on Mac Outlook on iOSOutlook on iOS |
「Outlook API 要件セットについて」をご覧ください。See Understanding Outlook API requirement sets. |
MatrixBindingsMatrixBindings
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac Word on WindowsWord on Windows Word on the webWord on the web Word on iPadWord on iPad Word on MacWord on Mac |
Bindings.addFromNamedItemAsyncBindings.addFromNamedItemAsync Bindings.addFromSelectionAsyncBindings.addFromSelectionAsync Bindings.getAllAsyncBindings.getAllAsync Bindings.getByIdAsyncBindings.getByIdAsync Bindings.releaseByIdAsyncBindings.releaseByIdAsync Binding.getDataAsyncBinding.getDataAsync Binding.setDataAsyncBinding.setDataAsync |
MatrixCoercionMatrixCoercion
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、"matrix" (配列の配列) データ構造への強制型変換 (Office.CoercionType.Matrix) をサポートします。Supports coercion to the "matrix" (array of arrays) data structure (Office.CoercionType.Matrix) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods. |
OoxmlCoercionOoxmlCoercion
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、Open Office XML (OOXML) 形式への強制型変換 (Office.CoercionType.Ooxml) をサポートします。Supports coercion to Open Office XML (OOXML) format (Office.CoercionType.Ooxml) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods. |
PartialTableBindingsPartialTableBindings
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Access Web AppAccess Web Apps |
PdfFilePdfFile
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on MacExcel on Mac PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getFileAsync メソッドを使用するときの、Supports output to PDF format (Office.FileType.Pdf) PDF 形式 (Office.FileType.Pdf) への出力をサポートします。when using the Document.getFileAsync method. |
SelectionSelection
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac Project on WindowsProject on Windows Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getSelectedDataAsyncDocument.getSelectedDataAsync Document.setSelectedDataAsyncDocument.setSelectedDataAsync |
SettingsSettings
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Access Web AppAccess Web Apps Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac OneNote on the webOneNote on the web PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Settings.getSettings.get Settings.removeSettings.remove Settings.saveAsyncSettings.saveAsync Settings.setSettings.set |
TableBindingsTableBindings
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Access Web AppAccess Web Apps Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Bindings.addFromNamedItemAsyncBindings.addFromNamedItemAsync Bindings.addFromSelectionAsyncBindings.addFromSelectionAsync Bindings.getAllAsyncBindings.getAllAsync Bindings.getByIdAsyncBindings.getByIdAsync Bindings.releaseByIdAsyncBindings.releaseByIdAsync Binding.addColumnsAsyncBinding.addColumnsAsync Binding.addRowsAsyncBinding.addRowsAsync Binding.deleteAllDataValuesAsyncBinding.deleteAllDataValuesAsync Binding.getDataAsyncBinding.getDataAsync Binding.setDataAsyncBinding.setDataAsync |
TableCoercionTableCoercion
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Access Web AppAccess Web Apps Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、"table" データ構造への強制型変換 (Office.CoercionType.Table) をサポートします。Supports coercion to the "table" data structure (Office.CoercionType.Table) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods. |
TextBindingsTextBindings
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad Excel on MacExcel on Mac Word 2013 以降および WindowsWord 2013 and later and Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Bindings.addFromNamedItemAsyncBindings.addFromNamedItemAsync Bindings.addFromSelectionAsyncBindings.addFromSelectionAsync Bindings.getAllAsyncBindings.getAllAsync Bindings.getByIdAsyncBindings.getByIdAsync Bindings.releaseByIdAsyncBindings.releaseByIdAsync Binding.getDataAsyncBinding.getDataAsync Binding.setDataAsyncBinding.setDataAsync |
TextCoercionTextCoercion
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Excel on WindowsExcel on Windows Excel on the webExcel on the web Excel on iPadExcel on iPad OneNote on the webOneNote on the web PowerPoint on WindowsPowerPoint on Windows PowerPoint on the webPowerPoint on the web PowerPoint on iPadPowerPoint on iPad PowerPoint on MacPowerPoint on Mac Project on WindowsProject on Windows Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getSelectedDataAsync、Document.setSelectedDataAsync、Binding.getDataAsync、または Binding.setDataAsync の各メソッドを使用してデータを読み書きするとき、テキスト形式への強制型変換 (Office.CoercionType.Text) をサポートします。Supports coercion to text format (Office.CoercionType.Text) when reading and writing data using the Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync, or Binding.setDataAsync methods. |
TextFileTextFile
| Office のホストOffice hosts | セット内のメソッドMethods in set |
|---|---|
| Word on Windows (Word 2013 以降)Word 2013 and later on Windows Word on Mac (Word 2016 以降)Word 2016 and later on Mac Word on the webWord on the web Word on iPadWord on iPad |
Document.getFileAsync メソッドを使用するとき、テキスト形式 (Office.FileType.Text) への出力をサポートします。Supports output to text format (Office.FileType.Text) when using the Document.getFileAsync method. |
要件セットの一部ではないメソッドMethods that aren't part of a requirement set
JavaScript API for Office の以下のメソッドは、要件セットの一部ではありません。The following methods in the JavaScript API for Office aren't part of a requirement set. アドインでこれらのメソッドが必要な場合は、アドインのマニフェストで Methods 要素と Method 要素を使用してメソッドが必要であると宣言するか、または if ステートメントを使用してランタイム チェックを実行します。If your add-in requires any of these methods, use the Methods and Method elements in the add-in's manifest to declare that they are required, or perform the runtime check using an if statement. 詳細については、「Office のホストと API の要件を指定する」を参照してください。For more information, see Specify Office hosts and API requirements.
| メソッド名Method name | サポートされる Office のホストOffice host support |
|---|---|
| Bindings.addFromPromptAsyncBindings.addFromPromptAsync | Access Web アプリ、Excel on Windows、Excel on the web、Excel on iPad、および Excel on MacAccess web apps, Excel on Windows, Excel on the web, Excel on iPad, and Excel on Mac |
| Document.getFilePropertiesAsyncDocument.getFilePropertiesAsync | Excel on Windows、Excel on the web、Excel on iPad、Excel on Mac、PowerPoint on Windows、PowerPoint on the web、PowerPoint on iPad、PowerPoint on Mac、Word on Windows、Word on the web、Word on iPad、および Word on MacExcel on Windows, Excel on the web, Excel on iPad, Excel on Mac, PowerPoint on Windows, PowerPoint on the web, PowerPoint on iPad, PowerPoint on Mac, Word on Windows, Word on the web, Word on iPad, and Word on Mac |
| Document.getProjectFieldAsyncDocument.getProjectFieldAsync | Project Standard 2013、Project Professional 2013Project Standard 2013 and Project Professional 2013 |
| Document.getResourceFieldAsyncDocument.getResourceFieldAsync | Project Standard 2013、Project Professional 2013Project Standard 2013 and Project Professional 2013 |
| Document.getSelectedResourceAsyncDocument.getSelectedResourceAsync | Project Standard 2013、Project Professional 2013Project Standard 2013 and Project Professional 2013 |
| Document.getSelectedTaskAsyncDocument.getSelectedTaskAsync | Project Standard 2013、Project Professional 2013Project Standard 2013 and Project Professional 2013 |
| Document.getSelectedViewAsyncDocument.getSelectedViewAsync | Project Standard 2013、Project Professional 2013Project Standard 2013 and Project Professional 2013 |
| Document.getTaskAsyncDocument.getTaskAsync | Project Standard 2013、Project Professional 2013Project Standard 2013 and Project Professional 2013 |
| Document.getTaskFieldAsyncDocument.getTaskFieldAsync | Project Standard 2013、Project Professional 2013Project Standard 2013 and Project Professional 2013 |
| Document.goToByIdAsyncDocument.goToByIdAsync | Excel on Windows、Excel on the web、Excel on iPad、Excel on Mac、PowerPoint on Windows、PowerPoint on the web、PowerPoint on iPad、PowerPoint on Mac、Word on Windows、Word on the web、Word on iPad、および Word on MacExcel on Windows, Excel on the web, Excel on iPad, Excel on Mac, PowerPoint on Windows, PowerPoint on the web, PowerPoint on iPad, PowerPoint on Mac, Word on Windows, Word on the web, Word on iPad, and Word on Mac |
| Settings.addHandlerAsyncSettings.addHandlerAsync | Access Web アプリおよび Excel on the webAccess web apps and Excel on the web |
| Settings.refreshAsyncSettings.refreshAsync | Access Web アプリ、Excel on Windows、Excel on the web、PowerPoint on Windows、PowerPoint on the web、Word、および Word on the webAccess web apps, Excel on Windows, Excel on the web, PowerPoint on Windows, PowerPoint on the web, Word, and Word on the web |
| Settings.removeHandlerAsyncSettings.removeHandlerAsync | Access Web アプリおよび Excel on the webAccess web apps and Excel on the web |
| TableBinding.clearFormatsAsyncTableBinding.clearFormatsAsync | Excel on Windows、Excel on the web、Excel on iPad、および Excel on MacExcel on Windows, Excel on the web, Excel on iPad, and Excel on Mac |
| TableBinding.setFormatsAsyncTableBinding.setFormatsAsync | Excel on Windows、Excel on the web、Excel on iPad、および Excel on MacExcel on Windows, Excel on the web, Excel on iPad, and Excel on Mac |
| TableBinding.setTableOptionsAsyncTableBinding.setTableOptionsAsync | Excel on Windows、Excel on the web、Excel on iPad、および Excel on MacExcel on Windows, Excel on the web, Excel on iPad, and Excel on Mac |