reportRoot: getYammerDeviceUsageUserDetail function

Пространство имен: microsoft.graph

Получение сведений об использовании устройств с Yammer с разбивкой по пользователям.

Примечание: Дополнительные сведения о различных представлениях и именах отчетов см. в статье Отчеты Microsoft 365 — использование устройств Yammer.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	❌	❌	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Reports.Read.All	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Для приложений	Reports.Read.All	Недоступно.

Примечание. Чтобы делегированные разрешения разрешали приложениям читать отчеты об использовании служб от имени пользователя, администратор клиента должен назначить пользователю соответствующую Microsoft Entra ID ограниченную роль администратора. Дополнительные сведения см. в статье Авторизация для API с целью чтения отчетов об использовании Microsoft 365.

HTTP-запрос

GET /reports/getYammerDeviceUsageUserDetail(period='{period_value}')
GET /reports/getYammerDeviceUsageUserDetail(date={date_value})

Параметры функции

В URL-адресе запроса укажите параметр запроса и действительное значение.

Параметр	Тип	Описание
period	string	Указывает отчетный период. Поддерживаемые значения {period_value}: D7, D30, D90 и D180. Эти значения указываются в формате Dn, где n — количество дней в отчетном периоде.
date	Date	Указывает дату, за которую вы хотите просмотреть пользователей, выполнивших какое-либо действие. Значение {date_value} указывается в формате ГГГГ-ММ-ДД. Так как этот отчет доступен только за последние 30 дней, значение {date_value} должно быть датой из этого диапазона.

Примечание. В URL-адресе необходимо указать либо период, либо дату.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
If-None-Match	Если этот заголовок запроса включен, а указанный eTag совпадает с текущим тегом файла, то будет возвращен код отклика 304 Not Modified. Необязательный параметр.

Отклик

В случае успешного выполнения этот метод возвращает отклик 302 Found, который перенаправляет на URL-адрес, для которого выполнена предварительная аутентификация, для скачивания отчета. Этот URL-адрес можно найти в заголовке Location отклика.

URL-адреса для скачивания, для которых выполнена предварительная аутентификация, действительны в течение нескольких минут и не требуют заголовка Authorization.

CSV-файл содержит столбцы со следующими заголовками:

• "Report Refresh Date" (Дата обновления отчета);
• "User Principal Name" (Имя участника-пользователя);
• "Display Name" (Отображаемое имя);
• "User State" (Состояние пользователя);
• "State Change Date" (Дата изменения состояния);
• "Last Activity Date" (Дата последнего действия);
• "Used Web" (Используемое веб-приложение);
• "Used Windows Phone" (Используемое устройство Windows Phone);
• "Used Android Phone" (Используемый телефон с Android);
• "Used iPhone" (Используемый телефон iPhone);
• "Used iPad" (Используемое устройство iPad);
• "Used Others" (Другое используемое);
• "Report Period" (Отчетный период).

Примеры

Пример 1. getYammerDeviceUsageUserDetail по точкам

Запрос

Ниже показан пример запроса.

HTTP

GET https://graph.microsoft.com/v1.0/reports/getYammerDeviceUsageUserDetail(period='D7')

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetYammerDeviceUsageUserDetailWithPeriod("{period}").GetAsync();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

mgc reports get-yammer-device-usage-user-detail-with-period get --period {period-id}

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
period := "{period}"
graphClient.Reports().GetYammerDeviceUsageUserDetailWithPeriod(&period).Get(context.Background(), nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getYammerDeviceUsageUserDetailWithPeriod("{period}").get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getYammerDeviceUsageUserDetail(period='D7')')
	.get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getYammerDeviceUsageUserDetailWithPeriod('{period}', )->get()->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Snippet not available

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.reports.get_yammer_device_usage_user_detail_with_period("{period}").get()

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

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,Used Web,Used Windows Phone,Used Android Phone,Used iPhone,Used iPad,Used Others,Report Period

Пример 2: getYammerDeviceUsageUserDetail по дате

Запрос

При вызове с параметром date отчет ограничивается использованием в указанную дату.

HTTP

GET https://graph.microsoft.com/v1.0/reports/getYammerDeviceUsageUserDetail(date='2018-03-05')

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetYammerDeviceUsageUserDetailWithDate(new Date(DateTime.Parse("{date}"))).GetAsync();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

mgc reports get-yammer-device-usage-user-detail-with-date get --date {date-id}

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
date := {date}
graphClient.Reports().GetYammerDeviceUsageUserDetailWithDate(&date).Get(context.Background(), nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getYammerDeviceUsageUserDetailWithDate(LocalDate.parse("{date}")).get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

Snippet not available

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getYammerDeviceUsageUserDetailWithDate(new Date('{date}'))->get()->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Reports

Get-MgReportYammerDeviceUsageUserDetail

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.reports.get_yammer_device_usage_user_detail_with_date("{date}").get()

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

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,Used Web,Used Windows Phone,Used Android Phone,Used iPhone,Used iPad,Used Others,Report Period