MailTrafficPolicy レポート

[アーティクル]
12/20/2016

MailTrafficPolicy REST URI は、組織とのメールトラフィックに関する概要情報を提供します。レポートの開始日時と終了日時は、データの集計期間として要求内で指定できます。

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

適用対象: Office 365

REST URI

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTraffic[?ODATA options]

フィールド

次のフィールドは、$select、$filter、$orderby ODATA2 クエリオプションに指定できます。$select オプションが指定されない場合、すべてのフィールドが返されます。

名前	WCF 型*	EDM 型*	[入力/出力]** 説明	値の例	提供されたバージョン
Action	string	指定なし	[入力/出力] メッセージに対して実行されたアクション (存在する場合) の説明です。このフィールドは空白の場合がありますし、アクションが実行されていない場合は null になります。有効なアクション値については、「MailFilterList レポート」を参照してください。	SetSpamConfidenceLevel、RejectMessage	2013-V1
AggregateBy	string	指定なし	[入力] 全日をカバーするレポートエントリにデータを組み込むかどうかを示します。$filter に指定できる値は Day と Hour だけです。$select オプションに追加された場合、このフィールドは常に null を返します。指定されていない場合、レポートは 1 時間分を集計します。詳細については、「解説」セクションを参照してください。	Day または Hour	2013-V1
Date	System.DateTime	Edm.DateTime	[入力/出力] メッセージがスパムとして検出された日時です。	短い形式の日付 (たとえば、03/10/2013) または引用符付きの日付/時刻 (たとえば、"03/10/2013 4:55 PM")	2013-V1
Direction	string	指定なし	[入力/出力] メールがスパムとして検出されたときに、それが組織に送信されたもの (Inbound) か、組織から送信されたもの (Outbound) かを示します。	指定できる値はInbound と Outbound だけです。	2013-V1
DlpPolicy	string	指定なし	[入力/出力] メッセージに適用されたデータ損失防止 (DLP) ポリシーの名前です。有効な DlpPolicy 値については、「MailFilterList レポート」を参照してください。	Financial Data Detection、HIPAA Detection、PII Detection	2013-V1
Domain	string	指定されていません	[入力/出力] 電子メールを処理した完全修飾ドメイン名です。	example.onmicrosoft.com	2013-V1
EndDate	System.DateTime	Edm.DateTime	[入力] このフィールドは、レポート期間を制限するのに使用されます。このフィールドを $filter クエリオプションで使用して、レポート期間の終了日時を設定します。EndDate を $filter オプションに指定した場合、StartDate も指定する必要があります。	短い形式の日付 (たとえば、03/10/2013) または引用符付きの日付/時刻 (たとえば、"03/10/2013 4:55 PM")	2013-V1
EventType	string	指定なし	[入力/出力] ログに記録されたスキャンイベントの種類です。有効な EventType 値については、「MailFilterList レポート」を参照してください。	SpamContentFiltered、SpamIPBlock	2013-V1
MessageCount	int	Edm.Int64	[入力/出力] 集計期間中に、他のフィールドで指定されたカテゴリに一致するメッセージの数。	1254	2013-V1
Organization	string	指定なし	[入力/出力] 電子メールを処理した完全修飾ドメイン名です。	example.onmicrosoft.com	2013-V1
StartDate	System.DateTime	Edm.DateTime	[入力] このフィールドは、レポート期間を制限するのに使用されます。このフィールドを $filter クエリオプションに使用して、レポート期間の開始日時を設定します。StartDate を $filter オプションに指定した場合、EndDate も指定する必要があります。	短い形式の日付 (たとえば、03/10/2013) または引用符付きの日付/時刻 (たとえば、"03/10/2013 4:55 PM")	2013-V1
SummarizeBy	string	指定なし	[入力/出力] このフィールドを使用して $filter オプションに指定されたレポートフィールドによって、概要を構成するレポートエントリの組み合わせが決定されます。$select オプションに追加された場合は、このフィールドが、常に、null を返します。詳細については、「解説」セクションを参照してください。	Action、EventType、Domain、および Direction だけが、このフィールドで $filter オプションに使用できる値です。	2013-V1
TransportRule	string	指定なし	処理ステップで実行された Microsoft Exchange トランスポートルールの名前です。有効な TransportRule 値については、「MailFilterList レポート」を参照してください。	PII Detection	2013-V1

