SharePoint アドインのアプリ マニフェスト構造およびパッケージについて調べるExplore the app manifest structure and the package of a SharePoint Add-in

SharePoint 用アドインのパッケージ構造Add-in for SharePoint package structure

SharePoint アドイン パッケージは拡張子 ".app" を持つファイルで、Open Packaging Conventions (OPC) に準拠しています。A SharePoint Add-in package is a file that has an ".app" extension and that complies with the Open Packaging Conventions (OPC). パッケージには、次のアイテムが含まれます。The PS_1st_CurrentVer SP1 package contains the following:

  • アドイン マニフェスト: これは appmanifest.xml という名前の必須ファイルです。Add-in manifest: This is a required file that is named appmanifest.xml. このファイルは、アドインの重要なプロパティ (タイトルや実行するために必要なアクセス許可など) を SharePoint に通知します。Add-in manifest: This is a required file that is named appmanifest.xml. It tells SharePoint about some important properties of the add-in, such as its title and the permissions it needs to run. For more information about the contents of this file, see Add-in for SharePoint manifest file. このファイルの詳細については、「SharePoint 用アドインのマニフェスト ファイル」を参照してください。For more information about the contents of this file, see Add-in for SharePoint manifest file.

  • SharePoint ソリューション パッケージ: オプションとして、アドイン Web のコンポーネントを含む SharePoint ソリューション パッケージ (.wsp ファイル) をアドインに含めることができます。SharePoint solution packages: Optionally, the add-in may include a SharePoint solution package (.wsp file) that contains the components of the add-in web. これらのコンポーネントには、ページ、リスト インスタンス、ビュー、ドキュメント、Web の範囲のフィーチャー、その他の SharePoint コンポーネントを含めることができます。These components may include pages, list instances, views, documents, web-scoped features, and other SharePoint components. (SharePoint アドインに含められる SharePoint コンポーネントの詳細については、「SharePoint アドインに含めることができる SharePoint コンポーネントの種類」を参照してください。) Office アドインを .wsp ファイルに含めることもできます。.wsp ファイルのコンポーネントは、アドイン Web に展開されます。SharePoint Solution Packages: Optionally, the add-in may include a SharePoint solution package (.wsp file) that contains the components of the add-in web. These components may include pages, list instances, views, documents, Web-scoped Features, and other SharePoint components. (For more information about what SharePoint components can be included in a SharePoint Add-in, see Types of SharePoint components that can be in a SharePoint Add-in.) The .wsp file may also contain Office Add-ins. The components in the .wsp file are deployed to the add-in web. For an example of an add-in package that includes a SharePoint solution package, see Create a provider-hosted add-in that includes a custom SharePoint list and content type. SharePoint ソリューション パッケージを含むアドイン パッケージの例については、「SharePoint のカスタムのリストおよびコンテンツ タイプを含む、プロバイダー向けのホスト型アドインを作成する」を参照してください。For an example of an add-in package that includes a SharePoint solution package, see Create a provider-hosted add-in that includes a custom SharePoint list and content type.

  • カスタム アクションまたはアドイン パーツ付きのホスト Web フィーチャー: アドイン Web に展開される SharePoint コンポーネントに加え、SharePoint アドインは、1 つまたは複数のカスタム アクション (ショートカット メニュー アイテムやリボン拡張など) をホスト Web に展開することもできます。Host web features with Custom Actions or add-in parts: In addition to the SharePoint components that are deployed to the add-in web, a SharePoint Add-in can also deploy one or more custom actions (shortcut menu items or ribbon extensions) to the host web. パッケージの .wsp ファイルにはないものの、ホスト Web に配置されるコンポーネントを展開するフィーチャーをアドイン パッケージに含めることにより、これが実現されます。This is accomplished by including in the add-in package a feature that is not inside the package's .wsp file and that deploys the components that go to the host web. この "ルーズな" フィーチャーは、ホスト Web フィーチャーと呼ばれます。This "loose" feature is called a host web feature.

    アドイン パーツは、同じ方法でホスト Web に展開されます。Add-in parts are deployed to the host web in the same way. ホスト Web フィーチャーは、標準的な SharePoint feature.xml ファイルと、1 つまたは複数の関連付けられた elements.xml ファイルで構成されます。The host web feature consists of a standard SharePoint feature.xml file and one or more associated elements.xml files. たとえば、カスタム アクションの elements.xml ファイルには、カスタム アクション用の CustomAction マークアップが含まれています。An elements.xml file for a custom action, for example, contains the CustomAction markup for the custom action. また、アドイン パーツのマークアップを含めることもできます。It can also include markup for add-in parts. ホスト Web フィーチャーには、これら 2 種類のコンポーネントしか含めることができません。Only these two kinds of components can be in the host web feature. これらのホスト Web フィーチャーは、アドイン マニフェストではアイテム化されません。These host web features are not itemized in the add-in manifest. ただし、これらは OPC では "パーツ" であり、アドイン マニフェストとこれらの各ファイルの間には、明示的な OPC リレーションシップがあります。However, they are "parts" in the OPC sense, and there is an explicit OPC relationship between the add-in manifest and each of these files. ホスト Web フィーチャーを含むアドイン パッケージの例については、「SharePoint アドインで展開するカスタムアクションを作成します」を参照してください。For an example of an add-in package that includes a host web feature, see Create custom actions to deploy with SharePoint Add-ins.

    注意

    テナント管理者には、SharePoint アドインを複数の Web サイトにバッチ インストールするというオプションがあります。Tenant administrators have the option to batch-install a SharePoint Add-in to multiple websites. この方法でインストールされているアドインは、テナント スコープを持っていることになります。An add-in that has been installed in this way is said to have Tenant scope. アドインがバッチ インストールではなく、各 Web サイトに別々にインストールされている場合は、Web スコープを持っています。If the add-in has not been batch-installed, and is instead installed to each website separately, it has Web scope. ホスト Web フィーチャーにリボン拡張やアドイン パーツが含まれている場合にアドインをバッチ インストールすると、リボン拡張やアドイン パーツは、ホスト Web に展開されません。そのため、テナント スコープのアドインと共にショートカット メニュー アイテムのみが展開されます。If the host web feature includes ribbon extensions or add-in parts, they are not deployed to the host webs if the add-in is batch-installed, so only shortcut menu items are deployed with Tenant-scoped add-ins.

    アドイン スコープをフィーチャー スコープと混同しないでください。Add-in scope should not be confused with Feature scope. フィーチャー スコープは、フィーチャー内の要素の展開場所を決定します。Feature scope determines where the elements in a Feature are deployed. その候補には、ファームWeb アプリケーションサイト (つまり、サイト コレクション)、Web が挙げられます。The possibilities include Farm, WebApplication, Site (that is, site collection), and Web. Web オプションのみが SharePoint アドイン内のフィーチャー (ホスト Web フィーチャーと、アドイン パッケージ内の .wsp 内部のフィーチャーの両方) に対して許可されます。Only Web is permitted for Features in SharePoint Add-ins (both host web features and features inside a .wsp in an add-in package).

    アドイン スコープとは、アドインがインストールされる範囲です。Add-in scope refers to the scope at which an add-in is installed. その候補には、Web (1 つまたは複数の Web サイトに対して、サイトごとにインストールされているアドインの場合) と、テナント (顧客のテナント内のすべてまたは一部の Web サイトにバッチ インストールされているアドインの場合) が挙げられます。The possibilities are Web, in which case the add-in has been installed to one or more websites site-by-site, and Tenant, in which case the add-in has been batch installed to all or some subset of the websites in a customer's tenancy.

    テナント スコープと Web スコープの詳細については、「SharePoint アドインのテナントと展開スコープ」を参照してください。For more information, see Tenancies and deployment scopes for SharePoint Add-ins.

  • ローカライズ リソース ファイル (.resx) : これらは、アドインのタイトルを含むアドイン マニフェストの各部と、アドイン パッケージ内のホスト Web フィーチャーの各部をローカライズするためのファイルです。Localization resource files (.resx): These are for localizing aspects of the add-in manifest that include the add-in title and aspects of host web features in the add-in package. (.wsp ファイル、Azure Web サイト パッケージ、アドイン マニフェストなどの独自のパッケージに含まれるアドイン パッケージの個々のパーツには、それぞれ独自のローカライズ プロセスがあり、それらのプロセスは対象のアイテムが SharePoint アドインのパーツではない場合と全く同じように適用されます。) ホスト Web フィーチャー用の .resx ファイルがあるアドイン パッケージの例については、「SharePoint アドインをローカライズする」を参照してください。Localization resource files (.resx): These are for localizing aspects of the add-in manifest that include the add-in title and aspects of host web Features in the add-in package. (Individual parts of the add-in package that are inside their own package, such as .wsp files, Azure Web Sites packages, and add-in manifests, each have their own localization processes that are applied exactly as they would be if the items in question were not part of a SharePoint Add-in.) For an example of an add-in package that includes .resx files for a host web Feature, see Localize SharePoint Add-ins.

  • Office アドイン マニフェスト: オプションであり、それぞれが Office アドインをパッケージ化する 1 つまたは複数の Office アドイン マニフェストになる場合があります。Office Add-ins manifests: Optionally, there may be one or more Office Add-ins manifests that each package an Office Add-in. このパーツは、一般の Marketplace にではなく SharePoint コーポレート アドイン カタログにアドインがアップロードされる場合のみ、アドイン パッケージに含めることができます。Office Add-ins Manifests: Optionally, there may be one or more Office Add-ins manifests that each package an Office Add-in. This part can be included in the add-in package only if the add-in is going to be uploaded to a SharePoint corporate add-in catalog, not the public marketplace. See Publish SharePoint Add-ins for more information. 詳細については、「SharePoint アドインを公開する」を参照してください。For more information, see SharePoint Add-ins.

