Excel Services REST API での検出Discovery in Excel Services REST API

このトピックでは Excel Services REST API に組み込まれた検出メカニズムについて説明します。This topic discusses the discovery mechanisms built into the Excel Services REST API.

注意

Excel Services REST API は、SharePoint および SharePoint 2016 オンプレミスに適用されます。The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. Office 365 Education、Business、Enterprise の各アカウントでは、Microsoft Graph エンドポイントの一部である Excel REST API を使用します。For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the Microsoft Graph endpoint.

検出ベース URL と検出例Discovery Base URL and Discovery Example

検出では、開発者とユーザーが手動またはプログラミングにより、ブックについての情報とブックの内容を検出できるようにします。検出メカニズムは、ブック内のリソースについての情報を含む Atom フィードを提供します。検出を使用することにより、ブック内のリソースを確認して表示することができます。確認してアクセスすることができるリソースは、範囲、グラフ、表、およびピボットテーブルです。Discovery enables developers and users to discover information about and the content of a workbook manually or programmatically. The discovery mechanism supplies the Atom feed that contains information about the resources in a workbook. By using discovery, you can explore and view the resources in the workbook. Resources that you can explore and access are ranges, charts, tables, and PivotTables.

ブック内の特定の要素に対する REST URL の構造を次に示します。Following is the construct of the REST URL to a specific element in a workbook:


http://<ServerName>/_vti_bin/ExcelRest.aspx/<DocumentLibrary>/<FileName>/<ResourceLocation>

基本的な URI 構造およびパス」トピックで説明されているように、以下は sampleWorkbook.xlsx という名前のブックにアクセスし、さらに SampleChart という名前のグラフを表示するための REST URL です。As described in the Basic URI Structure and Path topic, following is the REST URL to access a workbook named sampleWorkbook.xlsx and further view the chart called SampleChart:

http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart')

検出によってブックを開き、ブック内のリソースを確認および表示するには、この例の後の URI を使用してモデル ページを参照してください。To start and explore the resources in the workbook and view the resources by using discovery, go to the model page by using a URI that follows this example:

http://<ServerName>/_vti_bin/ExcelRest.aspx/<DocumentLibrary>/<FileName>/model

"sampleWorkbook.xlsx" の例を使用する場合は、次の URI になります。Using the "sampleWorkbook.xlsx" example, following is the URI:

http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model

以下はモデル ページのスクリーン ショットです。Following is a screen shot of the model page.

Excel Services REST モデル URLExcel Services REST model URL

Excel Services REST モデル URL

モデル ページへの URL が、検出を始める場所です。モデル ページは Excel Services REST API が現在サポートする 4 つのリソース コレクションを表示します。リソース コレクションは、範囲、グラフ、テーブル、またはピボットテーブルです。モデル ページで [ 範囲]、[ グラフ]、[ テーブル]、または [ ピボットテーブル] をクリックすることによって、特定のブック内のそれらのリソースを確認できます。The URL to the model page is where you start the discovery. The model page displays four resource collections that the Excel Services REST API currently supports. The resource collections are ranges, charts, tables, or PivotTables. You can explore those resources in a particular workbook by clicking Ranges, Charts, Tables, or PivotTables on the model page.

たとえば、検出を使用してブック内のグラフにアクセスするには、次の操作を実行します。For example, to access the chart in the workbook by using discovery, do the following:

  1. モデル ページで [ グラフ] をクリックします。[ グラフ] リンクをクリックすると別の Atom フィードが表示されます。この結果のフィードは sampleWorkbook.xlsx ブックで使用可能なすべてのグラフを列挙します。sampleWorkbook.xlsx ブックには、 Chart 1Chart 3、および SampleChart という名前の 3 つのグラフが含まれます。このため、次のスクリーン ショットのように、3 つのグラフ名が一覧表示されます。On the model page, click Charts. Clicking the Charts link brings another Atom feed—this resulting feed lists all the charts that are available in the sampleWorkbook.xlsx workbook. The sampleWorkbook.xlsx workbook contains three charts named Chart 1, Chart 3, and SampleChart. Therefore, three chart names are listed, as seen in the following screen shot.

    Excel Services REST のグラフ検出リストExcel Services REST discovery chart list

Excel Services REST 検出チャート リスト

  1. モデル ページで [ SampleChart] をクリックします。これにより、次のスクリーン ショットで示されるように、 sampleWorkbook.xlsx 内の SampleChart という名前のグラフが表示されます。On the model page, click SampleChart. This displays the chart named SampleChart that resides in sampleWorkbook.xlsx, as shown in the following screen shot.

    REST を使用したグラフの表示Viewing chart using REST

REST を使用したグラフの表示

  1. 同様に、[ Chart 1] または [ Chart 3] をクリックすると、対応する名前のグラフが表示されます。[ SampleChart] をクリックすると、実際のグラフ URL に移動します。以下は SampleChart 画像 (スクリーン ショットを参照) の URL です。Similarly, clicking Chart 1 or Chart 3 displays the chart with the corresponding name. Clicking SampleChart navigates to the actual chart URL. Following is the URL to the SampleChart image (as can be seen in the screen shot):
  http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image

Atom フィードAtom Feed

REST API が提供する Atom フィードを使用すると、興味あるデータを簡単に入手できます。Web ページのソースを表示すると、XML を取得できます。sampleWorkbook.xlsx のグラフの例を以下に示します。Using the Atom feed provided by the REST API gives you an easier way of getting to the data that you are interested in. If you view the source of the Web page, you get the XML. An example from the charts in sampleWorkbook.xlsx is shown below.

XML に示されているように、フィードにはブック内にどんな要素が存在するかコードが検出できるようにする、トラバース可能な要素が含まれます。それぞれの Atom エントリは、アクセス可能なグラフに対応します。この同じメカニズムは範囲、テーブル、およびピボットテーブルの検出にも当てはまります。As can be seen in the XML, the feed contains traversable elements that enable code to discover what elements exist in the workbook. Each Atom entry corresponds to a chart that can be accessed. This same mechanism applies to discovering ranges, tables, and PivotTables.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:x="http://schemas.microsoft.com/office/2008/07/excelservices/rest" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservice" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <title type="text">Charts</title>
  <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts</id>
  <updated>2010-01-19T19:32:53Z</updated>
  <author>
    <name />
  </author>
  <link rel="self" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts?$format=atom" title="Charts" />
  <entry>
    <category term="ExcelServices.Chart" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title>Chart 1</title>
    <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%201')</id>
    <updated>2010-01-19T19:32:53Z</updated>
    <author>
      <name />
    </author>
    <link rel="alternate" title="Chart 1" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%201')?$format=image" />
    <content type="image/png" src="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%201')?$format=image" />
  </entry>
  <entry>
    <category term="ExcelServices.Chart" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title>Chart 3</title>
    <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%203')</id>
    <updated>2010-01-19T19:32:53Z</updated>
    <author>
      <name />
    </author>
    <link rel="alternate" title="Chart 3" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%203')?$format=image" />
    <content type="image/png" src="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%203')?$format=image" />
  </entry>
  <entry>
    <category term="ExcelServices.Chart" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title>SampleChart </title>
    <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')</id>
    <updated>2010-01-19T19:32:53Z</updated>
    <author>
      <name />
    </author>
    <link rel="alternate" title="SampleChart" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image" />
    <content type="image/png" src="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image" />
  </entry>
</feed>

関連項目See also

概念Concepts

Excel Services REST API のリソース URIResources URI for Excel Services REST API