*WCF 型 は、Visual Studio で Windows Communication Foundation (WCF) サービス参照が作成されたときにフィールドに割り当てられる .NET Framework データ型を参照します。EDM 型は、Atom 形式のレポートで返される ADO.NET エンティティデータモデル (EDM) 型を参照します。

**[入力/出力] インジケータについては、「入力パラメーターとレポート出力列」のセクションを参照してください。

解説

レポート内の各エントリにはメタデータの複数のフィールドが含まれます。詳しくは、「Office 365 レポート Web サービスが返す一般的なメタデータ」を参照してください。

Date フィールドは、メッセージが Office 365 システムで処理された日時を示し、それらのサーバーのタイムゾーンで報告されます。

StartDate と EndDate の使用

StartDate と EndDate フィールドは、レポート結果では有用な情報を提供しませんし、レポート出力では常に 0001-01-01T00:00:00Z に設定されます。これらは、レポート時間枠を簡単に制限できるようにするためのもので、「日次」のレポートよりも細かく時間指定できるようにします。

これは、たとえば、電子メールベースのサービス拒否攻撃を時間単位で記録するときに特に役立ちます。これらのフィールドを使用する際、両方とも $filter オプションに含める必要があります。どちらもオプションですが、一方を指定した場合は、もう一方も指定する必要があります。StartDate/EndDate のペアがクエリに指定されていない場合、既定のレポート期間は、前の 2 週間になります。このトピックの後ろにある「サンプル」セクションで、StartDate フィールドと EndDate フィールドの使用方法について示します。

AggregateBy フィールドの使用

MailTrafficPolicy レポートは、Office 365 システム内の電子メール関連のイベントの集計を返します。各イベントはその Action、Event、Date、Sender などと一緒に記録されます。この記録されるデータには、各イベントの正確な日付と時刻が含まれます。MailDetailMalware などの「詳細」レポートは、特定のイベントとその正確な時刻のリストを提供します。MailTrafficPolicy などの「トラフィック」レポートは、時間と日という 2 つの期間におけるこれらのイベントのカウントを集計して提供できます。下の例で示すように、$filter クエリオプションで使用する期間を指定します。AggregateBy 比較が $filter オプションに含まれていない場合は、既定の Hour が使用されます。

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?$filter=AggregateBy eq 'Day'

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?$filter=AggregateBy eq 'Hour'

SummarizeBy フィールドの使用

SummarizeBy フィールドを使用すれば、指定したフィールド名でレポート出力を「折りたたむ」ことができます。たとえば、1 日分のレポート期間に 200 件の受信メールと 100 件の送信メールが発生したとします。クエリに $filter=AggregateBy eq ‘Day’ が含まれている場合は、レポートがその日に関する 2 つの別々のエントリを返します。1 つは受信メール用で MessageCount が 200 で Direction が Inbound を示し、もう 1 つは送信メール用で MessageCount が 100 で Direction が Outbound を示します。SummarizeBy eq 'Direction' のように $filter オプションで SummarizeBy フィールドも指定した場合は、レポートにはその日に関する 1 つのエントリ (Direction フィールドが空で MessageCount が 300) だけが含まれます。Direction フィールドが空の理由は、そのエントリで Direction eq 'Inbound' メッセージカウントと Direction eq ‘Outbound’ メッセージカウントの両方が集計されたためです。

SummarizeBy での使用がサポートされているのは、次のフィールドだけです。

Action
EventType
Direction
Domain

要求には、次の $filter オプションのように、集計に使用できる複数のフィールドを含められます。

$filter=SummarizeBy eq 'EventType,Action'

要求がフィールドに SummarizeBy を使用しており、かつそのフィールド名が $select オプションにも含まれている場合、そのフィールドは常に空の値で報告されます。

