Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Пространство имен: microsoft.graph.search
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Создание нового объекта закладки .
Этот 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 "Всегда доступно". Тип метки времени представляет сведения о дате и времени в формате ISO 8601 и всегда в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z. |
| availabilityStartDateTime | DateTimeOffset | Дата и время начала отображения закладки в качестве результата поиска. Установите значение null "Всегда доступно". Тип метки времени представляет сведения о дате и времени в формате 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 | Ключевые слова, которые запускают появление этой закладки в результатах поиска. |
| языкТеги | Коллекция строк | Список географически определенных названий языков, в которых можно просматривать эту закладку. Каждое значение тега языка следует шаблону {language}-{region}. Например, en-us используется ли английский язык в США. Список возможных значений см. в разделе Поддерживаемые языковые теги. |
| платформы | Коллекция microsoft.graph.devicePlatformType | Список устройств и операционных систем, которые могут просматривать эту закладку. Допустимые значения: android, windows, ios, macOs, unknown. |
| 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"
}