SharePoint アドインの URL 文字列とトークンURL strings and tokens in SharePoint Add-ins

重要

SharePoint での URL の作成方法と、作成した URL でのトークンの使用に関する一般的な情報については、「SharePoint の URL とトークン」を参照してください。Important For general information about constructing URLs in SharePoint and the use of tokens in those URLs, see URLs and tokens in SharePoint. This topic describes the tokens that are available in SharePoint Add-ins. このトピックでは、SharePoint アドインで利用可能なトークンについて説明します。This topic describes the tokens that are available in SharePoint Add-ins.

SharePoint アドインで使用するために SharePoint でサポートされているトークンは次の表に記載されています。SharePoint supports the tokens listed in the following tables for use in SharePoint Add-ins.

このセクションの表中のトークンは、カスタム アクションやカスタム ページ上のリンクなど、SharePoint アドインの開発中のさまざまな状況の URL で使用できます。The tokens in the tables of this section can be used in URLs in a wide variety of situations in development of SharePoint Add-ins, such as in Custom Actions and in links on custom pages.

場合によっては、これらのトークンの一部は使用できません。In some contexts, some of these tokens cannot be used. 限定されたリストのトークンのみが使用できる 3 つの重要な場所として、アドインの開始ページ、ホスト Web のカスタム アクション、およびアドイン パーツの Src プロパティがあります。Three of the most important places where only a restricted list of tokens can be used are the start page of an add-in, a custom action on the host web, and the Src property of an add-in part. これらは別々の列で呼び出されます。しかし、これはトークンを使用できるのすべての場所を網羅したリストではありません。These are called out in separate columns, but this is not an exhaustive list of places where tokens can be used.

各表について:In each table:

  • スタート ページ列では、アドイン マニフェストの StartPage 要素にトークンを使用できるかどうかを指定します。The StartPage column specifies whether the token can be used in the StartPage element of an add-in manifest.
  • カスタム アクション列では、ホスト Web のカスタム アクションの URL にトークンを使用できるかどうかを指定します。The Custom Action column specifies whether the token can be used in the URL of a custom action on a host web.
  • アドイン パーツ列では、アドイン パーツの Src プロパティにトークンを使用できるかどうかを指定します。The Add-in Part column specifies whether the token can be used in the Src property of the add-in part.

URL の先頭で使用できるトークンTokens that can be used at the beginning of a URL

トークンToken 解決先Resolves to スタート ページStartPage カスタム アクションCustom Action アドイン パーツAdd-in Part 注釈Remarks
~appWebUrl~appWebUrl SharePoint アドインのアドイン Web の URLThe URL of the add-in web of a SharePoint Add-in. はいYes はいYes はいYes このトークンは、アドイン Web の外部でのみ使用してください。アドイン Web 自体の内部では、アドイン Web の URL として ~site を使用します。This token should be used only outside an add-in web. Within the add-in web itself, use ~site for the URL of the add-in web.
~controlTemplates~controlTemplates 現在の Web サイトの ControlTemplates 仮想フォルダーの URLThe URL of the ControlTemplates virtual folder for the current website. いいえNo いいえNo いいえNo
~hostUrl~hostUrl ホスト Web の URL。The URL of the host web. いいえNo いいえNo はいYes
~hostLogoUrl~hostLogoUrl ホスト Web のロゴの URL。The URL of the logo of the host web. いいえNo いいえNo いいえNo
~layouts~layouts 現在の Web サイトの Layouts 仮想フォルダーの URLThe URL of the Layouts virtual folder for the current website. いいえNo いいえNo いいえNo
~remoteAppUrl~remoteAppUrl SharePoint アドイン内のリモート Web アプリケーションの URLThe URL of a remote web application in a SharePoint Add-in. はいYes ホスト Web の場合は○、アドイン Web の場合は×。Yes, in the host web, but No in the add-in web. はいYes SharePoint アドインの開発に Microsoft Office Developer Tools for Visual Studio を使用していない場合、 StartPage URL で ~remoteAppUrl を使用することはできません。ただし、Visual Studio とそのツールを使用している場合、プロバイダーホスト型アドインにこのトークンを使用できます。これは、Visual Studio がアドインをパッケージ化するときに解決されます。この使用方法の場合、SharePoint トークンというよりも、Visual Studio トークンに近くなります。これは、Microsoft Office Developer Tools for Visual Studio を使用していない場合であっても、アドイン マニフェスト以外で使用できます。If you are not using Microsoft Office Developer Tools for Visual Studio to develop your SharePoint Add-in, you cannot use ~remoteAppUrl in the StartPage URL. However, when you are using Visual Studio and the tools, you can use this token for any provider-hosted add-in and it is resolved when Visual Studio packages the add-in. In this usage, it is really more of a Visual Studio token than a SharePoint token. It can be used outside the add-in manifest, even when you are not using Microsoft Office Developer Tools for Visual Studio.
~site~site 現在の Web サイトの URLThe URL of the current website. いいえNo いいえNo はいYes
~sitecollection~sitecollection 現在の Web サイトの親サイト コレクションの URLThe URL of the parent site collection of the current website. いいえNo いいえNo はいYes

