ブックマークの作成

名前空間: microsoft.graph.search

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい ブックマーク オブジェクトを作成します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All

HTTP 要求

POST /search/bookmarks

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文には、 ブックマーク オブジェクトの 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 文字列 検索結果に表示されるブックマーク名。 searchAnswer から継承されます。
groupIds String collection このブックマークを表示できるセキュリティ グループの一覧。
keywords microsoft.graph.search.answerKeyword このブックマークを検索結果に表示するようにトリガーするキーワード。
languageTags String collection このブックマークを表示できる地理的に固有の言語名の一覧。 各言語タグの値は、{language}-{region} のパターンに従います。 たとえば、en-us は、米国で使用されている英語です。 指定できる値の一覧については、「 サポートされている言語タグ」を参照してください。
プラットフォーム microsoft.graph.devicePlatformType コレクション このブックマークを表示できるデバイスとオペレーティング システムの一覧。 使用可能な値: android、windows、ios、macOs、unknown。
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 から継承されます。

応答

成功した場合、このメソッドは作成されたブックマークの ID を含む 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"
}
  • 最終更新: