Box Embed - Box Dev Docs

Box EmbedはHTMLベースのフレームワークで、これにより、独自に作成したアプリケーションにBoxウェブアプリの機能全体を埋め込むことができます。Box Embedを使用すると、ファイルのアップロード、検索、コメント付け、共有、タグ付けに加え、Box Editを使用したファイルの編集も可能になります。また、Box HubsのAIチャットを埋め込むことで、焦点を絞ったチャットボットエクスペリエンスも実現できます。

開始する前に

ウィジェットを作成するには、以下のことが必要です。

共有用の埋め込み可能な要素 (フォルダ、ファイル、Hub、メモ、アプリなど) を設定する。
ビューアー以上の権限がある。

ウェブアプリの使用

BoxウェブアプリからBox埋め込みウィジェットのコードを取得するには、以下の手順を実行します。

ファイルとフォルダ

選択したファイルまたはフォルダに移動します。
そのフォルダの横にある省略記号をクリックします。
[その他の操作] > [埋め込みウィジェット] に移動します。

Hub

選択したHubに移動します。
右上にある省略記号メニューをクリックします。
[Hubを埋め込む] をクリックします。

HubからAIチャットインターフェースのみを埋め込むことも可能です。ユーザーは、ナビゲーション機能やファイル閲覧機能を使用せずに、質問して、Hubのファイルに基づいたAIによる回答を取得することができます。詳細については、Box HubsのAIチャットの埋め込みセクションを参照してください。

メモ

選択したメモに移動します。
省略記号メニューをクリックします。
[埋め込みウィジェット] をクリックします。

アプリ

選択したアプリまたはBoxアプリビューに移動します。
省略記号メニューをクリックします。
[埋め込む] をクリックします。

次の手順では、埋め込み可能な要素のパラメータを構成します。

要素の種類	構成オプション
ファイル	ウィジェットのサイズ
フォルダ	ウィジェットのサイズ、フォルダ内のファイルの並べ替え、ナビゲーションパスとサイドバーの非表示。
Hub	ウィジェットのサイズ、親のナビゲーションパスとサイドバーの非表示
HubsのAIチャット	チャットモード: ボタンまたはウィジェット。
メモ	ウィジェットのサイズ、クラウド (雲) ゲームのスキップ (その結果、メモは読み取り専用モードになります)、メモのナビゲーションの非表示。
アプリ	ウィジェットのサイズ

埋め込みウィジェットのカスタマイズが完了したら、埋め込みコードをコピーして自分のサイトまたはウェブアプリに貼り付けます。

プログラムを使用して構成

Box Embedをさらにカスタマイズする場合は、プログラムを使用して実行できます。埋め込みのスニペットの形式は次のとおりです。

<iframe
  src="https://{custom_domain}.app.box.com/embed/s/{shared link value}?view={list or icon}&sortColumn={name, date, or size}&sortDirection=ASC"
  width="{pixels}"
  height="{pixels}"
  frameborder="0"
  <!-- Optionally replace * with your enterprise-specific domain (for example, mycompanydomain.app.box.com) -->
  allow="local-network-access *; clipboard-read *; clipboard-write *" 
  allowfullscreen
  webkitallowfullscreen
  msallowfullscreen>
</iframe>

ブラウザの権限

Google Chrome 142以上およびMicrosoft Edge 143以上では、allow属性を使用して、クリップボードの操作やローカルネットワークへのアクセスを有効にします。この属性は、これらのブラウザバージョン用に設計されていますが、すべてのブラウザに対して安全に含めることができます。他のブラウザでは無視されます。この属性がないと、埋め込まれたBoxコンテンツは、Box Tools、デバイストラスト、またはクリップボードのコピーボタンで機能しない可能性があります。

埋め込みウィジェットのリンク生成ウィンドウでは、生成されたコードに自動的にこのパラメータが含まれます。

共有リンクの値の検索

プログラムを使用して埋め込みiframeを構築するには、まず、共有リンクの値を生成または検索します。この値を検索する1つの方法として、Boxウェブアプリを使用します。

また、PUT /files/:file_idまたはPUT /files/:file_idを使用して、APIで共有リンクを作成する方法もあります。その後、GET /files/:idまたはGET /folders/:idエンドポイントを使用してクエリパラメータfields=shared_linkを渡すことにより、この共有リンクの値を検索できます。

curl https://api.box.com/2.0/folders/12345?fields=shared_link \
    -H "authorization: Bearer ACCESS_TOKEN"

