開発者向けONLYOFFICE Docs 7.5：APIとDoc Builderのアップデート

<a href="https://www.onlyoffice.com/blog/ja/2023/10/onlyoffice-docs-7-5-released?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">バージョン7.5</a>の新機能リリースに伴い、エディタ、ドキュメントビルダー、プラグイン、デスクトップアプリのAPIを更新しました。詳細は以下をご覧ください。

<img class="alignnone wp-image-73588 size-full" src="https://static-blog.onlyoffice.com/wp-content/uploads/2023/10/23161518/onlyoffice-docs-7.5-for-developers.png" alt="ONLYOFFICE Docs 7.5 for developers: API and Doc Builder updates" width="1024" height="517" />

<!--more-->
<h2>フォームを扱うためのAPI</h2>
<strong>送信フォームボタンの表示/非表示。</strong> <a href="https://api.onlyoffice.com/editors/config/editor/customization#submitForm" target="_blank" rel="noopener">editorConfig.customization.submitForm</a>パラメータを使用して、OFORMファイルの送信ボタンを上部ツールバーに表示するか非表示にするかを定義することができます。
<pre class="theme:github font:monospace lang:default decode:true">var docEditor = new DocsAPI.DocEditor("placeholder", {     
"editorConfig": {         
"customization": {
...
"submitForm": true,</pre>
<strong>強制保存のさらなるパラメータ。</strong>バージョン 7.5 では、コールバックハンドラの <a href="https://api.onlyoffice.com/editors/callback#forcesavetype" target="_blank" rel="noopener">forcesavetype</a> パラメータに 3 タイプを追加しました。これを適用すると、フォームが送信されるたびに、例えば「<a href="https://api.onlyoffice.com/editors/config/editor/customization#submitForm" target="_blank" rel="noopener">送信</a>」ボタンがクリックされたときに、強制保存リクエストが実行されます。
<pre class="theme:github font:monospace lang:default decode:true ">{    
 "changesurl": "https://documentserver/url-to-changes.zip",     
"forcesavetype": 3,
....</pre>
<h2>文書を扱うためのAPI</h2>
<strong>外部データのソースの変更。</strong>新しく追加された<a href="https://api.onlyoffice.com/editors/config/events#onRequestReferenceSource" target="_blank" rel="noopener">events.onRequestReferenceSource</a>イベントは、ユーザがエディタで「ソースの変更」ボタンをクリックして外部データのソースを変更しようとしたときに呼び出されます。一意のファイルデータとファイルパスまたはファイル名を持つオブジェクトが data パラメータに送信されます。

ボタンがクリックされたら、外部データのソースを変更するために <a href="https://api.onlyoffice.com/editors/methods#setReferenceSource" target="_blank" rel="noopener">setReferenceSource</a> メソッドを呼び出す必要があります。このメソッドを呼び出すときは、パラメータを検証するためにトークンを追加する必要があります。イベントが宣言されていない場合、「ソースの変更」ボタンは表示されません。
<pre class="theme:github font:monospace lang:default decode:true ">var onRequestReferenceSource = function () 
{     var referenceData =  event.data.referenceData;     
var path = event.data.path; 
...
    docEditor.setReferenceSource({        
"fileType": "xlsx",         
"path": "sample.xlsx",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},</pre>
<strong>キーフィールド。</strong><a href="https://api.onlyoffice.com/editors/config/document#referenceData" target="_blank" rel="noopener">document.referenceData</a>パラメータに追加されるkeyフィールドは、サービスが共同編集セッションからデータを取得するために使用する一意のドキュメント識別子を定義します。

既知のキーが送信された場合、ドキュメントはキャッシュから取り出されます。ドキュメントが編集され保存されるたびに、キーは新たに生成されなければなりません。

ドキュメントのURLはキーとして使用できますが、特殊文字を含まず、長さは128シンボルに制限されています。
<pre class="theme:github font:monospace lang:default decode:true">var docEditor = new DocsAPI.DocEditor("placeholder", {     
"document": {         
"fileType": "docx",         
"key": "Khirz6zTPdfd7",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},</pre>
<h2>変換API</h2>
<a href="https://api.onlyoffice.com/editors/conversionapi" target="_blank" rel="noopener">変換API</a>は、コンバータが出力ファイル形式を自動的に決定できない場合に発生する<a href="https://api.onlyoffice.com/editors/conversionapi#error-codes" target="_blank" rel="noopener">-9エラーコード</a>で拡張されています。

このエラーは、クライアントが変換するファイルの形式（テキスト文書またはスプレッドシート）を明示的に指定する必要があることを意味します。これは、XMLのタイプが不明な場合にXMLをOOXMLに変換するために使用されます。
<pre class="theme:github font:monospace lang:default decode:true">{     
"error": -9 
}</pre>
<h2>その他の更新</h2>
<ul>
 	<li><a href="https://api.onlyoffice.com/editors/config/events#onRequestOpen" target="_blank" rel="noopener">events.onRequestOpen</a>イベントは、ソースを開くボタンを表示するために使用されます。</li>
 	<li>忘れられたファイルを操作するための <a href="https://api.onlyoffice.com/editors/command/deleteforgotten" target="_blank" rel="noopener">deleteForgotten</a>、<a href="https://api.onlyoffice.com/editors/command/getforgotten" target="_blank" rel="noopener">getForgotten</a>、および <a href="https://api.onlyoffice.com/editors/command/getforgottenlist" target="_blank" rel="noopener">getForgottenList</a> コマンド。</li>
 	<li>非推奨の <a href="https://api.onlyoffice.com/editors/config/events#onRequestMailMergeRecipients" target="_blank" rel="noopener">events.onRequestMailMergeRecipients</a> の代わりに <a href="https://api.onlyoffice.com/editors/config/events#onRequestSelectSpreadsheet" target="_blank" rel="noopener">events.onRequestSelectSpreadsheet</a> イベント。</li>
 	<li>非推奨の <a href="https://api.onlyoffice.com/editors/methods#setMailMergeRecipients" target="_blank" rel="noopener">setMailMergeRecipients</a> の代わりに <a href="https://api.onlyoffice.com/editors/methods#setRequestedSpreadsheet" target="_blank" rel="noopener">setRequestedSpreadsheet</a> メソッド。</li>
 	<li>非推奨の <a href="https://api.onlyoffice.com/editors/config/events#onRequestCompareFile" target="_blank" rel="noopener">events.onRequestCompareFile</a> の代わりに <a href="https://api.onlyoffice.com/editors/config/events#onRequestSelectDocument" target="_blank" rel="noopener">events.onRequestSelectDocument</a> イベント。</li>
 	<li>非推奨の <a href="https://api.onlyoffice.com/editors/methods#setRevisedFile" target="_blank" rel="noopener">setRevisedFile</a> の代わりに <a href="https://api.onlyoffice.com/editors/methods#setRequestedDocument" target="_blank" rel="noopener">setRequestedDocument</a> メソッド。</li>
</ul>
さらに、<a href="https://api.onlyoffice.com/desktop/basic" target="_blank" rel="noopener">デスクトップアプリAPI</a>では、デスクトップエディタをクラウドに接続する際のエディタテーマ設定を定義する<a href="https://api.onlyoffice.com/desktop/addingdms/loginlogout#uiTheme" target="_blank" rel="noopener">uiTheme</a>パラメータをportal:loginコマンドに追加しました。

ONLYOFFICE Docs Developer Editionの最新版を入手してください：
<p style="text-align: center;"><a class="red button" href="https://www.onlyoffice.com/ja/download-docs.aspx?utm_source=qiita&utm_medium=social&utm_campaign=docs_75_devs" target="_blank" rel="noopener">今すぐダウンロード</a></p>

<h2>プラグイン用APIの強化</h2>
新しく追加された<a href="https://api.onlyoffice.com/plugin/executemethod/common/showbutton" target="_blank" rel="noopener">ShowButton</a>メソッドのalignパラメータは、ボタンがウィンドウの右側に表示されるか、左側に表示されるかを示します。デフォルト値は "left "です。
<pre class="theme:github font:monospace lang:default decode:true">window.Asc.plugin.executeMethod ("ShowButton", ["back", false, "right"]);</pre>
<h2>ドキュメントビルダーのAPI更新</h2>
<a href="https://api.onlyoffice.com/docbuilder/basic" target="_blank" rel="noopener">DocBuilder API</a>では、複数の新しい透かし、コンボボックスとドロップダウンリストコンテンツコントロールメソッド、いくつかのグローバルメソッドとスライドメソッドを追加しました：
<ul>
 	<li><a href="https://api.onlyoffice.com/docbuilder/textdocumentapi/apiblocklvlsdt/getdropdownlist" target="_blank" rel="noopener"><u>ApiBlockLvlSdt/GetDropdownList</u></a></li>
 	<li><a href="https://api.onlyoffice.com/docbuilder/textdocumentapi/apicontentcontrollist/add" target="_blank" rel="noopener"><u>ApiContentControlList/Add</u></a></li>
 	<li><a href="https://api.onlyoffice.com/docbuilder/textdocumentapi/apidocument/getwatermarksettings" target="_blank" rel="noopener"><u>ApiDocument/GetWatermarkSettings</u></a></li>
 	<li><a href="https://api.onlyoffice.com/docbuilder/textdocumentapi/apiwatermarksettings/getdirection" target="_blank" rel="noopener"><u>ApiWatermarkSettings/GetDirection</u></a></li>
 	<li><a href="https://api.onlyoffice.com/docbuilder/presentationapi/apislide/getvisible" target="_blank" rel="noopener"><u>ApiSlide/GetVisible</u></a></li>
</ul>
新しいメソッドの<a href="https://api.onlyoffice.com/docbuilder/changelog#75" target="_blank" rel="noopener">全リスト</a>を確認してください。

<em>ご注意: Document Builder v7.5のダウンロードはもう少し後になります。</em>

<h3 class="useful-links">お役立ちリンク</h3>
ONLYOFFICE Docs 7.5の新機能: <a href="https://www.onlyoffice.com/blog/ja/2023/10/onlyoffice-docs-7-5-released?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">ブログ</a> / <a href="https://youtu.be/gu9dvR4tDYk" target="_blank" rel="noopener">ウェビナー</a>

<a href="https://www.onlyoffice.com/ja/developer-edition.aspx?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">開発者向けONLYOFFICE</a>

<a href="https://www.onlyoffice.com/ja/document-builder.aspx?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">ONLYOFFICEドキュメントビルダー</a>

<a href="https://api.onlyoffice.com/?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">APIドキュメント</a>

<a href="https://api.onlyoffice.com/editors/changelog?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">Docs API変更履歴</a>

<a href="https://api.onlyoffice.com/plugin/changelog?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">プラグインとマクロの変更履歴</a>

<a href="https://api.onlyoffice.com/docbuilder/changelog?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_75_devs" target="_blank" rel="noopener">DocBuilderの変更履歴</a>