電子メールトラフィックの毎日の要約で、Date、Direction、MessageCount フィールドだけを戻す要求を行う方法を次に示します。結果は日単位で集計されます。わかりやすくするために、要求に改行が追加されています。

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?
$select=Date,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'&
$format=Atom

要求の結果を次に示します。簡単にするために、結果からほとんどのメタデータ要素を削除してあります。2 種類のエントリ、Direction が Inbound のものと、同じ日で Direction が Outbound のものがあることに注意してください。

<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/">
  <id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy</id>
  <title type="text">MailTrafficPolicy</title>
  <entry>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
        <d:Direction>Inbound</d:Direction>
        <d:MessageCount m:type="Edm.Int32">7</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
        <d:Direction>Outbound</d:Direction>
        <d:MessageCount m:type="Edm.Int32">58</d:MessageCount>
      </m:properties>
    </content>
  </entry>
 </feed>

同じ要求に Direction による要約を追加した場合、結果は次のようになります。

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?
$select=Date,Direction,MessageCount&
$filter=AggregateBy%20eq%20'Day'%20and%20SummarizeBy%20eq%20'Direction'&
$format=Atom

そのようにすると、その同じ日の応答は Direction フィールドを折りたたむ、つまり要約したものになります。言い換えれば、Directionフィールドの値のみ異なっているすべてのエントリの数を組み合わせます。Direction 要素は空として返されますが、これはレポートエントリが、Direction 値の違いを無視して、イベントの数を組み合わせたものになっていることを示します。

<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/">
  <id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy</id>
  <title type="text">MailTrafficPolicy</title>
  <entry>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-29T00:00:00</d:Date>
        <d:Direction>
        </d:Direction>
        <d:MessageCount m:type="Edm.Int32">65</d:MessageCount>
      </m:properties>
    </content>
  </entry>
 </feed>

例

下の例は、2013 年 1 月 1 日分の組織の受信メッセージの集計を Atom XML ベースの形式で取得する方法を示しています。このレポートでは SummarizeBy EventType が使用されているため、すべてのメッセージ処理に対して 1 つのレポートエントリが出力されています。見やすくするために、要求と応答の両方に改行が追加され、応答からエントリが除外されています。

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficPolicy?
$select=Date,DlpPolicy,MessageCount,TransportRule&
$filter=Direction%20eq%20'Inbound'%20and%20
  AggregateBy%20eq%20'Day'%20and%20
  StartDate%20eq%20datetime'2013-01-01T00:00:00Z'%20and%20
  EndDate%20eq%20datetime'2013-01-02T00:00:00Z'&$format=Atom

<?xml version="1.0" encoding="utf-8"?>
<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/MailTrafficPolicy</id>
  <title type="text">MailTrafficPolicy</title>
  <updated>2013-02-09T15:25:28Z</updated>
  <link rel="self" title="MailTrafficPolicy" href="MailTrafficPolicy" />
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(0)</id>
    <category term="TenantReporting.MailTrafficPolicyReport"
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(0)" />
    <title />
    <updated>2013-02-09T15:25:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
        <d:DlpPolicy>
        </d:DlpPolicy>
        <d:TransportRule>PII Detection</d:TransportRule>
        <d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(1)</id>
    <category term="TenantReporting.MailTrafficPolicyReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(1)" />
    <title />
    <updated>2013-02-09T15:25:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
        <d:DlpPolicy>
        </d:DlpPolicy>
        <d:TransportRule>PII Detection</d:TransportRule>
        <d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(2)</id>
    <category term="TenantReporting.MailTrafficPolicyReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(2)" />
    <title />
    <updated>2013-02-09T15:25:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
        <d:DlpPolicy>PII Detection</d:DlpPolicy>
        <d:TransportRule>PII Detection</d:TransportRule>
        <d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(3)</id>
    <category term="TenantReporting.MailTrafficPolicyReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(3)" />
    <title />
    <updated>2013-02-09T15:25:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
        <d:DlpPolicy>PII Detection</d:DlpPolicy>
        <d:TransportRule>PII Detection</d:TransportRule>
        <d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(4)</id>
    <category term="TenantReporting.MailTrafficPolicyReport" 
      scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <link rel="edit" title="MailTrafficPolicyReport" href="MailTrafficPolicy(4)" />
    <title />
    <updated>2013-02-09T15:25:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-01-01T00:00:00</d:Date>
        <d:DlpPolicy>PII Detection</d:DlpPolicy>
        <d:TransportRule>PII Detection</d:TransportRule>
        <d:MessageCount m:type="Edm.Int32">17</d:MessageCount>
      </m:properties>
    </content>
  </entry>
