すべてのプロダクト
Search
ドキュメントセンター

Intelligent Media Management:GenerateWebofficeToken

最終更新日:Jun 15, 2026

ドキュメントのプレビューおよび編集の認証情報を取得します。

操作説明

  • この操作を使用する前に、Intelligent Media Management の課金について理解してください。詳細については、料金を参照してください

  • OSS ファイルに対してクロスボーダーアクセスを行わないでください。たとえば、ファイルがシンガポールリージョンのバケットに保存されている場合、中国本土からプレビュー、読み取り、またはダウンロードリクエストを開始しないでください。このようなシナリオでは、クロスボーダーネットワーク環境によりネットワークリンクの品質が大幅に影響を受け、アクセスレイテンシの増加、プレビューの失敗、ダウンロードの中断、または不安定な接続が発生する可能性があります。ネットワークの安定性とアクセスエクスペリエンスは保証できません。クロスボーダーアクセスによる不確実性を回避するために、アクセスポイントとバケットが同じリージョンにあることを確認してください。

  • アクセス認証情報は 30 分で期限切れになり、リフレッシュ認証情報は 1 日で期限切れになります。

  • 返される有効期限は協定世界時 (UTC) であり、UTC+8 より 8 時間遅れています。

  • サポートされる入力ファイルのフォーマット:

    • Word ドキュメント: doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf。

    • プレゼンテーションドキュメント (PPT): ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps。

    • Excel ドキュメント: et、xls、xlt、xlsx、xlsm、xltx、xltm、csv。

    • PDF ドキュメント: pdf。

  • サポートされるファイルサイズの最大値は 200 MB です。

  • サポートされるドキュメントの最大ページ数は 5,000 です。

  • 2023 年 12 月 1 日より前に作成されたプロジェクトでは、ドキュメントのオープン回数に基づいて課金されます。現在は、API 呼び出し回数に基づいて課金されます。新しい課金モードに切り替えるには、新しいプロジェクトを作成してください。各 API 呼び出しは 1 人のユーザーのみが使用できます。呼び出しが再利用された場合、最後のユーザーのみがドキュメントに正常にアクセスでき、他のユーザーのアクセス権限は取り消されます。

  • Intelligent Media Management と同じリージョンでメッセージサービス (MNS) を有効化し、MNS トピックとキューを作成してサブスクリプションを構成します。NotifyTopicName パラメーターを使用して MNS トピック名を渡すことで、ファイル保存に関するメッセージ通知を受信できます。MNS SDK の詳細については、メッセージの受信と削除を参照してください。 ファイル保存メッセージ通知の Message フィールドの JSON フォーマットの例については、WebOffice メッセージ通知フォーマットを参照してください。

説明

バージョン管理機能を使用するには、まず OSS でバージョン管理を有効にしてから、History パラメーターを true に設定する必要があります。 .

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

imm:GenerateWebofficeToken

none

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ProjectName

string

必須

プロジェクト名。プロジェクト名の取得方法については、プロジェクトの作成を参照してください。

test-project

SourceURI

string

必須

プレビューまたは編集するドキュメントの OSS URI。

OSS URI は oss://${Bucket}/${Object} のフォーマットに従います。Bucket は現在のプロジェクトと同じリージョンにある OSS バケットの名前で、Object はファイル名拡張子を含むファイルの完全なパスです。

oss://test-bucket/test-object.docx

Filename

string

任意

ファイル名。ファイル名拡張子を含む必要があります。デフォルト値は SourceURI パラメーターの最後のセグメントです。

サポートされるファイル名拡張子 (PDF はプレビューのみサポート):

  • Word ドキュメント: doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf

  • PowerPoint ドキュメント: ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps

  • Excel ドキュメント: et、xls、xlt、xlsx、xlsm、xltx、xltm、csv

  • PDF ドキュメント: pdf。

test-Object.pptx

CachePreview

boolean

任意

キャッシュプレビューを有効にするかどうかを指定します。

  • true: 有効にすると、ドキュメントプレビューで共同編集コンテンツが更新されなくなります。プレビューのみのシナリオに適しています。

  • false: 無効にすると、デフォルトで共同プレビューが使用され、プレビュー中に共同編集コンテンツが同期されます。

重要 キャッシュプレビューと非キャッシュプレビューでは単価が異なります。詳細については、課金項目の説明を参照してください。
重要 キャッシュプレビューではドキュメントコンテンツの検索や印刷はサポートされていません。
重要 キャッシュプレビューではキャッシュコンテンツの更新はサポートされていません。
.

true、false

Referer

string

任意

OSS ホットリンク保護 Referer。Intelligent Media Management (IMM) は OSS からソースファイルを取得する必要があります。OSS にホットリンク保護が構成されている場合、IMM はソースファイルを取得するために対応するヘッダーを OSS に渡す必要があります。

