Compartilhar via


Criar marcador

Espaço de nomes: microsoft.graph.search

Crie um novo objeto de marcador .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All

Solicitação HTTP

POST /search/bookmarks

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON do objeto de marcador .

A tabela seguinte mostra as propriedades que estão disponíveis quando cria um marcador.

Propriedade Tipo Descrição
availabilityEndDateTime DateTimeOffset Data e hora em que o marcador deixa de aparecer como resultado da pesquisa. Defina como null para sempre disponível. O tipo de carimbo de data/hora representa informações de data e hora com o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
availabilityStartDateTime DateTimeOffset Data e hora em que o marcador começa a aparecer como um resultado de pesquisa. Defina como null para sempre disponível. O tipo de carimbo de data/hora representa informações de data e hora com o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
categories String collection Categorias normalmente utilizadas para descrever este marcador. Por exemplo, IT e HR.
description Cadeia de caracteres A descrição do marcador apresentada na página de resultados da pesquisa. Herdado de searchAnswer.
displayName Cadeia de caracteres O nome do marcador que é apresentado nos resultados da pesquisa. Herdado de searchAnswer.
groupIds Coleção de cadeias de caracteres A lista de grupos de segurança que podem ver este marcador.
palavras-chave microsoft.graph.search.answerKeyword Palavras-chave que acionam este marcador para aparecerem nos resultados da pesquisa.
languageTags String collection Uma lista de nomes de idioma geograficamente específicos nos quais este marcador pode ser visualizado. Cada valor de etiqueta de idioma segue o padrão {language}-{region}. Por exemplo, é inglês, en-us conforme utilizado nos Estados Unidos. Para obter a lista de valores possíveis, veja Etiquetas de idioma suportadas.
plataformas coleção microsoft.graph.devicePlatformType Lista de dispositivos e sistemas operativos que conseguem ver este marcador. Os valores possíveis são: android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, unknown, androidASOP, androidMobileApplicationManagement, iOSMobileApplicationManagement e unknownFutureValue.
powerAppIds Coleção String Lista de Power Apps associados a este marcador. Se os utilizadores adicionarem o Power Apps existente a um marcador, podem concluir tarefas diretamente na página de resultados da pesquisa, como introduzir o tempo de férias ou reportar despesas.
state microsoft.graph.search.answerState Estado do marcador. Os valores possíveis são: published, draft, excluded, unknownFutureValue.
targetedVariations coleção microsoft.graph.search.answerVariant Variações de um marcador para diferentes países ou dispositivos. Utilize quando precisar de mostrar conteúdos diferentes aos utilizadores com base no respetivo dispositivo, país/região ou ambos. As definições de data e grupo aplicam-se a todas as variações.
webUrl String A ligação do URL para o marcador. Quando os utilizadores selecionam este marcador nos resultados da pesquisa, são direcionados para o URL especificado. Herdado de searchAnswer.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta com o ID do marcador criado.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/search/bookmarks
Content-Type: application/json

{
  "displayName": "Contoso Install Site",
  "webUrl": "http://www.contoso.com/",
  "description": "Try or buy Contoso for Home or Business and view product information",
  "keywords":  {
    "keywords": ["Contoso", "install"],
    "reservedKeywords": ["Unique keyword"],
    "matchSimilarKeywords": true
  },
  "availabilityStartDateTime": null,
  "availabilityEndDateTime": null,
  "platforms": ["windows"],
  "targetedVariations": [
    {
      "languageTag": "es-es",
      "displayName": "Sitio de instalación Contoso",
      "description": "Pruebe o compre Contoso hogar o negocios y vea la información del producto"
    }
  ],
  "state": "published"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 201 Created
Location: /733b26d5-af76-4eea-ac69-1a0ce8716897
Content-Type: application/json

{
  "id": "733b26d5-af76-4eea-ac69-1a0ce8716897"
}