Compartilhar via

tipo de recurso userActivity

  • Artigo

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 uma única atividade numa 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.

Pode utilizar atividades no Microsoft Graph para permitir que os utilizadores voltem ao que estavam a fazer na respetiva aplicação, em vários dispositivos. As atividades que a sua aplicação cria são apresentadas nos dispositivos de todos os utilizadores e são expostas aos utilizadores como ligações avançadas para conteúdos específicos na sua aplicação. Pode expressar conteúdos específicos na sua aplicação como um destino apresentado no Windows e acessível em dispositivos iOS e Android através de notificações da Cortana.

Uma vez que cada aplicação é diferente, cabe-lhe a si compreender a melhor forma de mapear ações na sua aplicação para atividades de utilizador que serão apresentadas na Cortana e na Linha Cronológica. Por exemplo, os jogos podem criar uma atividade para cada campanha, as aplicações de criação de documentos podem criar uma atividade para cada documento exclusivo e as aplicações de linha de negócio podem criar uma atividade para cada fluxo de trabalho.

As suas atividades de utilizador serão apresentadas nas experiências de utilizador da Cortana e da Linha Cronológica do Windows, que se focam no aumento da produtividade e eficiência dos utilizadores, ajudando-os a regressar aos conteúdos em que trabalharam no passado.

Métodos

Método Tipo de retorno Descrição
Criar ou substituir uma atividade userActivity Cria ou substitui uma atividade existente (upsert). O appActivityId tem de ser seguro para URLs (todos os carateres exceto os carateres não servidos RFC 2396 têm de ser convertidos para a sua representação hexadecimal), mas o appActivityId original não tem de ser seguro para URL.
Excluir atividade Sem Conteúdo Elimina a atividade especificada para esse utilizador da sua aplicação.
Obter atividades Coleção de userActivity Obtém as atividades da sua aplicação para um determinado utilizador.
Obter atividades recentes Coleção de userActivity Obtém as atividades mais recentes da sua aplicação para um determinado utilizador, ordenadas e baseadas na atividade mais recentemente criada ou atualizadaHistoryItems.

Propriedades

Nome Tipo Descrição
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 ID gerado pelo servidor utilizado para endereçamento de URL.
appActivityId Cadeia de caracteres Obrigatório. O ID de atividade exclusivo no contexto da aplicação - fornecido pelo autor da chamada e imutável posteriormente.
activitySourceHost Cadeia de caracteres Obrigatório. URL do domínio que representa o mapeamento de identidades entre plataformas para a aplicação. O mapeamento é armazenado como um ficheiro JSON alojado no domínio ou configurável através do Windows Dev Center. O ficheiro JSON tem o nome cross-platform-app-identifiers e está alojado 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. Tem de ter um ficheiro e domínio exclusivos (ou subdomínio) por identidade de aplicação entre plataformas. Por exemplo, é necessário um ficheiro e domínio separados para Word vs. PowerPoint.
appDisplayName String Opcional. Breve descrição de texto da aplicação utilizada para gerar a atividade para utilização nos casos em que a aplicação não está instalada no dispositivo local do utilizador.
activationUrl Cadeia de caracteres Obrigatório. URL utilizado para iniciar a atividade na melhor experiência nativa representada pelo appId. Poderá iniciar uma aplicação baseada na Web se não existir nenhuma aplicação nativa.
fallbackUrl String Opcional. URL utilizado para iniciar a atividade numa aplicação baseada na Web, se disponível.
contentUrl String Opcional. Utilizado no caso de o conteúdo poder ser composto fora de uma experiência de aplicação nativa ou baseada na Web (por exemplo, um ponteiro para um item num feed RSS).
elementos visuais visualInfo Obrigatório. O objeto que contém informações para compor a atividade na EXPERIÊNCIA.
contentInfo Objeto JSON não escrito Opcional. Uma parte personalizada dos dados – descrição extensível JSON-LD do conteúdo de acordo com schema.org sintaxe.
expirationDateTime DateTimeOffset Definido pelo servidor. DateTime em UTC quando o objeto expirou no servidor.
status cadeia de caracteres Definido pelo servidor. Um código de status utilizado para identificar objetos válidos. Valores: ativo, atualizado, eliminado, ignorado.

Relações

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

Representação JSON

A representação JSON seguinte 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": "string",
    "contentInfo": { "@data.type": "microsoft.graph.Json" },
    "visualElements": { "@data.type": "microsoft.graph.visualInfo" },
    "historyItems": [{ "@odata.type": "microsoft.graph.activityHistoryItem" }]
}