名前空間: microsoft.graph.search
ブックマーク オブジェクトのプロパティを更新します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
❌ |
❌ |
❌ |
アクセス許可
この 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 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| availabilityStartDateTime |
DateTimeOffset |
ブックマークが検索結果として表示され始める日時。 常に使用可能な null として設定します。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 |
| categories |
String collection |
このブックマークの説明に一般的に使用されるカテゴリ。 たとえば、IT および HR などです。 |
| 説明 |
String |
検索結果ページに表示されるブックマークの説明。
searchAnswer から継承されます。 |
| displayName |
String |
検索結果に表示されるブックマーク名。
searchAnswer から継承されます。 |
| groupIds |
String collection |
このブックマークを表示できるセキュリティ グループの一覧。 |
| keywords |
microsoft.graph.search.answerKeyword |
このブックマークをトリガーするキーワードが検索結果に表示されます。 |
| languageTags |
String collection |
このブックマークを表示できる地理的に固有の言語名の一覧。 各言語タグの値は、パターン {language}-{region}に従います。 たとえば、en-usは、米国で使用される英語です。 使用可能な値の一覧については、「 サポートされている言語タグ」を参照してください。 |
| プラットフォーム |
microsoft.graph.devicePlatformType コレクション |
このブックマークを表示できるデバイスとオペレーティング システムの一覧。 可能な値は、android、androidForWork、ios、macOS、windowsPhone81、windowsPhone81AndLater、windows10AndLater、androidWorkProfile、unknown、androidASOP、androidMobileApplicationManagement、iOSMobileApplicationManagement、unknownFutureValue です。 |
| powerAppIds |
String collection |
このブックマークに関連付けられている 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/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."
}
// 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 のドキュメントを参照してください。
mgc search bookmarks patch --bookmark-id {bookmark-id} --body '{\
"description": "Book a fancy vacation in Tuscany or browse museums in Florence."\
}\
'
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// 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 のドキュメントを参照してください。
// 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 のドキュメントを参照してください。
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
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 のドキュメントを参照してください。
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 のドキュメントを参照してください。
# 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