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

Drive and Photo Service:PageWidget

最終更新日:Aug 21, 2026

このトピックでは、PageWidget の使用方法について説明します。PageWidget は、開発者が iframe を使用して PDS BasicUI のページを独自の Web アプリケーションに迅速に埋め込むためのメソッドを提供します。

1. コンストラクター

iframe のカスタムマウントポイントとスタイル

デフォルトでは、iframe は body 要素にマウントされます。必要に応じて、iframe のカスタム マウントポイント を指定できます。例:

<div id="container"></div>
import { PageWidget } from 'aliyun-pds-js-widget';

const domain_id = 'bj1'; // ご自身の domain_id
const token_info = {
  access_token: 'xxxxx',
  refresh_token: 'xxxxx',
  // ...
};

const widgetOpts = {
  widget_endpoint: `https://${domain_id}.apps.aliyunpds.com`,
  // マウントポイント。
  container: document.querySelector('#container'),
  // カスタムスタイル。
  iframe_style: {
    width: '100%',
    height: '100%',
  },
  // 埋め込むページ。
  module: 'drive/user',
  token_info,
  // 現在のトークンの有効期限が切れたときにトークンを取得する関数を設定します。
  refresh_token_fun: async () => {
    // サーバーサイドの refreshToken API を呼び出すビジネスロジック。
    // サーバーから new_token_info を取得します。
    // let new_token_info = await fetch(.....)
    return new_token_info;
  },
};

const ins = new PageWidget(widgetOpts);

PageWidget コンストラクターのパラメーター

パラメーター

タイプ

必須

説明

module

string

はい

コンポーネント名。詳細については、「4. module パラメーター」をご参照ください。

widget_endpoint

string

はい

コンポーネント UI のエントリ URL。通常、これはご使用のドメインの apps サブドメインです。

container

string or HTMLElement

はい

コンポーネントがマウントされる要素。

lang

string

言語。有効値: zh_CN、en_US。このパラメーターが指定されていない場合、デフォルトでブラウザの navigator.language 設定が使用されます。

token_info

Object

はい

アクセストークン。JSON オブジェクトとして渡されます。トークンの取得方法については、「JWT ベースのアプリケーション統合」をご参照ください。

share_token

string

共有トークン。このトークンは、共有リソースに対する操作を実行する際に役立ちます。

refresh_token_fun

Function

はい

有効期限が切れたときに アクセストークン を更新する関数。この関数は、新しい token_info オブジェクトを返す必要があります。

refresh_share_token_fun

Function

有効期限が切れたときに 共有トークン を更新する関数。この関数は、新しい share_token を返す必要があります。

iframe_style

Object

iframe のカスタムスタイル。

iframe_attr

Object

iframe のカスタム属性。

menus

{name:string,

hide:boolean}[]

ファイル操作のメニュー項目のリスト。特定のメニューボタンを非表示にできます。例: [{name: "sharelink", hide: true}]。name パラメーターはメニュー項目名を指定します。詳細については「5. menus パラメーター」をご参照ください。

show_avatar

boolean

右上隅にユーザーアバターを表示するかどうかを指定します。デフォルト値: false。(v1.5.1 以降でサポート)

show_sidebar

boolean

サイドバーを表示するかどうかを指定します。デフォルト値: false。(v1.5.1 以降でサポート)

2. インスタンスメソッド

呼び出し例:

const ins = new PageWidget(widgetOpts)

// メソッドを呼び出します。
ins.setLang('zh-CN')

PageWidget は、次のメソッドをサポートしています:

メソッド

説明

パラメーター

setToken

コンポーネントの ログイン状態 を設定します。

トークン情報を含む JSON オブジェクト。

removeToken

ログイン状態 をクリアします。

なし

setLang

コンポーネントの言語を設定します。

言語コード。ハイフン (-) をアンダースコア (_) に置き換えます。例: zh-CN の代わりに zh_CN を使用します。

setShareToken

share_token を設定します。

string

on

イベントをリッスンします。

下記の詳細をご参照ください。

destroy

コンポーネントを破棄します。

なし

changeModule

表示されるページモジュールを切り替えます。

コンポーネント名を指定する文字列 (例:"drive/user")。詳細については、「4. module パラメーター」をご参照ください。

setMenus

メニュー項目の表示/非表示を設定します。

ファイル操作のメニュー項目のリスト。特定のメニューボタンを非表示にできます。例: [{name: "sharelink", hide: true}]。name パラメーターはメニュー項目名を指定します。詳細については、「5. menus パラメーター」をご参照ください。

3. イベントリッスン

コンポーネントイベントをリッスンし、イベントがトリガーされたときにコールバック関数を実行できます。

例:

const ins = new PageWidget(widgetOpts);

ins.on('event_name', function(data) {
  // 何らかの処理を実行...
})

サポートされるイベント

イベント

説明

ペイロード

load

コンポーネントが初めてレンダリングされるときに発生します。

なし

error

コンポーネントでエラーが発生したときに発生します。

{code: "TokenExpired", message: "xxx"} のようなエラー詳細を含むオブジェクト。

