reportRoot: getYammerActivityUserDetail
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
ユーザー別の Yammer アクティビティに関する詳細を取得します。
手記： さまざまなレポート ビューと名前の詳細については、「 Microsoft 365 レポート - Yammer アクティビティ」を参照してください。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | Reports.Read.All | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | Reports.Read.All | 注意事項なし。 |
注: アプリがユーザーに代わってサービス使用状況レポートを読み取ることができるように委任されたアクセス許可の場合、テナント管理者は、ユーザーに適切なMicrosoft Entra ID制限付き管理者ロールを割り当てる必要があります。 詳細については、「 Microsoft 365 使用状況レポートを読み取るための API の承認」を参照してください。
HTTP 要求
GET /reports/getYammerActivityUserDetail(period='{period_value}')
GET /reports/getYammerActivityUserDetail(date={date_value})
関数パラメーター
要求 URL に、次のうちの 1 つのパラメーターと有効な値を指定します。
| パラメーター | 型 | 説明 |
|---|---|---|
| period | 文字列 | レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は D7、D30、D90、D180 です。 これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。 |
| date | 日付 | 何らかのアクティビティを実行したユーザーを表示する日付を指定します。 {date_value} は YYYY-MM-DD の形式にします。 このレポートは、過去 30 日間のみ利用可能であり、{date_value} はその範囲内の日付である必要があります。 |
注: URL に期間または日付を設定する必要があります。
このメソッドは、 $format、 $top、 $skipTokenOData クエリ パラメーター をサポートし、応答をカスタマイズします。 既定の出力の種類は text/csv です。 ただし、出力の種類を指定する場合は、テキスト/csv または application/json に設定された OData $format クエリ パラメーターを使用できます。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
応答
CSV
成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found 応答が返されます。 その URL は、応答の Location ヘッダー内にあります。
事前認証されたダウンロード URL は短時間 (数分) のみ有効であり、 Authorization ヘッダーは必要ありません。
この CSV ファイルには、次の列ヘッダーがあります。
- レポートの更新日
- ユーザー プリンシパル名
- 表示名
- ユーザーの状態
- 状態変更日付
- 最後のアクティビティ日付
- 投稿数
- 読み取り数
- 「いいね!」の数
- 割り当て済み製品
- レポート期間
JSON
成功した場合、このメソッドは応答コード 200 OK と応答本文に JSON オブジェクトを返します。
この要求の既定のページ サイズは 200 項目です。
例
CSV
次の例は、CSV を出力する要求を示しています。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/getYammerActivityUserDetail(period='D7')?$format=text/csv
応答
次の例は応答を示しています。
HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe
302 リダイレクトに従い、ダウンロードする CSV ファイルには次のスキーマがあります。
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Report Refresh Date,User Principal Name,Display Name,User State,State Change Date,Last Activity Date,Posted Count,Read Count,Liked Count,Assigned Products,Report Period
JSON
次の例は、JSON を返す要求を示しています。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/getYammerActivityUserDetail(period='D7')?$format=application/json
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 434
{
"value": [
{
"reportRefreshDate": "2017-09-01",
"userPrincipalName": "userPrincipalName-value",
"displayName": "displayName-value",
"userState": "active",
"stateChangeDate": "2015-08-26",
"lastActivityDate": "2017-09-01",
"postedCount": 2,
"readCount": 5,
"likedCount": 0,
"assignedProducts": [
"Microsoft 365 ENTERPRISE E5"
],
"reportPeriod": "7"
}
]
}