Node.JSでWordページに付箋を作成する

Word文書に直接クイックコメントを追加することは、共同レビューのワークフローで一般的な要件です。 GroupDocs.Annotation Cloud SDK for Node.JS を使用すると、サーバー環境を離れることなくプログラムでリッチな注釈を追加できます。このガイドでは、Node.JS で Word ページに Sticky Notes を作成する方法を、セットアップ、詳細な手順、完全なコード例、そして同等の cURL 呼び出しを含めて解説します。

GroupDocs.Annotation Cloud SDK for Node.JS の設定

開始する前に、以下が揃っていることを確認してください：

Node.js 14+ と npm がインストールされていること
clientId と clientSecret を持つ GroupDocs クラウドアカウント
アノテーションしたいソースの DOCX ファイルへのアクセス

npm を使用して SDK をインストールします:

npm install groupdocs-annotation-cloud

手動インストールを希望する場合は、公式リリースページから最新パッケージをダウンロードしてください: GroupDocs.Annotation Cloud SDK for Node.JS Download。

認証情報を使用して構成オブジェクトを作成します（完全な例からの抜粋）:

const { Configuration } = require("@groupdocs.annotation-cloud");

const config = new Configuration({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET"
});

SDK がインストールされ、認証情報が準備できたら、実装に進むことができます。

Node.JS で Word ページに付箋を作成する: ステップバイステップのウォークスルー

このハンズオンでは、SDK のアノテーションクラスを使用して、Node.JS で Word ページに付箋ノートを作成します。

ステップ 1: アノテーション API の初期化

まず、必要なクラスをインポートし、AnnotateApi のインスタンスを作成します。

const { AnnotateApi, models } = require("@groupdocs.annotation-cloud");
const annotateApi = new AnnotateApi(config);

ステップ 2: ソースおよび宛先ファイルの定義

入力 DOCX と注釈付き出力のパスを指定します。

const inputFilePath = "sample.docx";
const outputFilePath = "sample_annotated.docx";

const fileInfo = new models.FileInfo();
fileInfo.filePath = inputFilePath;

ステップ 3: スティッキーノートの位置を設定する

ページ 1 にスティッキーノートが表示される位置を決定する Rectangle を作成します。

const rect = new models.Rectangle();
rect.x = 100;      // distance from left edge (points)
rect.y = 100;      // distance from top edge (points)
rect.width = 200;  // width of the sticky note
rect.height = 100; // height of the sticky note

ステップ 4: スティッキーノートアノテーションオブジェクトの作成

アノテーションのタイプ、ページ番号、矩形、テキスト、背景色を設定します。

const stickyNote = new models.AnnotationInfo();
stickyNote.annotationType = "StickyNote";
stickyNote.pageNumber = 1;
stickyNote.rect = rect;
stickyNote.text = "This is a sticky note added via GroupDocs.Annotation Cloud SDK.";
stickyNote.color = "FFFF00"; // Yellow background

ステップ 5: アノテーションリクエストの実行

リクエストオプションを組み立て、annotate メソッドを呼び出します。

const annotateOptions = new models.AnnotateOptions();
annotateOptions.fileInfo = fileInfo;
annotateOptions.annotations = [stickyNote];
annotateOptions.outputPath = outputFilePath;

(async () => {
    try {
        const request = new models.AnnotateRequest(annotateOptions);
        const response = await annotateApi.annotate(request);
        console.log("Sticky note created successfully. Output saved to:", response.path);
    } catch (err) {
        console.error("Failed to create sticky note:", err);
    }
})();

Node.JS で Word ページに付箋を作成する完全な作業例

次の例は、Node.JS で GroupDocs.Annotation Cloud SDK を使用して Word ページに Sticky Notes を作成する完全な実装を示しています。

const { AnnotateApi, Configuration, models } = require("@groupdocs.annotation-cloud");

// -----------------------------------------------------------------------------
// Configuration – replace with your actual GroupDocs credentials
// -----------------------------------------------------------------------------
const config = new Configuration({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET"
});

const annotateApi = new AnnotateApi(config);

// -----------------------------------------------------------------------------
// Define input and output files
// -----------------------------------------------------------------------------
const inputFilePath = "sample.docx";
const outputFilePath = "sample_annotated.docx";

// -----------------------------------------------------------------------------
// Build FileInfo object for the source document
// -----------------------------------------------------------------------------
const fileInfo = new models.FileInfo();
fileInfo.filePath = inputFilePath;

// -----------------------------------------------------------------------------
// Define rectangle (position & size) for the sticky note on page 1
// -----------------------------------------------------------------------------
const rect = new models.Rectangle();
rect.x = 100;      // distance from left edge (points)
rect.y = 100;      // distance from top edge (points)
rect.width = 200;  // width of the sticky note
rect.height = 100; // height of the sticky note

// -----------------------------------------------------------------------------
// Create the sticky‑note annotation
// -----------------------------------------------------------------------------
const stickyNote = new models.AnnotationInfo();
stickyNote.annotationType = "StickyNote";
stickyNote.pageNumber = 1;
stickyNote.rect = rect;
stickyNote.text = "This is a sticky note added via GroupDocs.Annotation Cloud SDK.";
stickyNote.color = "FFFF00"; // Yellow background