特記がない場合、次の表のトークンは、アドイン パーツの Src プロパティ値の path 部分に使用できません。" アドイン パーツ " は、値の クエリ文字列 部分での使用を示しています。Except where indicated otherwise, none of the tokens in the next table can be used in the path portion of the Src property value of the add-in part. The Add-in Part column refers to their use in the query string portion of the value.


URL 内で使用できるトークンTokens that can be used inside a URL

トークンToken 解決先Resolves to スタート ページStartPage カスタム アクションCustom Action アドイン パーツAdd-in Part 注釈Remarks
{AppContextToken}{AppContextToken} アドインの OAuth コンテキスト トークン。The OAuth context token for the add-in. いいえNo いいえNo いいえNo
{AppWebUrl}{AppWebUrl} SharePoint アドイン内のアドイン Web の URLThe URL of the add-in web in a SharePoint Add-in. はいYes はいYes はいYes このトークンは、アドイン Web の外部でのみ使用する必要があります。This token should be used only outside an add-in web. Within the add-in web itself, use {Site} for the URL of the add-in web.
アドイン Web 自体の内部では、アドイン Web の URL として {Site} を使用します。This token should be used only outside an add-in web. Within the add-in web itself, use {Site} for the URL of the add-in web.
{ClientTag}{ClientTag} 現在の Web サイトのクライアント キャッシュ コントロール番号 (クライアント タグ)。The client cache control number (client tag) for the current website. はいYes はいYes はいYes
{HostLogoUrl}{HostLogoUrl} SharePoint アドインのホスト Web のロゴThe logo for the host web of a SharePoint Add-in. はいYes はいYes はいYes
{HostTitle}{HostTitle} SharePoint アドインのホスト Web のタイトルThe title of the host web of a SharePoint Add-in. はいYes はいYes はいYes
{HostUrl}{HostUrl} SharePoint アドインのホスト Web の URLThe URL of the host web of a SharePoint Add-in. はいYes はいYes はいYes
{ItemId}{ItemId} リストまたはライブラリ内の項目の ID (整数)。The ID of an item in a list or library (an integer). いいえNo はいYes いいえNo
{ItemUrl}{ItemUrl} 作用対象のアイテムの URLThe URL of the item being acted upon. いいえNo はいYes いいえNo
{Language}{Language} SharePoint アドインのホスト Web に設定されている現在の言語/カルチャThe current language/culture of the host web of a SharePoint Add-in. はいYes はいYes はいYes
{ListId}{ListId} 現在のリストの ID (GUID)The ID of the current list (a GUID). いいえNo はいYes いいえNo
{ProductNumber}{ProductNumber} SharePoint ファームの完全なビルド バージョン番号。The full build version number of the SharePoint farm. はいYes はいYes はいYes 値の例は "15.0.4433.1011" です。An example value is "15.0.4433.1011".
{RecurrenceId}{RecurrenceId} 再帰イベントの再帰インデックスThe recurrence index of a recurring event. いいえNo はいYes いいえNo このトークンは、リスト アイテムのコンテキスト メニューでの使用がサポートされていません。This token is not supported for use in the context menus of list items.
{RemoteAppUrl}{RemoteAppUrl} SharePoint アドイン内のリモート Web アプリケーションの URLThe URL of a remote web application in a SharePoint Add-in. はいYes はいYes はいYes
{Site}{Site} 現在の Web サイトの URLThe URL of the current website. いいえNo はいYes はいYes
{SiteCollection}{SiteCollection} 現在の Web サイトの親サイトの URLThe URL of the parent site of the current website. いいえNo はいYes はいYes
{SiteUrl}{SiteUrl} 現在の Web サイトの URLThe URL of the current website. いいえNo はいYes いいえNo
{Source}{Source} HTTP 要求の URL。The HTTP Request URL. いいえNo はいYes いいえNo
{StandardTokens}{StandardTokens} 注釈を参照してください。See Remarks. はいYes はいYes はいYes これは他の 5 個のトークンを組み合わせます。This combines five other tokens. 最初に、SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber} に解決されます。It initially resolves to... SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber}

次に、これらの各トークンが解決されます。...and then each of these tokens resolves. アドイン Web がない場合、&SPAppWebUrl={AppWebUrl} の部分は存在しません。This combines five other tokens. It initially resolves to . Then each of these tokens resolves. If there is no add-in web, the portion &SPAppWebUrl={AppWebUrl} is not present.

関連項目See also