Comentários Editar

reportRoot: getM365AppUserDetail

  • Artigo
  • 7 minutos para o fim da leitura

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Obtenha um relatório que forneça os detalhes sobre quais aplicativos e plataformas os usuários usaram.

Nota: Para obter detalhes sobre diferentes exibições de relatório e nomes, consulte relatórios do Microsoft 365 – Microsoft 365 Apps uso.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante) Reports.Read.All
Delegada (conta pessoal da Microsoft) Sem suporte.
Aplicativo Reports.Read.All

Nota: Para permissões delegadas para permitir que os aplicativos leiam relatórios de uso do serviço em nome de um usuário, o administrador do locatário deve ter atribuído ao usuário a função de administrador Azure AD limitada apropriada. Para saber mais, confira Autorização para APIs lerem os relatórios de uso do Microsoft 365.

Solicitação HTTP

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

Parâmetros de função

Na URL da solicitação, forneça um valor válido ao seguinte parâmetro.

Parâmetro Tipo Descrição
ponto cadeia de caracteres Especifica o período de tempo durante o qual o relatório é agregado. Os valores com suporte para {period_value} são: D7, D30, D90e D180. Eles seguem o formato D n, em que n representa o número de dias em que o relatório é agregado.
data Data Especifica a data para a qual você deseja visualizar os usuários que realizaram qualquer atividade. {date_value} deve ter um formato de AAAA-MM-DD. Como este relatório está disponível apenas para os últimos 30 dias, {date_value} deve ser uma data desse intervalo.

Nota: Você precisa definir um ou period na date URL.

Parâmetros de consulta opcionais

Este método oferece suporte aos Parâmetros de consulta OData $format, $top e $skipToken para personalizar as resposta. O tipo de saída padrão é text/csv. No entanto, se você quiser especificar o tipo de saída, poderá usar o parâmetro de consulta OData $format para definir a saída padrão como text/csv ou application/json.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório.

Corpo da solicitação

Não forneça um corpo de solicitação com esse método.

Resposta

Se tiver êxito, este método retornará um 200 OK código de resposta e um objeto Edm.Stream no corpo da resposta.

CSV

Se for bem-sucedido, este método retorna uma resposta 302 Found que redireciona para uma URL de download pré-autenticada para o relatório. Essa URL pode ser encontrada no cabeçalho Location na resposta.

As URLs de download previamente autenticadas são válidas apenas por um curto período de tempo (alguns minutos) e não exigem um cabeçalho Authorization.

O arquivo CSV possui os seguintes cabeçalhos para colunas:

  • Data de atualização do relatório
  • Nome UPN
  • Data da Última Ativação
  • Data da última atividade
  • Período de Relatório
  • Windows
  • Mac
  • Celular
  • Web
  • Outlook
  • Word
  • Excel
  • PowerPoint
  • OneNote
  • Teams
  • Outlook (Windows)
  • Word (Windows)
  • Excel (Windows)
  • PowerPoint (Windows)
  • OneNote (Windows)
  • Teams (Windows)
  • Outlook (Mac)
  • Word (Mac)
  • Excel (Mac)
  • PowerPoint (Mac)
  • OneNote (Mac)
  • Teams (Mac)
  • Outlook (Móvel)
  • Word (Móvel)
  • Excel (Móvel)
  • PowerPoint (Móvel)
  • OneNote (Móvel)
  • Teams (Móvel)
  • Outlook (Web)
  • Word (Web)
  • Excel (Web)
  • PowerPoint (Web)
  • OneNote (Web)
  • Teams (Web)

JSON

Se bem-sucedido, este método retorna um código 200 OK de resposta e um objeto JSON no corpo da resposta.

O tamanho de página padrão para essa solicitação é de 200 itens.

Exemplos

Exemplo 1: saída CSV

A seguir está um exemplo que gera CSV.

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/reports/getM365AppUserDetail(period='D7')?$format=text/csv

Resposta

Este é um exemplo de resposta.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

Siga o redirecionamento 302 e o arquivo CSV baixado terá o seguinte esquema.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,User Principal Name,Last Activation Date,Last Activity Date,Report Period,Windows,Mac,Mobile,Web,Outlook,Word,Excel,PowerPoint,OneNote,Teams,Outlook (Windows),Word (Windows),Excel (Windows),PowerPoint (Windows),OneNote (Windows),Teams (Windows),Outlook (Mac),Word (Mac),Excel (Mac),PowerPoint (Mac),OneNote (Mac),Teams (Mac),Outlook (Mobile),Word (Mobile),Excel (Mobile),PowerPoint (Mobile),OneNote (Mobile),Teams (Mobile),Outlook (Web),Word (Web),Excel (Web),PowerPoint (Web),OneNote (Web),Teams (Web)

Exemplo 2: saída JSON

A seguir está um exemplo que retorna JSON.

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/reports/getM365AppUserDetail(period='D7')?$format=application/json

Resposta

Este é um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 951

{
  "@odata.nextLink": "https://graph.microsoft.com/beta/reports/getM365AppUserDetail(period='D7')?$format=application/json&$skiptoken=AAAAA",
  "value": [
    {
      "reportRefreshDate": "2020-06-30",
      "userPrincipalName": "admin@contoso.com",
      "lastActivationDate": "2020-05-22",
      "lastActivityDate": "2020-06-30",
      "details": [
        {
          "reportPeriod": 7,
          "windows": true,
          "mac": false,
          "mobile": true,
          "web": false,
          "outlook": false,
          "word": false,
          "excel": false,
          "powerPoint": false,
          "oneNote": false,
          "teams": true,
          "outlookWindows": false,
          "wordWindows": false,
          "excelWindows": false,
          "powerPointWindows": false,
          "oneNoteWindows": false,
          "teamsWindows": true,
          "outlookMac": false,
          "wordMac": false,
          "excelMac": false,
          "powerPointMac": false,
          "oneNoteMac": false,
          "teamsMac": false,
          "outlookMobile": false,
          "wordMobile": false,
          "excelMobile": false,
          "powerPointMobile": false,
          "oneNoteMobile": false,
          "teamsMobile": true,
          "outlookWeb": false,
          "wordWeb": false,
          "excelWeb": false,
          "powerPointWeb": false,
          "oneNoteWeb": false,
          "teamsWeb": true
        }
      ]
    }
  ]
}