tokenChanged

アクセストークン が変更されたときに発生します。

トークン 情報を含むオブジェクト、または null。

shareTokenChanged

share_token が変更されたときに発生します。

share_token の文字列、または null。

langChanged

コンポーネントの言語が変更されたときに発生します。

言語名を指定する文字列 (例: zh_CN)。

routerChanged

コンポーネントのルートが変更されたときに発生します。

フォワードスラッシュ (/) で始まる URL パス を指定する文字列 (例:/disk/widget/drive/user)。

fileChanged

ファイル操作が発生したときに発生します。

{"type": "copy", "fileList": []}。ここで、type はファイル操作のタイプを示し、fileList はファイル情報を含むオブジェクトのリストです。具体的な値については、以下の補足コンテンツをご参照ください。

preview

ファイルのプレビューが開始または停止したときに発生します。

ファイル情報を含むオブジェクト。プレビューが停止すると、値は null になります。

popup

ポップアップウィンドウの表示/非表示が変更されたときに発生します。

{"visible": false}。ここで、visible はダイアログボックスが表示 (true) か非表示 (false) かを指定するブール値です。

error イベントコード

  • TokenInvalid:トークンが無効か、設定されていません。

  • TokenExpired:トークンの有効期限が切れています。

その他のエラーコードについては、「エラー処理」をご参照ください。

fileChanged コールバックパラメーター

ins.on('fileChanged', ({type, fileList})=>{
  // コールバックを処理します。
})

パラメーター

必須

タイプ

説明

type

はい

string

  • star:お気に入りへの追加または削除。

  • copy:コピー。

  • move:移動。

  • delete:ごみ箱 へ移動。

  • remove:完全に削除。

  • restore:ごみ箱 から復元。

  • remark:備考の変更。

  • rename:名前の変更。

  • create:作成。

  • upload:アップロード。

fileList

はい

Object

ファイル項目のフィールドの詳細については、「ファイル」をご参照ください。

必須プロパティ:

  • drive_id:ドライブ ID。タイプ:string。

  • file_id:ファイル ID。

  • parent_file_id:親ファイル ID。

  • type:タイプ。有効値: file、folder。

任意プロパティ:

  • name:ファイル名。

  • created_at:ファイルが作成された時刻 (ISO 8601 形式)。

  • size:バイト単位のファイルサイズ。このプロパティは、type が file の場合にのみ有効です。

  • starred:ファイルがお気に入りに追加されているかどうかを指定します。タイプ:boolean。

  • updated_at:ファイルが最後に更新された時刻 (ISO 8601 形式)。

4. module パラメーター

module コンストラクターパラメーターで初期モジュールを設定するか、changeModule メソッドで実行時にモジュールを切り替えることができます。

PageWidget がサポートするコンポーネント名

ユーザーインターフェース

  • drive/group:チームスペース

  • drive/enterprise:エンタープライズスペース

  • drive/user:パーソナルスペース

  • mycategory/image:マイ画像 (検索結果ページ)

  • mycategory/video:マイビデオ (検索結果ページ)

  • mycategory/audio:マイオーディオ (検索結果ページ)

  • mycategory/doc:マイドキュメント (検索結果ページ)

  • ishare:自分の共有

  • share:共有アイテム

  • star:お気に入り

  • handover:引き継いだドライブ

  • mysharelinks:自分の共有リンク

  • trash:ごみ箱

管理コンソール

  • groups:チーム管理

  • udrives:ユーザードライブ

  • tdrives:チームドライブ

  • shareConfig:共有権限設定

  • shareLinkManagement:共有リンク管理

  • logAudit:ログ監査

  • standardCustom:標準カスタマイズ

  • seniorCustom:高度なカスタマイズ

  • fileAccess:ファイルアクセス

  • fileSettings:ファイル設定

例:

const widgetOpts = {
  module: 'drive/user',
  // ...
}
const ins = new PageWidget(widgetOpts);

ins.changeModule('drive/group')

5. menus パラメーター

menus コンストラクターパラメーターまたは setMenus メソッドを使用して、ページ上のファイル操作ボタンを表示または非表示にできます。値 true はボタンを非表示にし、false は表示します。

  • download:ダウンロード

  • share:共有

  • sharelink:共有リンク

  • move:移動

  • copy:コピー

  • star:お気に入りへの追加/削除

  • rename:名前の変更

  • remark:備考

  • detail:詳細

  • share_owner:コラボレーターの管理

  • delete:削除

例:

const widgetOpts = {
  menus: [
    { name: 'download', hide: false },
    { name: 'copy', hide: false },
    { name: 'move', hide: false },
    { name: 'rename', hide: false },
    { name: 'delete', hide: false },
    { name: 'remark', hide: false },
    // ...
  ],
  // ...
}

const ins = new PageWidget(widgetOpts);

ins.setMenus([
    { name: 'download', hide: false },
    { name: 'copy', hide: false },
    { name: 'move', hide: false },
    { name: 'rename', hide: false },
    { name: 'delete', hide: false },
    { name: 'remark', hide: false },
  // ...
])