</feed>

次に同じレポート結果を JSON 形式で示します。

  {
    "d":
      {
        "results":
          [
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(0)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(0)",
                    "type":"TenantReporting.MailTrafficPolicyReport"
                  },
                "Date":"\/Date(1356998400000)\/",
                "DlpPolicy":"",
                "TransportRule":"PII Detection",
                "MessageCount":17
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(1)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(1)",
                    "type":"TenantReporting.MailTrafficPolicyReport"
                  },
                "Date":"\/Date(1356998400000)\/",
                "DlpPolicy":"",
                "TransportRule":"PII Detection",
                "MessageCount":17
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(2)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(2)",
                    "type":"TenantReporting.MailTrafficPolicyReport"
                  },
                "Date":"\/Date(1356998400000)\/",
                "DlpPolicy":"PII Detection",
                "TransportRule":"PII Detection",
                "MessageCount":17
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(3)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(3)",
                    "type":"TenantReporting.MailTrafficPolicyReport"
                  },
                "Date":"\/Date(1356998400000)\/",
                "DlpPolicy":"PII Detection",
                "TransportRule":"PII Detection",
                "MessageCount":17
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(4)",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficPolicy(4)",
                    "type":"TenantReporting.MailTrafficPolicyReport"
                  },
                "Date":"\/Date(1356998400000)\/",
                "DlpPolicy":"PII Detection",
                "TransportRule":"PII Detection",
                "MessageCount":17
              }
          ]
      }
  }

入力パラメーターとレポート出力列

フィールド表の [入力/出力] という表記には次の意味があります。

フィールド表で [入力] が付いているフィールドは、主に $filter=、$orderby= およびレポートが返すエントリを制限する他のクエリオプションで使用するためのものです。フィールド表で [入力] が付いているフィールドは、$select= オプションに含めることができ、レポートエントリに表示されますが、有用なデータは入っていません。
フィールド表で [入力/出力] が付いているフィールドは、列選択 ($select=) およびエントリ制限 ($filter= と $orderby=) オプションの両方で使用できます。これらのフィールドを $select= オプションに含めると、レポートエントリに表示され、利用可能な場合には有用なデータが入っています。

互換性

MailTrafficPolicy レポートは Office 365 サービスバージョン 2013-V1 で導入されました。バージョン管理の詳細については、「Office 365 レポート Web サービスのバージョン管理」を参照してください。

対応する Windows PowerShell コマンドレット

MailDetailSpam レポートは、Get-MailTrafficPolicyReport Windows PowerShell コマンドレットと同じ情報を返します。

権限

レポートにアクセスするアカウントには、その Office 365 組織の管理権限が必要です。このレポートを Office 365 コントロールパネルで表示できる場合、そのアカウントには REST Web サービスからデータを取得する権限があります。このレポートでは、ユーザーを参照のみ可受信者の役割に割り当てる必要があります。既定の Office 365 権限構造では、次の管理者権限があるユーザーはこのレポートにアクセスできます: 課金管理者、全体管理者、パスワード管理者、サービス管理者、ユーザー管理の管理者。

データの細分性、永続性、可用性

このレポートで使用できる情報は、各イベントの正確な日付と時刻と共に保存されます。 StartDate と EndDate フィールドを $filter オプションに含めて、ふさわしい期間や間隔を指定できます。時刻は電子メールメッセージをスキャンするサーバーのタイムゾーンで報告されます。このレポートは、AggregateBy フィールドの指定に従って、数時間または数日に渡ってメッセージ数を計算します。

このレポートの情報は、14 日間またはサブスクリプションをキャンセルするまで利用可能です。

イベントがレポートに表示されるまで、最大で 24 時間遅れる場合があります。