更新书签

Namespace：microsoft.graph.search

更新 书签 对象的属性。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	SearchConfiguration.Read.All	SearchConfiguration.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	SearchConfiguration.Read.All	SearchConfiguration.ReadWrite.All

HTTP 请求

PATCH /search/bookmarks/{bookmarksId}

请求标头

名称	说明
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type	application/json. 必需。

请求正文

在请求正文中， 仅 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值，或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

注意： 对集合属性（如关键字或类别）的任何更新将替换整个集合。

属性	类型	说明
availabilityEndDateTime	DateTimeOffset	书签停止显示为搜索结果的日期和时间。 null设置为 始终可用。 时间戳类型使用 ISO 8601 格式表示日期和时间信息，并且始终采用 UTC 格式。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。
availabilityStartDateTime	DateTimeOffset	书签开始显示为搜索结果的日期和时间。 null设置为 始终可用。 时间戳类型使用 ISO 8601 格式表示日期和时间信息，并且始终采用 UTC 格式。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。
类别	String 集合	通常用于描述此书签的类别。 例如， IT 和 HR。
说明	String	搜索结果页上显示的书签说明。 继承自 searchAnswer。
displayName	String	搜索结果中显示的书签名称。 继承自 searchAnswer。
groupIds	String collection	能够查看此书签的安全组列表。
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 响应代码。

示例

请求

以下示例显示了一个请求。

HTTP

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

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

C#

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

// Dependencies
using Microsoft.Graph.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 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

mgc search bookmarks patch --bookmark-id {bookmark-id} --body '{\
  "description": "Book a fancy vacation in Tuscany or browse museums in Florence."\
}\
'

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

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

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
bookmarks, err := graphClient.Search().Bookmarks().ByBookmarkId("bookmark-id").Patch(context.Background(), requestBody, nil)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.search.Bookmark bookmark = new com.microsoft.graph.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 文档。

JavaScript

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')
	.update(bookmark);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Search\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 文档。

PowerShell

Import-Module Microsoft.Graph.Search

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

Update-MgSearchBookmark -BookmarkId $bookmarkId -BodyParameter $params

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.search.bookmark import Bookmark
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
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