SharePoint 用アドインのマニフェスト ファイルAdd-in for SharePoint manifest file

すべての SharePoint アドインには、appmanifest.xml ファイルがあります。appmanifest.xml は、アドインについて知る必要があるデータを SharePoint に通知し、アドインの最も重要なプロパティを定義します。このマニフェストに指定されるアイテムの一部を次に示します。Every SharePoint Add-in includes an appmanifest.xml file. The appmanifest.xml tells SharePoint what it must know about the add-in and defines the add-in's most important properties. The following are some of the items that are specified in the manifest:

  • アドインの内部名、製品 ID、およびバージョン。The internal name, product ID, and version of the add-in.

  • スタート ページの URL。これは、アドインの起動時に開くページです。アドイン Web 内のページ、クラウド ベースのページ、または ISV の Web サーバー上のページを使用できます。The URL of the start page, which is the page that opens when the add-in is started. This can be a page in the add-in web, a cloud-based page, or a page on a web server of the ISV.

    注意

    一部の環境では、StartPage 要素で指定可能なファイルの種類に制限がある場合があります。In certain circumstances, there may be restrictions on what type of file can be specified in the StartPage element. For details, see StartPage element (PropertiesDefinition complexType) (SharePoint Add-in Manifest). 詳細については、「StartPage 要素 (PropertiesDefinition complexType) (SharePoint アドイン マニフェスト)」を参照してください。For details, see StartPage element (PropertiesDefinition complexType) (SharePoint Add-in Manifest). 複数のクエリ パラメータを スタートページ 値に複合する場合には、コード化されたアンパサンドである& ではなく& を使用するか、あるいはセミコロンで区切って追加する必要があります。When you are combining more than one query parameter in the StartPage value, you must use the encoded ampersand "&&" rather than "&&" or a semi-colon to append them together.

  • アドインのその他のプロパティ。これには、アドインでサポートされるタイトルとロケール (両方とも必須)、インストール後、アップグレード後、アンインストール前の各イベントを処理するサービスの URL、およびアドイン Web の作成時に使用する Web テンプレートがあります。Other properties of the add-in. These include title and the locales supported by the add-in (both are required), the URLs of services that handle the post-install, post-upgrade, and pre-uninstall events, and the web template to use when the add-in web is created.

  • アドインが必要とする、アドイン Web の外部の SharePoint リソースに対するアクセス許可要求。Requests for permissions the add-in needs to SharePoint resources outside the add-in web.

  • 認証と承認を目的とするアドイン プリンシパルの ID。アクセス許可を付与されるのはこのプリンシパルです。これは、SharePoint ホスト型アドインでは必要ありません。An identification, for authentication and authorization purposes, of the add-in principal. It is this principal that is granted permissions. This is not required for a SharePoint-hosted add-in.

  • アドインをインストールするために、アドインで使用できるようにする前提条件のリスト (存在する場合)。A list of the prerequisites, if any, that must be available to the add-in in order for the add-in to be installed. For example, certain Features may need to be installed and activated, and certain services may need to be licensed and installed. たとえば、特定の機能をインストールしてアクティブ化する必要がある場合や、特定のサービスのライセンスを取得してインストールする必要がある場合があります。A list of the prerequisites, if any, that must be available to the add-in in order for the add-in to be installed. For example, certain Features may need to be installed and activated, and certain services may need to be licensed and installed.