説明

ドキュメントを保存しているバケットに Referer が構成されている場合、このパラメーターを設定してください。

*

UserData

string

任意

カスタムユーザーデータ。このパラメーターは、Notification パラメーターに MNS 構成が指定されている場合にのみ有効です。データは非同期メッセージ通知で返され、システム内でメッセージ通知を関連付けて処理できます。最大長: 2,048 バイト。

{ "id": "test-id", "name": "test-name" }

PreviewPages

integer

任意

プレビューできる最大ページ数。デフォルトでは制限はありません。最大値は 5,000 です。

5

Password

string

任意

ドキュメントを開くためのパスワード。

説明

パスワードで保護されたドキュメントをプレビューまたは編集する場合、このパラメーターを設定してください。

123456

ExternalUploaded

boolean

任意

同名ファイルの OSS へのアップロードが想定される動作かどうかを指定します。有効な値:

  • true: 同名ファイルの OSS へのアップロードは想定される動作です。アップロードされたドキュメントは元のドキュメントを上書きし、新しいバージョンを生成します。このパラメーターを true に設定した後、まず編集中のドキュメントを閉じ、約 5 分待ってから再度開いて新しいドキュメントをロードする必要があります。アップロードはドキュメントが閉じられたときにのみ有効です。ドキュメントが開いている場合、新しい保存がアップロードされたファイルを上書きします。

  • false (デフォルト): 同名ファイルの OSS へのアップロードは想定される動作ではありません。操作はエラーを返します。

false

NotifyTopicName

string

任意

MNS メッセージとしてイベント通知を送信します。このパラメーターは、非同期メッセージ通知の MNS トピックを指定します。

test-topic

Hidecmb

boolean

任意

ツールバーを非表示にするかどうかを指定します。このパラメーターはドキュメントプレビューモードでサポートされます。有効な値:

  • false (デフォルト): ツールバーは非表示になりません。

  • true: ツールバーは非表示になります。

false

Permission WebofficePermission

任意

JSON フォーマットのユーザー権限情報。

ユーザー権限には以下のオプションが含まれます:

各オプションはブール値タイプです。デフォルト値は false です。有効な値: true および false。

  • Readonly (オプション): プレビューモード。

  • Rename (オプション): ファイルの名前変更権限。メッセージ通知のみ提供されます。名前変更イベントは MNS に送信されます。

  • History (オプション): 履歴バージョンの表示権限。

  • Copy (オプション): コピー権限。

  • Export (オプション): PDF へのエクスポート権限。

  • Print (オプション): 印刷権限。

説明

PDF はプレビュー機能のみサポートしています。Readonly パラメーターを true に設定する必要があります。

説明

PDF ファイルはエクスポートをサポートしていません。

説明

バージョン管理機能を使用するには、まず OSS でバージョン管理を有効にしてから、History パラメーターを true に設定する必要があります。

重要 キャッシュプレビューでは印刷はサポートされていません。
重要 履歴バージョンは編集モードで表示できますが、プレビューモードでは表示できません。
.

User WebofficeUser

任意

ユーザー情報。ビジネス側からユーザー情報を渡すことができ、WebOffice ページにこの情報が表示されます。

システムは User.Id によって異なるユーザーを区別します。User.Name はフロントエンド表示にのみ使用されます。User.Id が指定されていない場合、バックエンドがランダムな ID を自動生成します。異なる ID を持つユーザーは異なるプリンシパルとして扱われ、互いのコメントを変更または削除できません。

デフォルトのフォーマットは Unknown_RandomString です。User.Id が指定されていない場合、ユーザー情報はデフォルトで「Unknown」と表示されます。

各 API 呼び出しは 1 人のユーザーのみが使用できます。

Watermark WebofficeWatermark

任意

ウォーターマーク情報。ウォーターマークはフロントエンドで生成され、ソースドキュメントには書き込まれません。同じドキュメントに対して異なるパラメーターを渡すと、異なるウォーターマークが生成されます。

CredentialConfig CredentialConfig

任意

特定の要件がない限り、このパラメーターは空のままにしてください。

China 権限付与構成。このパラメーターはオプションです。詳細については、チェーン権限付与を使用して他のエンティティのリソースにアクセスするを参照してください。

Notification Notification

任意

通知構成。現在、MNS のみサポートされています。非同期通知メッセージのフォーマットについては、WebOffice メッセージ通知フォーマットを参照してください。

説明

メッセージ通知は、ファイルが保存または名前変更されたときに送信されます。

典型的なシナリオの例

以下の例では、パラメーター構造に基づいていくつかの典型的なシナリオを説明します:

読み取り専用ファイルのプレビュー (PDF ファイルのプレビューに必須)

ドキュメントプレビューモード。ドキュメントはプレビューのみ可能で、編集はできません:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.pdf",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

