開発者向けONLYOFFICE Docs 8.2：APIの更新

<a href="https://www.onlyoffice.com/blog/ja/2024/10/onlyoffice-docs-8-2-released?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>バージョン8.2</u></a>の新機能リリースに伴い、エディタ用API、Office API、プラグインを更新し、ドキュメントビルダー用のJavaフレームワークとPHP統合SDKを追加しました。詳細は下記をご覧ください。

<img class="alignnone wp-image-214789 size-full" src="https://static-blog.onlyoffice.com/wp-content/uploads/2024/10/30154925/ONLYOFFICE-Docs-8.2-for-developers.png" alt="ONLYOFFICE Docs 8.2 for developers: API updates" width="1472" height="742" />

<!--more-->
<h2>ダウンタイムなしの展開</h2>
ダウンタイムなしの展開は、アプリケーションを中断することなく更新する優れた方法です。そのため、エディタをオフラインにすることなくアップグレードすることができます。

<b>どのように動作するのでしょうか？</b>新しいバージョンのONLYOFFICE Docs (Document Server, DS) インスタンスは、現在実行中のDocument Serverと並行して起動されます。新しい編集セッションは新しいDSで開かれます。ユーザーが編集セッションを終了するまで、以前のDSバージョンは機能します。その後、以前のDSが停止します。

ONLYOFFICE Docs Shardsについて言えば、編集セッションをクラスタ内の特定のDSに直接指示することができます。したがって、異なるバージョンのドキュメントサーバーを並行して動作させることができます。リソースの複製と更新プロセス自体に時間がかかる可能性があることを考慮に入れてください。

<b>ご注意：</b>ゼロダウンタイム展開は、<a href="https://github.com/ONLYOFFICE/Kubernetes-Docs-Shards" target="_blank" rel="noopener"><u>Kubernetesシャード</u></a>として提供されるONLYOFFICE Docsで利用可能です。もっと詳しく知りたい方は、<a href="mailto:sales@onlyoffice.com" target="_blank" rel="noopener"><u>sales@onlyoffice.com</u></a>までご連絡ください。
<h2>PHP 統合 SDK</h2>
ONLYOFFICE Docs を PHP で書かれたアプリケーションに簡単に統合できます。 SDK には、初期化構成の作成とバックエンドの一般的なメソッドの処理を行う、PHP 統合用の一般的なコードが含まれています。 <a href="https://packagist.org/packages/onlyoffice/docs-integration-sdk" target="_blank" rel="noopener"><u>こちらをチェック</u></a>

<i>PHP SDK は現在、例えば、</i><a href="https://www.onlyoffice.com/ja/office-for-chamilo.aspx?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><i><u>ONLYOFFICE と Chamilo の統合</u></i></a><i>に実装されています。</i>
<h2>新しいインターフェーススタイル</h2>
<i>editorConfig.customization.features</i>パラメータは、<a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/customization/#featurestabstyle" target="_blank" rel="noopener"><u>tabStyle</u></a>と<a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/customization/#featurestabbackground" target="_blank" rel="noopener"><u>tabBackground</u></a>という2つの追加フィールドをもたらします。これにより、エディタの外観を好みに合わせて調整することができます。

前者は、<b>Fill</b>（上部のツールバータブがはっきりと表示される）または<b>Line</b> style（上部のツールバータブが下線で強調表示される）を設定できます。

後者は、上部のツールバータブの背景がヘッダー背景またはツールバー背景と一致するかどうかを定義します。

<img class="alignnone wp-image-214808 size-full" src="https://static-blog.onlyoffice.com/wp-content/uploads/2024/10/30160218/fill-or-line-tab-style.png" alt="ONLYOFFICE Docs 8.2 for developers: API updates" width="1560" height="447" />

さらに、<i>editorConfig.customization.logo</i>パラメータに<a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/customization/#logoimagelight" target="_blank" rel="noopener"><u>imageLight</u></a>フィールドを追加しました。これは、新たに追加された灰色テーマのライトヘッダーで使用される画像ファイルへのパスを定義します。