注意

アドイン マニフェスト ファイルはアドイン パッケージの唯一の必須アイテムですが、前述したリストのアイテムは、そのすべてがこのファイルの必須パーツというわけではありません。The add-in manifest file is the only required item in the add-in package, but not all of the items in the previous list are required parts of the file.

アドイン マニフェスト マークアップの詳細については、「SharePoint アドインのマニフェスト向けのスキーマ リファレンス」を参照してください。このトピックは、必須の要素と属性に関する情報も含めて、そのノードの情報の代わりになるものではありません。For detailed information about the add-in manifest markup, see the node Schema reference for manifests of SharePoint Add-ins. This topic is not a substitute for the information in that node, including information about required elements and attributes. Also, note that SharePoint add-in manifests have a different schema from Office Add-in manifests. You can find information about the latter at Schema reference for Office Add-ins manifests (v1.1). また、SharePoint アドイン マニフェストのスキーマは、Office アドイン マニフェストのスキーマとは異なります。Also, note that SharePoint add-in manifests have a different schema from Office Add-in manifests. Office アドイン マニフェストのスキーマの詳細については、「Office アドインのマニフェスト向けのスキーマ リファレンス (v1.1)」を参照してください。You can find information about the latter at Schema reference for Office Add-ins manifests (v1.1).

