Partilhar via


activityHistoryItem tipo de recurso

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 Versão.

Representa um item de histórico para uma atividade numa aplicação. As atividades de utilizador representam um único destino na sua aplicação; por exemplo, um programa de TV, um documento ou uma campanha atual num videojogo. Quando um utilizador interage com essa atividade, o compromisso é capturado como um item de histórico que indica a hora de início e de fim dessa atividade. À medida que o utilizador interage novamente com essa atividade ao longo do tempo, são registados vários itens do histórico para uma única atividade de utilizador.

Quando uma aplicação cria uma sessão, deve ser adicionado um objeto activityHistoryItem ao objeto de atividade para refletir o período de envolvimento do utilizador. Sempre que um utilizador interage novamente com uma atividade, é adicionada uma nova atividadeHistoryItem à atividade para acumular o envolvimento do utilizador.

Métodos

Método Tipo de retorno Descrição
Criar ou substituir um item do histórico activityHistoryItem Crie ou substitua uma atividade existenteHistoryItem para essa atividade (upsert). O ID tem de ser um GUID.
Excluir um item do histórico Sem Conteúdo Elimine o activityHistoryItem especificado para essa atividade.

Propriedades

Nome Tipo Descrição
status cadeia de caracteres Definido pelo servidor. Um código de estado utilizado para identificar objetos válidos. Valores: ativo, atualizado, eliminado, ignorado.
userTimezone String Opcional. O fuso horário no qual o dispositivo do utilizador utilizado para gerar a atividade estava localizado no momento da criação da atividade. Valores fornecidos como IDs olson para suportar a representação entre plataformas.
createdDateTime DateTimeOffset Definido pelo servidor. DateTime em UTC quando o objeto foi criado no servidor.
lastModifiedDateTime DateTimeOffset Definido pelo servidor. DateTime em UTC quando o objeto foi modificado no servidor.
id Cadeia de caracteres Obrigatório. GUID de conjunto de cliente para o objeto activityHistoryItem .
startedDateTime DateTimeOffset Obrigatório. UTC DateTime quando a activityHistoryItem (sessão de atividade) foi iniciada. Necessário para o histórico da linha cronológica.
lastActiveDateTime DateTimeOffset Opcional. UTC DateTime quando activityHistoryItem (sessão de atividade) foi entendido pela última vez como ativo ou concluído – se nulo, o estado activityHistoryItem deve ser Contínuo.
expirationDateTime DateTimeOffset Opcional. UTC DateTime quando a activityHistoryItem será submetida a uma eliminação difícil. Pode ser definido pelo cliente.
activeDurationSeconds int Opcional. A duração do envolvimento do utilizador ativo. se não for fornecido, é calculado a partir de startedDateTime e lastActiveDateTime.

Relações

Relação Tipo Descrição
atividade userActivity Opcional. NavigationProperty/Containment; propriedade de navegação para a atividade associada.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
    "activeDurationSeconds":"int",
    "createdDateTime": "DateTimeOffset",
    "expirationDateTime": "DateTimeOffset",
    "id": "String",
    "lastActiveDateTime": "DateTimeOffset",
    "lastModifiedDateTime": "DateTimeOffset",
    "startedDateTime": "DateTimeOffset",
    "status": "String",
    "userTimezone": "String"
}