SharePoint アドインの URL 文字列とトークン
重要
SharePoint での URL の作成方法と、作成した URL でのトークンの使用に関する一般的な情報については、「SharePoint の URL とトークン」を参照してください。 このトピックでは、SharePoint アドインで利用可能なトークンについて説明します。
SharePoint アドインで使用するために SharePoint でサポートされているトークンは次の表に記載されています。
このセクションの表中のトークンは、カスタム アクションやカスタム ページ上のリンクなど、SharePoint アドインの開発中のさまざまな状況の URL で使用できます。
場合によっては、これらのトークンの一部は使用できません。 限定されたリストのトークンのみが使用できる 3 つの重要な場所として、アドインの開始ページ、ホスト Web のカスタム アクション、およびアドイン パーツの Src プロパティがあります。 これらは別々の列で呼び出されます。しかし、これはトークンを使用できるのすべての場所を網羅したリストではありません。
各表について:
- スタート ページ列では、アドイン マニフェストの StartPage 要素にトークンを使用できるかどうかを指定します。
- カスタム アクション列では、ホスト Web のカスタム アクションの URL にトークンを使用できるかどうかを指定します。
- アドイン パーツ列では、アドイン パーツの Src プロパティにトークンを使用できるかどうかを指定します。
URL の先頭で使用できるトークン
| トークン | 解決先 | スタート ページ | カスタム アクション | アドイン パーツ | 注釈 |
|---|---|---|---|---|---|
| ~appWebUrl | SharePoint アドインのアドイン Web の URL | はい | はい | はい | このトークンは、アドイン Web の外部でのみ使用してください。 アドイン Web 自体の内部では、アドイン Web の URL として ~site を使用します。 |
| ~controlTemplates | 現在の Web サイトの ControlTemplates 仮想フォルダーの URL | いいえ | いいえ | いいえ | |
| ~hostUrl | ホスト Web の URL。 | いいえ | いいえ | はい | |
| ~hostLogoUrl | ホスト Web のロゴの URL。 | いいえ | いいえ | いいえ | |
| ~layouts | 現在の Web サイトの Layouts 仮想フォルダーの URL | いいえ | いいえ | いいえ | |
| ~remoteAppUrl | SharePoint アドイン内のリモート Web アプリケーションの URL | はい | ホスト Web の場合は○、アドイン Web の場合は×。 | はい | Microsoft Office Developer Tools for Visual Studio を使用して SharePoint アドインを開発していない場合、StartPage URL で ~remoteAppUrl を使用することはできません。 ただし、Visual Studio とツールを使用している場合は、プロバイダーホスト型アドインに対してこのトークンを使用できます。このトークンは、Visual Studio がアドインをパッケージ化するときに解決されます。 この使用方法では、実際には SharePoint トークンよりも Visual Studio トークンの方が多くなります。 これは、Microsoft Office Developer Tools for Visual Studio を使用していない場合でも、アドイン マニフェストの外部で使用できます。 |
| ~site | 現在の Web サイトの URL | いいえ | いいえ | はい | |
| ~sitecollection | 現在の Web サイトの親サイト コレクションの URL | いいえ | いいえ | はい |
特に指定されていない場合を除き、次のテーブルのトークンは、アドイン パーツの Src プロパティ値のパス部分で使用できません。 "アドイン パーツ" は、値のクエリ文字列部分での使用を示しています。
URL 内で使用できるトークン
| トークン | 解決先 | スタート ページ | カスタム アクション | アドイン パーツ | 注釈 |
|---|---|---|---|---|---|
| {AppContextToken} | アドインの OAuth コンテキスト トークン。 | いいえ | いいえ | いいえ | |
| {AppWebUrl} | SharePoint アドイン内のアドイン Web の URL | はい | はい | はい | このトークンは、アドイン Web の外部でのみ使用する必要があります。 アドイン Web 自体の内部では、アドイン Web の URL として {Site} を使用します。 |
| {ClientTag} | 現在の Web サイトのクライアント キャッシュ コントロール番号 (クライアント タグ)。 | はい | はい | はい | |
| {HostLogoUrl} | SharePoint アドインのホスト Web のロゴ | はい | はい | はい | |
| {HostTitle} | SharePoint アドインのホスト Web のタイトル | はい | はい | はい | |
| {HostUrl} | SharePoint アドインのホスト Web の URL | はい | はい | はい | |
| {ItemId} | リストまたはライブラリ内の項目の ID (整数)。 | いいえ | はい | いいえ | |
| {ItemUrl} | 作用対象のアイテムの URL | いいえ | はい | いいえ | |
| {Language} | SharePoint アドインのホスト Web に設定されている現在の言語/カルチャ | はい | はい | はい | |
| {ListId} | 現在のリストの ID (GUID) | いいえ | はい | いいえ | |
| {ProductNumber} | SharePoint ファームの完全なビルド バージョン番号。 | はい | はい | はい | 値の例は "15.0.4433.1011" です。 |
| {RecurrenceId} | 再帰イベントの再帰インデックス | いいえ | はい | いいえ | このトークンは、リスト アイテムのコンテキスト メニューでの使用がサポートされていません。 |
| {RemoteAppUrl} | SharePoint アドイン内のリモート Web アプリケーションの URL | はい | はい | はい | |
| {Site} | 現在の Web サイトの URL | いいえ | はい | はい | |
| {SiteCollection} | 現在の Web サイトの親サイトの URL | いいえ | はい | はい | |
| {SiteUrl} | 現在の Web サイトの URL | いいえ | はい | いいえ | |
| {Source} | HTTP 要求の URL。 | いいえ | はい | いいえ | |
| {StandardTokens} | 注釈を参照してください。 | はい | はい | はい | これは他の 5 個のトークンを組み合わせます。 最初に、SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber} に解決されます。 次に、これらの各トークンが解決されます。 アドイン Web がない場合、 &SPAppWebUrl={AppWebUrl} の部分は存在しません。 |