大文字のファイル名拡張子を持つファイルのプレビュー

大文字のファイル名拡張子を持つファイルをプレビューするには、Filename パラメーターに小文字の拡張子を設定します:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.DOCX",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

ドキュメントの最初の 5 ページのみをプレビュー

ドキュメントは合計 10 ページあります。最初の 5 ページのみが表示されます:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

ドキュメントプレビューにパスワードを設定

ドキュメントプレビューにパスワードを設定するか、パスワードで保護されたソースファイルをパスワードなしで直接開きます:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Password" : "123456",
    "Permission" : "{'Readonly':'true'}"
}
ドキュメントプレビューにウォーターマークを追加

ドキュメントをプレビューするときにウォーターマークを追加します:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Watermark" : "{'Type':'1','Value':'Watermark value','Font':'bold 20px Serif'}",
    "Permission" : "{'Readonly':'true'}"
}
ドキュメントプレビュー中にツールバーを非表示

ドキュメントをプレビューするときにツールバーを非表示にします:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Hidecmb" : "true",
    "Permission" : "{'Readonly':'true'}"
}
履歴バージョンの表示、コピー、印刷、PDF へのエクスポートの権限を持つドキュメントのオンライン編集

履歴バージョンの表示、コピー、印刷、PDF へのエクスポートの権限を持つドキュメントをオンラインで編集します:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Permission" : "{'Readonly':'false','History':'true','Copy':'true','Print':'true','Export':'true'}"
}
```.

レスポンスフィールド

フィールド

説明

object

Weboffice アクセス認証情報。

RequestId

string

リクエスト ID。

1759315A-CB33-0A75-A72B-62D7********

WebofficeURL

string

ドキュメントをオンラインでプレビューまたは編集するための Weboffice エントリ URL。

説明

この URL はブラウザで直接開くことはできません。Weboffice JS-SDK とアクセス認証情報 (AccessToken) を組み合わせて使用し、ドキュメントをプレビューまたは編集する必要があります。詳細については、クイックスタートを参照してください。

https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1

AccessToken

string

Weboffice アクセス認証情報。

2d73dd5d87524c5e8a194c3eb5********

RefreshToken

string

Weboffice リフレッシュ認証情報。

e374995ec532432bb678074d36********

AccessTokenExpiredTime

string

アクセス認証情報の有効期限の時間。認証情報は 30 分で期限切れになります。フォーマット: YYYY-MM-DDTHH:mm:ss。

2021-08-30T13:13:11.347146982Z

RefreshTokenExpiredTime

string

リフレッシュ認証情報の有効期限の時間。認証情報は 1 日で期限切れになります。フォーマット: YYYY-MM-DDTHH:mm:ss。

2021-08-31T12:43:11.347146982Z

一般的なエラー

ProjectName で指定されたプロジェクトが見つかりません。IMM コンソールに移動し、そのリージョンにプロジェクトが存在するかどうかを確認してください。

{
    "Code": "ResourceNotFound",
    "Message": "The specified resource acs:imm::xxx:project/xxx is not found"
}
```.

User パラメーターは必須です。このパラメーターが指定されているかどうかを確認してください。

{ "Code": "InvalidArgument.User", "Message": "The parameter User is required but not provided" }

User パラメーターが無効です。パラメーター値が有効な JSON フォーマットかどうかを確認してください。

{ "Code": "InvalidJSON parsing error, User", "Message": "Specified parameter JSON parsing error, User is not valid." }

Permission パラメーターが無効です。パラメーター値が有効な JSON フォーマットかどうかを確認してください。

{ "Code": "InvalidJSON parsing error, Permission", "Message": "Specified parameter JSON parsing error, Permission is not valid." }

Watermark パラメーターが無効です。パラメーター値が有効な JSON フォーマットかどうかを確認してください。

{ "Code": "InvalidJSON parsing error, Watermark", "Message": "Specified parameter JSON parsing error, Watermark is not valid." }

PreviewPages パラメーターのフォーマットが無効です。PreviewPages パラメーターの値を確認してください。

{ "Code": "InvalidPreviewPages", "Message": "Specified parameter PreviewPages is not valid." }

SourceURI で指定された OSS ファイルが存在しません。バケットにファイルが存在するかどうかを確認してください。

{ "Code": "ResourceNotFound", "Message": "The specified resource oss://xx is not found" }

成功レスポンス

JSONJSON

{
  "RequestId": "1759315A-CB33-0A75-A72B-62D7********",
  "WebofficeURL": "https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1",
  "AccessToken": "2d73dd5d87524c5e8a194c3eb5********",
  "RefreshToken": "e374995ec532432bb678074d36********",
  "AccessTokenExpiredTime": "2021-08-30T13:13:11.347146982Z",
  "RefreshTokenExpiredTime": "2021-08-31T12:43:11.347146982Z"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。