Поделиться через


закладка Create

Пространство имен: microsoft.graph.search

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Create новый объект закладки.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All

HTTP-запрос

POST /search/bookmarks

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление объекта закладки в формате JSON.

В следующей таблице показаны свойства, доступные при создании закладки.

Свойство Тип Описание
availabilityEndDateTime DateTimeOffset Дата и время прекращения отображения закладки в качестве результата поиска. Задайте значение null для параметра always available. Тип метки времени представляет сведения о дате и времени в формате ISO 8601 и всегда находится в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z.
availabilityStartDateTime DateTimeOffset Дата и время начала отображения закладки в качестве результата поиска. Задайте значение null для параметра always available. Тип метки времени представляет сведения о дате и времени в формате ISO 8601 и всегда находится в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z.
categories Коллекция String Категории, часто используемые для описания этой закладки. Например, IT и HR.
description String Описание закладки, которое отображается на странице результатов поиска. Наследуется от searchAnswer.
displayName String Имя закладки, отображаемое в результатах поиска. Наследуется от searchAnswer.
groupIds Коллекция строк Список групп безопасности, которые могут просматривать эту закладку.
keywords microsoft.graph.search.answerKeyword Ключевые слова, запускающие эту закладку, отображаются в результатах поиска.
languageTags Коллекция строк Список географически определенных языковых имен, на которых можно просматривать эту закладку. Каждое значение тега языка соответствует шаблону {language}-{region}. Например, является английским языкомen-us, используемым в США. Список возможных значений см. в разделе Поддерживаемые теги языка.
Платформ Коллекция microsoft.graph.devicePlatformType Список устройств и операционных систем, которые могут просматривать эту закладку. Возможные значения: android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, unknown, androidASOP, androidMobileApplicationManagement, iOSMobileApplicationManagement, unknownFutureValue.
powerAppIds Коллекция строк Список Приложений Power Apps, связанных с этой закладкой. Если пользователи добавляют существующие Приложения Power Apps в закладку, они могут выполнять задачи непосредственно на странице результатов поиска, например вводить время отпуска или отчеты о расходах.
state microsoft.graph.search.answerState Состояние закладки. Возможные значения: published, draft, excluded, unknownFutureValue.
targetedVariations коллекция microsoft.graph.search.answerVariant Варианты закладки для разных стран или устройств. Используйте, когда необходимо отобразить пользователям разное содержимое в зависимости от их устройства, страны или региона или обоих вариантов. Параметры даты и группы применяются ко всем вариантам.
webUrl String ССЫЛКА НА URL-адрес закладки. Когда пользователи выбирают эту закладку в результатах поиска, они направляются по указанному URL-адресу. Наследуется от searchAnswer.

Отклик

В случае успешного 201 Created выполнения этот метод возвращает код ответа с идентификатором созданной закладки.

Примеры

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/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"
}

Отклик

Ниже приводится пример отклика.

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

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