"shared_link": {
  "url": "https://app.box.com/s/dsbJFzdO7qZxdfOHFzdO7qZxdfOH",
  "download_url": null,
  "vanity_url": null,
  ...
}

ページをルートフォルダ/[すべてのファイル] ページに設定することもできます。URLを共有リンク<iframe src=“https://app.box.com/embed/folder/0”….></iframe>ではなく/folder/0に設定してください。

パラメータ

次に、表示のカスタマイズオプションを選択します。構成可能なパラメータ (省略可) のリストを以下に示します。


`hideHubsGallery`	Hubsギャラリーに戻るためのナビゲーションの山括弧ボタンを非表示または表示します。`true`または`false` (デフォルト) を指定できます。
`hideNavigationControls`	Box Notesのナビゲーションコントロールを非表示または表示します。
`showItemFeedActions`	ファイルのコメントまたはタスクを非表示または表示します。`true` (デフォルト) または`false`を指定できます。
`showParentPath`	フレームのヘッダーにフォルダパスを非表示または表示します。`true`または`false` (デフォルト) を指定できます。
`sortColumn`	ファイルまたはフォルダを並べ替える順番。`name`、`date` (デフォルト)、または、`size`を指定できます。
`sortDirection`	ファイルまたはフォルダの並べ替えの方向。`ASC` (デフォルト) または`DESC`を指定できます。
`view`	ファイルまたはフォルダの表示方法の種類。`list` (デフォルト) または`icon`を指定できます。ログインユーザーの場合は、ユーザー設定の表示方法が優先されます。
`uxLite`	クラウド (雲) ゲームを使用せず、制限付きコンテンツプレビュー (Preview Light) を表示します。共有ファイルおよびBox Notesのみに有効です。

Box NotesでuxLiteを使用すると、hideNavigationControlsの設定に関わらず、ナビゲーションコントロールは表示されません。

Boxが提供するアプリのURLにあるカスタム検索パラメータはすべて、埋め込みウィジェットウィンドウとコンテンツプレビューに渡されます。

全画面表示機能

Box Embedスニペットの全画面表示機能を有効にするために、オブジェクトを全画面に表示可能にする場合は、以下のパラメータの1つ以上を<iframe>に含めてください。

allowfullscreen
webkitallowfullscreen
mozallowfullscreen
oallowfullscreen
msallowfullscreen

Box HubsのAIチャットの埋め込み

Box Hubの機能全体を埋め込むことに加えて、AIを活用したチャットインターフェースのみを埋め込むことも可能です。このモードでは、特定のHub内のファイルを利用した焦点を絞ったチャットボックスエクスペリエンスが提供され、ナビゲーションやコンテンツ閲覧のオプションは提供されません。

前提条件

AIチャットモードに埋め込まれたHubにアクセスするには、以下の前提条件があります。

Hubを所有する企業では、Box AI for Hubsが有効になっている必要があります。
ユーザーは、認証済みで、所属する企業でBox AI for Hubsが有効になっている必要があります。
ユーザーには、Hubに対してビューアー以上の権限が必要です。

AIチャットの埋め込みの作成

AIチャットのナレッジベースのソースとして機能するHubに移動します。
右上にある省略記号メニューをクリックします。
[Hubを埋め込む] をクリックします。
[Hub AIチャット] タブを選択します。
チャットモードを選択します。
- チャットボタン
- チャットウィジェット
埋め込みコードをコピーします。

Box HubsのAIチャットの埋め込みで問題が発生した場合は、上記の手順1～6を繰り返すことで、埋め込みコードを再生成し、スクリプトの最新バージョンを取得してください。

チャットボタン

チャットボタンモードでは、ユーザーがボタンをクリックするとAIチャットウィジェットが開きます。これは、Boxでホストされるscriptとして生成され、ページ上にフローティングチャットボタンを表示します。

チャットボタンのパラメータ

チャットボタンモードでは、以下のパラメータがサポートされています。

パラメータ	必須	説明
`data-hub-id`	はい	チャットボットに使用されるHubのID。
`data-custom-box-domain`	いいえ	カスタムドメインを使用しているBoxインスタンス。デフォルト: `app.box.com`。例: `mycompanydomain.app.box.com`。
`data-button-text`	いいえ	チャットボタンに表示するカスタムテキスト。デフォルト: `Box AI`。この値は、アクセシビリティのために、このボタンのエリアラベルにも使用されます。
`data-shared-link`	いいえ	Hubにアクセスするための省略可能な共有リンク。指定されていない場合、チャットは、Hubのコラボレータであるユーザーのみに読み込まれます。

