:GenerateWebofficeToken

• この API を使用する前に、Intelligent Media Management (IMM) の課金方法と料金を十分に理解していることを確認してください。

• アクセス認証情報の有効期間は 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 呼び出しの回数に基づきます。新しい課金モデルに切り替えるには、新しいプロジェクトを作成する必要があります。1 回の API 呼び出しは 1 人のユーザーしか使用できません。同じ API 呼び出しが複数のユーザーによって使用された場合、最後のユーザーのみがドキュメントにアクセスでき、他のユーザーのアクセス権限は取り消されます。

• IMM と同じリージョンで Message Service (MNS) をアクティブ化します。トピックとキューを作成し、サブスクリプション関係を設定します。その後、`NotifyTopicName` パラメーターに MNS トピック名を渡して、ファイルが保存されたときに通知を受け取ることができます。MNS SDK の詳細については、「メッセージの受信と削除」をご参照ください。 ファイル保存通知の `Message` フィールドの JSON 形式の例については、「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'}"
}

一般的なエラー

`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` パラメーターの形式が無効です。このパラメーターの値を確認してください。

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

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

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