<img class="alignnone wp-image-214824 size-full" src="https://static-blog.onlyoffice.com/wp-content/uploads/2024/10/30160344/image-light.png" alt="ONLYOFFICE Docs 8.2 for developers: API updates" width="1142" height="299" />
<pre class="theme:github font:monospace lang:default decode:true ">const logo = {
  image: "https://example.com/logo.png",
  imageDark: "https://example.com/dark-logo.png",
  imageLight: "https://example.com/light-logo.png",
  url: "https://example.com",
  visible: true,
}</pre>
<h2>サードパーティソースからのテキスト挿入</h2>
<a href="https://api.onlyoffice.com/docs/docs-api/usage-api/methods/#setrequesteddocument" target="_blank" rel="noopener"><u>setRequestedDocument</u></a> メソッドの<i> c</i> パラメータに、<i>insert-text</i> タイプのドキュメント選択が追加されました。これにより、ユーザーはローカル/URL/ストレージファイルからドキュメントを選択し、その内容を現在のドキュメントに挿入することができます。
<pre class="theme:github font:monospace lang:default decode:true ">docEditor.setRequestedDocument({
  c: "insert-text",
  fileType: "docx",
  url: "https://example.com/url-to-example-document.docx",
...</pre>
<h2>文書のステータス確認</h2>
<a href="https://api.onlyoffice.com/docs/docs-api/additional-api/command-service/info/" target="_blank" rel="noopener"><u>info</u></a>コマンドのレスポンスに<i>ユーザー</i>パラメータが追加されました。このパラメータは、文書を編集用に開いたユーザーの識別子のリストを定義します。文書が変更された場合、ユーザーは最後に文書を編集したユーザーの識別子を返します。
<pre class="theme:github font:monospace lang:default decode:true ">{
  "error": 0,
  "key": "Khirz6zTPdfd7",
  "users": ["6d5a81d0", "78e1e841"]
}</pre>
<h2>Docs APIで他に変更された点</h2>
<ul>
 	<li>保護されたドキュメントで動作する<a href="https://api.onlyoffice.com/docs/docs-api/using-wopi/conversion-api/" target="_blank" rel="noopener"><u>WOPI変換API</u></a>用の新しいリクエストパラメータ：<i>Password</i>および<i>PasswordToOpen</i></li>
 	<li><a href="https://api.onlyoffice.com/docs/docs-api/additional-api/command-service/" target="_blank" rel="noopener"><u>コマンドサービス</u></a>の<i>https://documentserver/coauthoring/CommandService.ashx</i>アドレスが<i>https://documentserver/coauthoring/commandに置き換えられました</i></li>
 	<li><a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/#location" target="_blank" rel="noopener"><u>editorConfig.location</u></a>フィールドは廃止されました。すべてのエディタタイプでデフォルトの測定単位を定義するには、代わりに<a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/#region" target="_blank" rel="noopener"><u>editorConfig.region</u></a>フィールドを使用してください</li>
 	<li><a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/customization/#toolbarnotabs" target="_blank" rel="noopener"><u>editorConfig.customization.toolbarNoTabs</u></a>フィールドは廃止されました。代わりに<a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/customization/#featurestabstyle" target="_blank" rel="noopener"><u>editorConfig.customization.features.tabStyle</u></a>および<a href="https://api.onlyoffice.com/docs/docs-api/usage-api/config/editor/customization/#featurestabbackground" target="_blank" rel="noopener"><u>editorConfig.customization.features.tabBackground</u></a>フィールドを使用してください</li>
</ul>
ONLYOFFICE Docs Developerの最新バージョンを入手する：
<p style="text-align: center;"><a class="red button" href="https://www.onlyoffice.com/ja/download-docs.aspx?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs#docs-developer" target="_blank" rel="noopener">今すぐダウンロード</a></p>

<h2>メール通知：ライセンスとクォータ制限の警告</h2>
ライセンスの有効期限が迫っている、または接続制限に達しようとしているなど、Eメール通知を送信することが可能になりました。

<b>どのように機能するか？</b> サーバー構成にメールサーバーの設定機能を追加しました。通知の送信には外部メールサーバーを使用し、Nodemailerライブラリを通じて接続します。サーバー構成の多くの設定が、このライブラリに直接転送されます。
<h2>プラグイン用APIの強化</h2>
プラグインAPIは、<i>元に戻す</i>、<i>やり直し</i>のアクションを実行するメソッドなど、便利な強化機能も提供します。
<ul>
 	<li><code>api.prototype.Undo = function()</code></li>
 	<li><code>api.prototype.Redo = function()</code></li>
 	<li><code>api.prototype.CanUndo = function()</code></li>
 	<li><code>api.prototype.CanRedo = function()</code></li>
</ul>
プラグインAPI更新の<a href="https://api.onlyoffice.com/docs/plugin-and-macros/more-information/changelog/?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>全リスト</u></a>を確認してください。
<h2>ドキュメントビルダー用Javaフレームワーク</h2>
ONLYOFFICEドキュメントビルダーでは、現在、<a href="https://api.onlyoffice.com/docs/document-builder/builder-framework/java/?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>Javaビルダーフレームワーク</u></a>が利用可能です。これは、ドキュメント作成機能を持つJavaアプリケーションを迅速に開発することを可能にするライブラリ、クラス、および関数のコレクションを含んでいます。

<img class="alignnone wp-image-214841 size-full" src="https://static-blog.onlyoffice.com/wp-content/uploads/2024/10/30160927/Java-Builder.png" alt="ONLYOFFICE Docs 8.2 for developers: API updates" width="988" height="908" />
<p style="text-align: center;"><a class="red button" href="https://www.onlyoffice.com/ja/download-builder.aspx?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener">ドキュメントビルダーを入手</a></p>

<h2>Office API</h2>
<a href="https://api.onlyoffice.com/docs/office-api/get-started/overview/?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>Office JavaScript API</u></a> では、バージョン8.2で、以下を含む多くの新しいメソッドを追加しました。
<ul>
 	<li>範囲</li>
 	<li>ピボットテーブル</li>
 	<li>プレースホルダ</li>
 	<li>単語/文章の取得と置換</li>
 	<li>すべてのフィールドの更新</li>
 	<li>アウトライン</li>
 	<li>その他</li>
</ul>
新しいメソッドの<a href="https://api.onlyoffice.com/docs/office-api/more-information/changelog/?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>全リスト</u></a>を確認してください。
<div class="useful-links">
<h3>お役立ちリンク</h3>
ONLYOFFICE Docs 8.2の新機能：<a href="https://www.onlyoffice.com/blog/ja/2024/10/onlyoffice-docs-8-2-released?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>ブログ</u></a>/<a href="https://youtu.be/pzZ2xySzdAA" target="_blank" rel="noopener"><u>ウェビナー</u></a>

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

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

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

<a href="https://api.onlyoffice.com/docs/docs-api/more-information/changelog/?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>Docs APIの変更履歴</u></a>

<a href="https://api.onlyoffice.com/docs/office-api/more-information/changelog/?utm_source=qiita&amp;utm_medium=social&amp;utm_campaign=docs_82_devs" target="_blank" rel="noopener"><u>Office APIの変更履歴</u></a>

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

</div>