次の例は、利用可能なすべてのパラメータを使用したチャットボタンの構成全体を示します。

<script 
  src="https://cdn01.boxcdn.net/embeddable-ai-chat-script/2.8.0/box_integrations_ai_chat_button.js" 
  data-hub-id="123456789" 
  data-custom-box-domain="mycompanydomain.app.box.com" 
  data-shared-link="abcdefghijklmnopqrst123" 
  data-button-text="Ask our HR chatbot">
</script>

チャットウィジェット

チャットウィジェットモードでは、ページ読み込み時に、AIチャットウィジェットが直接埋め込まれます。これは、iframeとして生成され、チャットインターフェース全体をすぐに表示します。

チャットウィジェットのパラメータ

チャットウィジェットモードでは、iframeを使用すると、AIチャットウィジェットが直接ページに埋め込まれます。iframeのsrc属性にURLパラメータを追加して、動作をカスタマイズできます。

パラメータ	説明
`hubId`	チャットボットに使用されるHubのID。
`sharedLink`	Hubにアクセスするための共有リンクのハッシュ。指定されていない場合、チャットは、Hubのコラボレータであるユーザーのみに読み込まれます。
`showCloseButton`	チャットインターフェースにX (閉じる) ボタンを表示するかどうか。`true`に設定すると、閉じるボタンが表示されます。ユーザーがこのボタンをクリックすると、Boxでは、親ウェブアプリケーションに送信されるイベントが生成されます。これにより、ユーザーの操作に基づいてカスタムの閉じるロジックを実装することが可能になります。

次の例は、利用可能なすべてのパラメータを使用したチャットウィジェットの構成全体を示します。

<iframe 
  src="https://yourcompanydomain.app.box.com/ai-chat?hubId=123456789&sharedLink=abcdefghijklmnop123&showCloseButton=false" 
  width="800" 
  height="550" 
  frameBorder="0" 
  <!-- Optionally replace * with your enterprise-specific domain (for example, mycompanydomain.app.box.com) -->  
  allow="local-network-access *; clipboard-read *; clipboard-write *"  
  allowfullscreen 
  webkitallowfullscreen 
  msallowfullscreen>
</iframe>

閉じるボタンの使用

(提供されたスクリプトを使用せず) iframeを使用して直接Box AIチャットを埋め込む場合は、チャットインターフェース内で閉じるボタンを有効化できます。このボタンは、postMessageを通じて親アプリケーションと通信します。

閉じるボタンの有効化

iframeの隅に閉じるボタン (✕) を表示するには、次のように、iframe URLにshowCloseButton=trueクエリパラメータを追加します: https://app.box.com/ai-chat?hubId=YOUR_HUB_ID&showCloseButton=true

仕組み

showCloseButton=trueを設定すると、Xボタンがチャットのiframeの隅に表示されます。
ユーザーがこのボタンをクリックすると、iframeから親ウィンドウにpostMessageイベントが送信されます。
このイベントには、"BOX_AI_CHAT_CLOSE"に設定されたevent.data.typeが含まれています。
ホストしているアプリケーションは、このイベントをリッスンし、閉じるロジックを処理します。

実装例

window.addEventListener('message', (event) => {
    // Optional: validate origin is from Box for additional security
    // if (event.origin !== 'https://app.box.com') return;

    if (event.data && event.data.type === 'BOX_AI_CHAT_CLOSE') {
        closeChat();
    }
});

イベントのリファレンス

プロパティ	値	説明
`event.data.type`	`"BOX_AI_CHAT_CLOSE"`	ユーザーがチャットのiframeで閉じるボタンをクリックしたことを示します。

有効期限付き埋め込みリンク

ファイルの場合、GET /files/:idを呼び出し、fieldsクエリパラメータを使用してexpiring_embed_linkをリクエストすることもできます。

curl https://api.box.com/2.0/files/12345?fields=expiring_embed_link \
    -H "authorization: Bearer ACCESS_TOKEN"

{
  "etag": "1",
  "expiring_embed_link": {
    "token": {
      "access_token": "1!rFppcinUwwwDmB4G60nah7z...",
      "expires_in": 3646,
      "restricted_to": [
        {
          "object": {
            "etag": "1",
            "file_version": {
              "id": "34567",
              "sha1": "1b8cda4e52cb7b58b354d8da0068908ecfa4bd00",
              "type": "file_version"
            },
            "id": "12345",
            "name": "Image.png",
            "sequence_id": "1",
            "sha1": "1b8cda4e52cb7b58b354d8da0068908ecfa4bd00",
            "type": "file"
          },
          "scope": "base_preview"
        },
        ...
      ],
      "token_type": "bearer"
    },
    "url": "https://cloud.app.box.com/preview/expiring_embed/...."
  },
  "id": "12345",
  "type": "file"
}