appmanifest.xml ファイルの例を次に示します。The following is an example of an .spfont file. この例でのアドインのスタート ページは、リモート サーバー上の ASP.NET ページであり、SharePoint サイト上のページではありません。Note that in this example, the start page for the add-in is an ASP.NET page that is on a remote server, not a page on the SharePoint site. ページの URL には、リモート Web アプリケーションにホスト Web の URL を渡すクエリ文字列が含まれます。The URL for the page includes a query string that passes to the remote web application the URL of the host web. 文字列の {HostUrl} の部分は、アドイン起動時に解決されるトークンです。The {HostUrl} part of the string is a token that is resolved when the add-in is launched. このアドインは、ホスト Web 内のすべてのリストへの書き込みアクセス許可を要求します。The add-in is requesting Write permission to all the lists in the host web. このアクセス許可を付与する必要があるアドイン プリンシパルは、リモート Web アプリケーションです。The add-in principal that must be granted this permission is the remote web application.

アドイン マニフェストでは、SupportedLocales 要素または SupportedLanguages 要素を使用する必要があります。You must use either the SupportedLocales or the SupportedLanguages element in your add-in manifest. SupportedLanguages は廃止されているため、SupportedLocales を使用します。SupportedLanguages is being deprecated in favor of SupportedLocales. SupportedLanguages 要素はリリース後も引き続き機能しますが、使用しないようにしてください。The SupportedLanguages element will continue to work even after release, but you should refrain from using it. これらの要素の詳細については、「SupportedLocales 要素 (PropertiesDefinition complexType) (SharePoint アドイン マニフェスト)」および「SupportedLanguages 要素 (PropertiesDefinition complexType) (SharePoint アドイン マニフェスト)」を参照してください。For more information about these elements, see SupportedLocales element (PropertiesDefinition complexType) (SharePoint Add-in Manifest) and SupportedLanguages element (PropertiesDefinition complexType) (SharePoint Add-in Manifest).

