tipo de recurso userActivity

Namespace: microsoft.graph

Representa uma única atividade em um aplicativo, por exemplo, um programa de TV, um documento ou uma campanha atual em um videogame. Quando um usuário se envolve com essa atividade, o compromisso é capturado como um item de histórico que indica a hora de início e término dessa atividade. À medida que o usuário se envolve novamente com essa atividade ao longo do tempo, vários itens de histórico são registrados para uma única atividade do usuário.

Você pode usar atividades no Microsoft Graph para permitir que os usuários voltem ao que estavam fazendo em seus aplicativos, em vários dispositivos. As atividades que seu aplicativo cria aparecem nos dispositivos de todos os usuários e são expostas aos usuários como links diretos para conteúdo específico em seu aplicativo. Você pode expressar conteúdo específico em seu aplicativo como um destino exibido no Windows e acessível em dispositivos iOS e Android por meio das notificações da Cortana.

Como cada aplicativo é diferente, cabe a você entender a melhor maneira de mapear as ações em seu aplicativo para as atividades do usuário que serão exibidas na Cortana e na Linha do Tempo. Por exemplo, os jogos podem criar uma atividade para cada campanha, os aplicativos de criação de documentos podem criar uma atividade para cada documento exclusivo e os aplicativos de linha de negócios podem criar uma atividade para cada fluxo de trabalho.

Suas atividades de usuário serão exibidas nas experiências do usuário da Cortana e da Linha do Tempo do Windows, que se concentram em aumentar a produtividade e a eficiência dos usuários, ajudando-os a voltar ao conteúdo em que trabalharam no passado.

Métodos

Método Tipo de retorno Descrição
Criar ou substituir atividade userActivity Cria ou substitui uma atividade existente (upsert). A appActivityId precisa ser segura para URLs (todos os caracteres, exceto os caracteres não reservados RFC 2396, devem ser convertidos em sua representação hexadecimal), mas a appActivityId original não precisa ser segura para URLs.
Excluir atividade Sem Conteúdo Exclui a atividade especificada para esse usuário do seu aplicativo.
Obter atividades Coleção de userActivities Obtém as atividades do seu aplicativo para um determinado usuário.
Obter atividades recentes Coleção de userActivities Obtém as atividades mais recentes do seu aplicativo para um determinado usuário, classificadas e com base nos activityHistoryItems criados ou atualizados mais recentemente.

Propriedades

Nome Tipo Descrição
activationUrl Cadeia de caracteres Obrigatório. URL usada para iniciar a atividade na melhor experiência nativa representada pelo appId. Pode iniciar um aplicativo baseado na Web se não houver aplicativo nativo.
activitySourceHost Cadeia de caracteres Obrigatório. URL do domínio que representa o mapeamento de identidade multiplataforma para o aplicativo. O mapeamento é armazenado como um arquivo JSON hospedado no domínio ou configurável por meio do Centro de Desenvolvimento do Windows. O arquivo JSON é denominado cross-platform-app-identifiers e está hospedado na raiz do seu domínio HTTPS, seja no domínio de nível superior ou inclua um subdomínio. Por exemplo: https://contoso.com ou https://myapp.contoso.com, mas NÃO https://myapp.contoso.com/somepath. Você deve ter um arquivo e um domínio exclusivos (ou subdomínio) por identidade de aplicativo multiplataforma. Por exemplo, um arquivo e um domínio separados são necessários para o Word e o PowerPoint.
appActivityId Cadeia de caracteres Obrigatório. A ID de atividade exclusiva no contexto do aplicativo - fornecida pelo chamador e imutável depois disso.
appDisplayName String Opcional. Breve descrição de texto do aplicativo usado para gerar a atividade para uso nos casos em que o aplicativo não está instalado no dispositivo local do usuário.
contentInfo Objeto JSON não tipado Opcional. Um dado personalizado - descrição extensível JSON-LD do conteúdo de acordo com a sintaxe schema.org .
contentUrl String Opcional. Usado no caso em que o conteúdo pode ser renderizado fora de uma experiência de aplicativo nativo ou baseada na Web (por exemplo, um ponteiro para um item em um feed RSS).
createdDateTime DateTimeOffset Definido pelo servidor. DateTime em UTC quando o objeto foi criado no servidor.
expirationDateTime DateTimeOffset Definido pelo servidor. DateTime em UTC quando o objeto expirou no servidor.
fallbackUrl String Opcional. URL usada para iniciar a atividade em um aplicativo baseado na Web, se disponível.
id Cadeia de caracteres ID gerada pelo servidor usada para endereçamento de URL.
lastModifiedDateTime DateTimeOffset Definido pelo servidor. DateTime em UTC quando o objeto foi modificado no servidor.
status status Definido pelo servidor. Um código de status usado para identificar objetos válidos. Valores: ativo, atualizado, excluído, ignorado.
userTimezone String Opcional. O fuso horário no qual o dispositivo do usuário usado para gerar a atividade estava localizado no momento da criação da atividade; valores fornecidos como IDs Olson para dar suporte à representação entre plataformas.
visualElements visualInfo Obrigatório. O objeto que contém informações para renderizar a atividade na UX.

Relações

Relação Tipo Descrição
historyItems coleção activityHistoryItem Opcional. NavigationProperty/Containment; propriedade de navegação para os historyItems da atividade.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
    "appActivityId": "String",
    "activitySourceHost": "String (host name/domain/URL)",
    "userTimezone": "String",
    "appDisplayName": "String",
    "activationUrl": "String (URL)",
    "contentUrl": "String (URL)",
    "fallbackUrl": "String (URL)",
    "createdDateTime": "DateTimeOffset",
    "lastModifiedDateTime": "DateTimeOffset",
    "expirationDateTime": "DateTimeOffset",
    "id": "String",
    "status": "active | updated | deleted | ignored",
    "contentInfo": { "@odata.type": "microsoft.graph.Json" },
    "visualElements": { "@odata.type": "microsoft.graph.visualInfo" },
    "historyItems": [{ "@odata.type": "microsoft.graph.activityHistoryItem" }]
}
  • Last updated on