url属性を<iframe>内で使用すると、自動で期限切れになるBox Embedインターフェースを埋め込むことができます。

<iframe
  src="YOUR-GENERATED-BOX-EMBED-LINK"
  width="{pixels}"
  height="{pixels}"
  frameborder="0"
  allowfullscreen
  webkitallowfullscreen
  msallowfullscreen
/>

パラメータ

UIをカスタマイズするために、このURLにさらにパラメータを追加することもできます。そのためには、以下のパラメータをクエリパラメータとしてurlに追加します。最終的なURLは、次のようになります。

https://app.box.com/preview/expiring_embed/[HASH]?[parameterName]=true


`showDownload`	ファイルをダウンロードするための権限がビューアーにある場合は、埋め込まれたヘッダーバーにダウンロードボタンが表示されます。また、印刷とダウンロードが同じ権限で管理されているため、ドキュメントのファイルタイプには印刷ボタンも表示されます。デフォルトでは`false`になります。
`showAnnotations`	プレビュー以上の権限を持つユーザーは、ドキュメントと画像のプレビューに注釈を付けることができます。また、すでにドキュメントに付けられている注釈も表示されます。注釈が利用可能なファイルタイプおよび注釈の種類の詳細については、注釈ページを参照してください。現在、注釈はウェブブラウザでのみ使用できます。モバイルブラウザでは、ユーザーは注釈を表示できますが、新しい注釈を作成することはできません。

クラウド (雲) ゲーム

クラウド (雲) ゲームとは、クリックジャッキングを防ぐために作成されたウィジェットです。これは、パートナー統合ではない埋め込みサイトに表示されます。クラウド (雲) ゲームでは、ユーザーは、操作の許可を得るためにクラウド (雲) を適切な場所にドラッグする必要があります。このゲームでは、クラウド (雲) の位置とそのドラッグ先がランダムに生成されるため、クリックジャッキングが難しくなります。

postMessage()は、埋め込みとshowCloudGame両方のステータスを取得するためにiframeで使用されます。埋め込まれている場合、document.hasStorageAccess()は、BoxからCookieにアクセスできるかどうかを示します。アクセスでき、ユーザーがログイン済みの場合、クラウド (雲) ゲームが表示されます。showCloudGameのステータスがfalseの場合、ユーザーはログインページに誘導されます。

カスタムロゴ

有料のBoxをお使いの場合は、ファイルのプレビューに表示されるBoxのロゴを削除できます。削除するには、管理コンソールの [Enterprise設定]、[カスタム設定] に移動し、[埋め込みウィジェットのカスタマイズ] をオフに切り替えてBoxのロゴを非表示にします。

制限

Box Embedは、モバイルブラウザ向けには最適化されていないため、モバイルデバイス用に設計されたウェブエクスペリエンスでは使用しないでください。多くのUI Element (ダウンロードオプションや印刷オプションなど) はモバイルブラウザに表示されない可能性があります。

​開始する前に

​ウェブアプリの使用

​ファイルとフォルダ

​Hub

​メモ

​アプリ

​プログラムを使用して構成

​ブラウザの権限

​共有リンクの値の検索

​パラメータ

​全画面表示機能

​Box HubsのAIチャットの埋め込み

​前提条件

​AIチャットの埋め込みの作成

​チャットボタン

​チャットボタンのパラメータ

​チャットウィジェット

​チャットウィジェットのパラメータ

​閉じるボタンの使用

閉じるボタンの有効化

仕組み

実装例

イベントのリファレンス

​有効期限付き埋め込みリンク

​パラメータ

​クラウド (雲) ゲーム

​カスタムロゴ

​制限

開始する前に

ウェブアプリの使用

ファイルとフォルダ

Hub

メモ

アプリ

プログラムを使用して構成

ブラウザの権限

共有リンクの値の検索

パラメータ

全画面表示機能

Box HubsのAIチャットの埋め込み

前提条件

AIチャットの埋め込みの作成

チャットボタン

チャットボタンのパラメータ

チャットウィジェット

チャットウィジェットのパラメータ

閉じるボタンの使用

有効期限付き埋め込みリンク

パラメータ

クラウド (雲) ゲーム

カスタムロゴ

制限