注意

AppPermissionRequest 要素の Scope 属性の値は URI のような構成になっていますが、実際はリテラル文字列です。The values of the Scope attribute of the AppPermissionRequest element are structured like URIs, but they are actually literal strings. No part of the example Scope value in the following example is a placeholder. For more information about permissions, see SharePoint add-in permissions. 次の例の Scope 値には、プレースホルダーは存在しません。No part of the example Scope value in the following example is a placeholder. アクセス許可の詳細については、「SharePoint でのアドインのアクセス許可」を参照してください。For more information about add-in permissions, see Add-in permissions in SharePoint.

<?xml version="1.0" encoding="utf-8" ?>
<App xmlns="http://schemas.microsoft.com/sharepoint/2012/app/manifest"
     ProductID="{4a07f3bd-803d-45f2-a710-b9e944c3396e}"
     Version="1.0.0.0"
     SharePointMinVersion="15.0.0.0"
     Name="MySampleApp"
>
  <Properties>
    <Title>My Sample App</Title>
    <StartPage>http://MyRemoteWebApplicationServer/default.aspx/?SPHostUrl={HostUrl}</StartPage>
    <SupportedLocales>
      <SupportedLocale CultureName="en-US" />
    </SupportedLocales>        
  </Properties>

  <AppPermissionRequests>
    <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web/list" Right="Write"/>
  </AppPermissionRequests>

  <AppPrincipal>
    <RemoteWebApplication ClientId="1ee82b34-7c1b-471b-b27e-ff272accd564" />
  </AppPrincipal>
</App>


アドイン マニフェスト内の URL トークンURL tokens in the add-in manifest

SharePoint には、アドインが実行されるまではわからない情報を表すために、アドイン内やアドインのコンポーネント内の StartPage 要素の中やその他の場所で使用できるさまざまなトークンが用意されています。SharePoint provides several tokens that can be used in the StartPage element and other places in add-ins and components of add-ins to represent information that is not known until the add-in is run. これらのトークンは SharePoint インフラストラクチャによって解決されます。The SharePoint infrastructure resolves these tokens. URL の先頭で使用されるトークンや、URL の中でクエリ パラメーターの値などとして使用できるトークンがあります。Some are used at the beginning of the URL and others can be used within a URL such as the value of a query parameter. これらのトークンと、その他のいくつかのトークンは、SharePoint のさまざまな開発コンテキストでも使用できます。These tokens and several others can also be used in a variety of SharePoint development contexts.

すべてのトークンとそれらを使用できる場所の詳細については、「SharePoint アドインの URL 文字列とトークン」を参照してください。SharePoint の他のトークンと URL の概要については、「SharePoint 2013 の URL とトークン」を参照してください。For detailed information about all the tokens and where they can be used, see URL strings and tokens in SharePoint Add-ins. For general information about other tokens and URLs in SharePoint, see URLs and tokens in SharePoint.

注意

これらのトークンは、AppPermissionRequest 要素の Scope 属性では使用されません。These tokens are not used in the Scope attribute of an AppPermissionRequest element.

関連項目See also