Office 365 レポート Web サービスが返す一般的なメタデータ

このトピックでは、Office 365 レポート Web サービス が各レポートに付けて返し、各レポート エントリの一部として提供するメタデータについて説明します。

最終更新日: 2015年9月17日

適用対象: Office 365

サービス レベルのメタデータ

認証されたユーザーのためのレポートおよびフィールドの一覧の XML (Atom 形式) ドキュメントを取得するには、この URL にアクセスします。

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/$metadata

返されるメタデータ ドキュメントには、次の 3 つの主要なセクションがあります。

• EntityType 要素は、レポートのそれぞれのタイプ、すべてのインデックス キー、すべてのプロパティの名前とタイプを定義します。

• EntityContainer 要素には、すべてのレポート名および対応する EntityType 定義の一覧が含まれます。

• Annotations 要素は、アプリケーションでグラフの軸ラベルのために使用できるローカライズされた文字列を提供します。レポートのタイトル、x 軸、および y 軸に対する文字列が提供されます。

注意

メタデータ ドキュメントに含まれる情報は、HTTPS 要求に入れて渡されたユーザー アカウントで使用可能なレポートの情報のみであることに注意してください。

レポートレベルのメタデータ

次に示すのは、StaleMailboxDetail レポートに対して返されるメタデータの Atom XML 形式のレポート出力サンプルです。アプリケーションが JSON データを要求した場合、レポートはこのメタデータを返しません。

<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/" 
    xmlns="http://www.w3.org/2005/Atom" 
    xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices"
    xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/StaleMailboxDetail</id>
  <title type="text">StaleMailboxDetail</title>
  <updated>2013-02-10T03:40:33Z</updated>
  <link rel="self" title="StaleMailboxDetail" href="StaleMailboxDetail" />
  

メタデータのコンポーネントを次の表に示します。

レポートレベルのメタデータ コンポーネント

Atom XML レポートレベルのメタデータのタグ	説明
xml:base	レポート サービスのベース エンドポイントを示します。この URL では大文字と小文字が区別されません。
XML 名前空間	いくつかの名前空間が参照されます。たとえば、標準 Atom 名前空間や、ODATA および Microsoft ADO 関連データ サービスの 2 つの名前空間があります。
<id>...</id>	レポートの非修飾の 基本 URL を提供します。
<title>…</title>	レポートのタイトルとして使用できるテキスト文字列を提供します。
<updated>...</updated>	呼び出し元アプリケーションにレポートが返された UTC 日付および時刻を提供します。
<link/>	<id> タグにリストされたベース レポート URL に対して HTML リンクを作成するために必要な情報を提供します。

エントリ アイテムのメタデータ

次の XML ドキュメント フラグメントは、StaleMailboxDetail レポートから Atom 形式で返されるエントリを示しています。

  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')</id>
    <category term="TenantReporting.StaleMailboxDetailReport"
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="StaleMailboxDetailReport" 
      href="StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')" />
    <title />
    <updated>2013-02-10T03:40:33Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-11T00:00:00</d:Date>
        <d:WindowsLiveID>userone@example.onmicrosoft.com</d:WindowsLiveID>
        <d:UserName>UserOne</d:UserName>
        <d:LastLogin m:type="Edm.DateTime" m:null="true" />
        <d:DaysInactive m:type="Edm.Int32">115</d:DaysInactive>
      </m:properties>
    </content>
  </entry>

この JavaScript フラグメントは、同じ情報を JSON 形式で表現したものです。

  {
    "d":
      [
          {
            "__metadata":
              {
                "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')",
                "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/StaleMailboxDetail(datetime'2013-01-11T00%3A00%3A00')",
                "type":"TenantReporting.StaleMailboxDetailReport"
              },
            "Date":"\/Date(1357862400000)\/",
            "WindowsLiveID":"userone@example.onmicrosoft.com",
            "UserName":"UserOne",
            "LastLogin":null,
            "DaysInactive":115
          }
      ]
  }

レポートのデータ フィールド (Date、WindowsLiveID、UserName、LastLogin、および DaysInactive) の説明については、「StaleMailboxDetail レポート」を参照してください。次の表は、このトピックで前述したレポート アイテムレベルのメタデータを示しています。標準の ODATA および ADO データ サービスのメタデータは、これで全部です。

エントリ アイテムのメタデータ

Atom XML アイテムレベルのメタデータのタグ	JSON JavaScript アイテムレベルのメタデータ プロパティ	説明
<id>...</id>	"id":	アイテムの ID を指定します。この ID は URI のように見えますが、この値を レポート Web サービス に渡すと何か有用な結果を得られるとは想定しないでください。これは単に一意の ID であるだけです。この一意性の有効範囲は 1 回のレポート結果内のみです。
<category>...</category>	"type":	この値は、サービス (TenantReporting) とレポート名 (StaleMailboxDetailReport) を結合した階層テキスト表現です。
<link>...</link>	"uri":	このレポート アイテムのコンポーネント (Atom) の、または完全な形式 (JSON) の URI を提供します。この URI に基づいてアイテムを直接的に取得する操作は、一部のレポートでのみサポートされます。アプリケーションでこれらの URI を使用する場合は、返された情報が想定どおりのものであることを確認してください。さらに、一部のレポートは "編集" リンクを返します。これらのリンクは機能しないため、使用しないでください。
<title />	指定されていません。	このタグは常に空です。
<updated>...</updated>	指定されていません。	呼び出し元アプリケーションにレポート エントリが返された UTC 日付および時刻を提供します。
<author><name /></author>	指定されていません。	これらのタグは常に空です。