Applinkリソース
Applinksリソース(applinks
)を使用して、指定されたユーザーおよびロールのフォルダまたはファイルへのアクセスをリクエストします。
Applinkを作成するには、リクエスタにそのフォルダまたはファイルに対する管理権限が必要です。 つまり、リクエスタは所有者であるか、管理者ロールが必要ということです。
管理者または所有者のロールを除けば、任意の標準ロールを指定したユーザーに付与できます。
-
ビューア: ビューアはファイルおよびフォルダを表示できますが、何かを変更することはできません。
-
ダウンローダ: ダウンローダはファイルをダウンロードし、自分のコンピュータに保存することもできます。
-
コントリビュータ: コントリビュータはファイルの変更、ファイルの更新、新規ファイルのアップロードおよびファイルの削除を行うこともできます。
アプリケーション・リンク定義の例は、Applinksの「ファイル・アプリケーション・リンクの作成」の説明の「例」を参照してください。
Applink暗号化
必要なリソース・オブジェクト、ユーザーおよびロール情報はすべて暗号化され、次の表に示す要素内に格納されます。 これらの要素は、Applinkレスポンスとともに返され、関連ユーザーの代わりに他の操作を一定期間にわたってプログラム的に実行するために使用されます。
applinkを使用したサービス・コールでは、関連付けられたappLinkID
およびaccessToken
値をリクエスト・ヘッダーに含める必要があります。
パラメータ | 説明 |
---|---|
appLinkID |
この要素は、リソースを一意に識別します。 |
accessToken |
この要素は、リソースへのアクセス権を提供し、15分後に失効します。 アクセス・トークンは、リフレッシュ・トークンによって定義されている時間(24時間)内に任意の回数リフレッシュできます。 |
refreshToken |
この要素では、現在のアクセス・トークンが失効したときに、新しいアクセス・トークンをリクエストできます。 リフレッシュ・トークンは24時間後に失効します。 |
userLocale Applinkパラメータのロケール
次の表に、userLocale
applinkパラメータに対してロケール・コードとそれらが表すロケールを示します。
ロケール・コード | ロケール |
---|---|
cs |
チェコ語 |
da |
デンマーク語 |
de |
ドイツ語 |
el |
ギリシャ語 |
en-CA |
英語(カナダ) |
en-GB |
英語(英国) |
en-US |
英語(米国) |
es |
スペイン語 |
fi |
フィンランド語 |
fr |
フランス語 |
fr-CA |
フランス語(カナダ) |
hu |
ハンガリー語 |
it |
イタリア語 |
ja |
日本語 |
ko |
韓国語 |
nl |
オランダ語 |
nb |
Norwegian_Bokm??l |
いいえ |
ノルウェー語 |
pl |
ポーランド語 |
pt |
Portuguese-Portugal |
pt-BR |
Portuguese-Brazilian |
ru |
ロシア語 |
sk |
スロバキア語 |
sv |
スウェーデン語 |
th |
タイ語 |
tr |
トルコ語 |
ro |
ルーマニア語 |
zh-CN |
中国語(簡体字) |
zh-TW |
中国語(繁体字) |
Applinkイベント
ApplinksリソースはAppLinkReady
イベントをサポートしています。
イベント | 説明 |
---|---|
AppLinkReady |
必要なトークン・データをURLに送信する(これにより、トークンが公開されて様々なキャッシュに格納される)のではなく、埋込みユーザー・インタフェースを含むHTMLインライン・フレーム( |
メッセージ・ハンドラの例
必要なキー(短期dAppLinkAccessToken
および長期dAppLinkRefreshToken
)をURLに公開せずにインライン・フレームに渡すには、AppLinkReady
イベントを使用します。 基本的なステップは次のとおりです。
-
埋込みユーザー・インタフェースが含まれているインライン・フレームがキーのないURLを使用して、Documents Cloudサーバーに最初のコールを行います。
-
サーバーは、JavaScriptをインライン・フレームにダウンロードし、
AppLinkReady
メッセージを親ウィンドウに投稿します。 -
親ウィンドウは、キーが含まれるデータをインライン・フレームにポストします。
-
インライン・フレームが、(URLにではなく)ヘッダーに短期キーを指定して別のURLをDocuments Cloudサーバーに送信します。
次の例は、簡単なメッセージ・ハンドラを示しています。 例で参照されているcreateAppLink
関数は示されていませんが、必要なapplinkリソース・データを返すと想定されています:
$( document ).ready(function() { var id = "<Folder or File ID>"; var role = "contributor"; var assignedUser = "<User ID>"; // createAppLink function not shown but assumed to return appLink resource data obtained // from Create Folder Applink or Create File Applink service var appLink = createAppLink(id, role, assignedUser); function OnMessage (evt) { if (evt.data.message === 'appLinkReady') { var iframe= $('#applink_iframe')[0]; var iframewindow= iframe.contentWindow ? iframe.contentWindow : iframe.contentDocument.defaultView; var msg = { message: 'setAppLinkTokens', appLinkRefreshToken:appLink.refreshToken, appLinkAccessToken:appLink.accessToken, appLinkRoleName:role, embedPreview: true } iframewindow.postMessage(msg, '*???); } }; window.addEventListener && window.addEventListener('message', OnMessage, false); });
Applink API
RESTエンドポイントおよびAPIの説明は、Applinksを参照してください。