ブックマークのCreate

  • [アーティクル]

名前空間: microsoft.graph.search

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

この 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 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 から継承されます。

応答

成功した場合、このメソッドは作成された 201 Created ブックマークの ID を持つ応答コードを返します。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/v1.0/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"
}