Обновление закладки

Статья
03/15/2024

Пространство имен: 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-запрос

PATCH /search/bookmarks/{bookmarksId}

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

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

Отклик

В случае успешного выполнения этот метод возвращает код отклика 204 No Content.

Примеры

Запрос

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

PATCH https://graph.microsoft.com/beta/search/bookmarks/733b26d5-af76-4eea-ac69-1a0ce8716897
Content-Type: application/json

{
  "description": "Book a fancy vacation in Tuscany or browse museums in Florence."
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models.Search;

var requestBody = new Bookmark
{
	Description = "Book a fancy vacation in Tuscany or browse museums in Florence.",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Search.Bookmarks["{bookmark-id}"].PatchAsync(requestBody);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta search bookmarks patch --bookmark-id {bookmark-id} --body '{\
  "description": "Book a fancy vacation in Tuscany or browse museums in Florence."\
}\
'

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelssearch "github.com/microsoftgraph/msgraph-beta-sdk-go/models/search"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodelssearch.NewBookmark()
description := "Book a fancy vacation in Tuscany or browse museums in Florence."
requestBody.SetDescription(&description) 

bookmarks, err := graphClient.Search().Bookmarks().ByBookmarkId("bookmark-id").Patch(context.Background(), requestBody, nil)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.models.search.Bookmark bookmark = new com.microsoft.graph.beta.models.search.Bookmark();
bookmark.setDescription("Book a fancy vacation in Tuscany or browse museums in Florence.");
com.microsoft.graph.models.search.Bookmark result = graphClient.search().bookmarks().byBookmarkId("{bookmark-id}").patch(bookmark);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const bookmark = {
  description: 'Book a fancy vacation in Tuscany or browse museums in Florence.'
};

await client.api('/search/bookmarks/733b26d5-af76-4eea-ac69-1a0ce8716897')
	.version('beta')
	.update(bookmark);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Bookmark;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Bookmark();
$requestBody->setDescription('Book a fancy vacation in Tuscany or browse museums in Florence.');

$result = $graphServiceClient->search()->bookmarks()->byBookmarkId('bookmark-id')->patch($requestBody)->wait();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


Import-Module Microsoft.Graph.Beta.Search

$params = @{
	description = "Book a fancy vacation in Tuscany or browse museums in Florence."
}

Update-MgBetaSearchBookmark -BookmarkId $bookmarkId -BodyParameter $params

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


from msgraph import GraphServiceClient
from msgraph.generated.models.bookmark import Bookmark

graph_client = GraphServiceClient(credentials, scopes)

request_body = Bookmark(
	description = "Book a fancy vacation in Tuscany or browse museums in Florence.",
)

result = await graph_client.search.bookmarks.by_bookmark_id('bookmark-id').patch(request_body)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

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

HTTP/1.1 204 No Content

Обновление закладки

Разрешения

HTTP-запрос

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

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

Отклик

Примеры

Запрос

Отклик

Обратная связь

Обратная связь

Дополнительные ресурсы