// -----------------------------------------------------------------------------
// Assemble the annotate request options
// -----------------------------------------------------------------------------
const annotateOptions = new models.AnnotateOptions();
annotateOptions.fileInfo = fileInfo;
annotateOptions.annotations = [stickyNote];
annotateOptions.outputPath = outputFilePath;

// -----------------------------------------------------------------------------
// Execute the request
// -----------------------------------------------------------------------------
(async () => {
    try {
        const request = new models.AnnotateRequest(annotateOptions);
        const response = await annotateApi.annotate(request);
        console.log("Sticky note created successfully. Output saved to:", response.path);
    } catch (err) {
        console.error("Failed to create sticky note:", err);
    }
})();

注意: このコード例はコア機能を示しています。プロジェクトで使用する前に、ファイルパスや構成値を実際の環境に合わせて更新し、すべての必須依存関係が正しくインストールされていることを確認し、開発環境で徹底的にテストしてください。問題が発生した場合は、公式ドキュメントを参照するか、サポートチームにお問い合わせください。

cURL と REST API を使用した付箋注釈の追加

REST API はコードを書かずに同じ機能を提供します。以下は必要な cURL 呼び出しです。

まず、アクセストークンを取得します:

curl -X POST "https://api.groupdocs.cloud/v2.0.0/auth/token" \
     -H "Content-Type: application/json" \
     -d '{"client_id":"YOUR_CLIENT_ID","client_secret":"YOUR_CLIENT_SECRET"}'

ソースDOCXファイルをアップロードします（YOUR_ACCESS_TOKEN を前の手順のトークンに置き換えてください）:

curl -X PUT "https://api.groupdocs.cloud/v2.0.0/storage/file/sample.docx" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/octet-stream" \
     --data-binary @sample.docx

付箋注釈を作成する:

curl -X POST "https://api.groupdocs.cloud/v2.0.0/annotation/annotate" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "fileInfo": { "filePath": "sample.docx" },
           "annotations": [
               {
                   "annotationType": "StickyNote",
                   "pageNumber": 1,
                   "rect": { "x": 100, "y": 100, "width": 200, "height": 100 },
                   "text": "This is a sticky note added via GroupDocs.Annotation Cloud SDK.",
                   "color": "FFFF00"
               }
           ],
           "outputPath": "sample_annotated.docx"
         }'

注釈付きドキュメントをダウンロード:

curl -X GET "https://api.groupdocs.cloud/v2.0.0/storage/file/sample_annotated.docx?download=true" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -o sample_annotated.docx

リクエストペイロードの詳細については、API リファレンスをご覧ください。

付箋の注釈オプションを設定する

SDK は、付箋の外観と動作を細かく調整できる複数のプロパティを提供します:

annotationType - "StickyNote" に設定する必要があります（必須）。
pageNumber - 注釈が表示されるページ。
rect - 位置（x、y）とサイズ（width、height）を定義します。配置を制御するためにこれらの値を調整します。
text - 注釈の内容。
color - HEX で表した背景色（例: 黄色の場合は "FFFF00"）。

AnnotationInfo モデルを使用して、author、fontFamily、または opacity などのオプションフィールドを設定することもできます。設定可能なプロパティの完全な一覧については、API リファレンスを参照してください。

結論

上記の手順に従うことで、Node.JS で GroupDocs.Annotation Cloud SDK を使用して Word ページに Sticky Notes を作成する方法がわかります。ネイティブな Node.js 実装でも、REST ベースの cURL ワークフローでも、SDK は DOCX ファイルにプログラムから注釈を付けるための一貫した信頼できる方法を提供します。本番環境で使用する際は有効なライセンスを適用することを忘れないでください。臨時ライセンスはライセンスページから取得でき、製品ページで価格オプションを確認できます。注釈付けをお楽しみください！

FAQs

Node.JS で GroupDocs.Annotation Cloud SDK を使用して Word ページに付箋（Sticky Notes）を作成するにはどうすればよいですか？
コード例に示すように AnnotateApi を使用します。SDK はファイルへのアクセス、注釈の作成、出力の生成を自動的に処理します。
SDKで注釈付けがサポートされているファイル形式は何ですか？
SDKはDOCX、PDF、PPTX、XLSX、およびその他多数の一般的な形式で動作します。完全なリストは公式ドキュメントをご覧ください。
REST APIで付箋を使用する際の認証方法は？
クライアント資格情報を使用して /auth/token エンドポイントからアクセストークンを取得し、そのトークンを Authorization: Bearer ヘッダーに含めて以降のすべての呼び出しに使用します。詳細な手順は API reference にあります。
ステッキーノートの色やサイズをカスタマイズできますか？
はい。color プロパティに HEX 値を設定し、rect の寸法（width、height）を調整して、ノートのサイズと配置を制御します。

GroupDocs.Annotation Cloud SDK for Node.JS の設定#

Node.JS で Word ページに付箋を作成する: ステップバイステップのウォークスルー#

ステップ 1: アノテーション API の初期化#

ステップ 2: ソースおよび宛先ファイルの定義#

ステップ 3: スティッキーノートの位置を設定する#

ステップ 4: スティッキーノート アノテーション オブジェクトの作成#

ステップ 5: アノテーション リクエストの実行#

Node.JS で Word ページに付箋を作成する完全な作業例#

cURL と REST API を使用した付箋注釈の追加#

付箋の注釈オプションを設定する#

結論#

FAQs#

もっと読む#