Textmarke erstellen

Namespace: microsoft.graph.search

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues Lesezeichenobjekt .

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ❌ ❌ ❌

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application SearchConfiguration.Read.All SearchConfiguration.ReadWrite.All

HTTP-Anforderung

POST /search/bookmarks

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des Lesezeichenobjekts an.

Die folgende Tabelle zeigt die Eigenschaften, die beim Erstellen eines Lesezeichens verfügbar sind.

Eigenschaft Typ Beschreibung
availabilityEndDateTime DateTimeOffset Datum und Uhrzeit, zu der das Lesezeichen nicht mehr als Suchergebnis angezeigt wird. null Als "immer verfügbar" festlegen. Der Zeitstempeltyp stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und wird immer in UTC angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z.
VerfügbarkeitStartDatumUhrzeit DateTimeOffset Datum und Uhrzeit, zu dem das Lesezeichen als Suchergebnis angezeigt wird. null Als "immer verfügbar" festlegen. Der Zeitstempeltyp stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und wird immer in UTC angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z.
categories String collection Kategorien, die häufig verwendet werden, um diese Textmarke zu beschreiben. Beispielsweise IT und HR.
description Zeichenfolge Die Lesezeichenbeschreibung, die auf der Suchergebnisseite angezeigt wird. Geerbt von searchAnswer.
displayName Zeichenfolge Der Name des Lesezeichens, der in den Suchergebnissen angezeigt wird. Geerbt von searchAnswer.
groupIds Zeichenfolgenauflistung Die Liste der Sicherheitsgruppen, die dieses Lesezeichen anzeigen können.
"keywords" microsoft.graph.search.answerKeyword Schlüsselwörter, die die Anzeige dieser Textmarke in den Suchergebnissen auslösen.
languageTags String collection Eine Liste der Namen für geographisch spezifische Sprachen, in denen dieses Lesezeichen angezeigt werden kann. Jeder Wert eines Sprachtags folgt dem Muster {language}-{region}. Beispielsweise ist Englisch, en-us wie es in den USA verwendet wird. Die Liste der möglichen Werte finden Sie unter Unterstützte Sprachtags.
Plattformen microsoft.graph.devicePlatformType-Auflistung Liste der Geräte und Betriebssysteme, die dieses Lesezeichen anzeigen können. Mögliche Werte sind: android, windows, ios, macOs, unknown.
powerAppIds String collection Liste der Power Apps, die dieser Textmarke zugeordnet sind. Wenn Benutzer einem Lesezeichen vorhandene Power Apps hinzufügen, können sie Aufgaben direkt auf der Suchergebnisseite erledigen, z. B. die Eingabe von Urlaubszeiten oder die Berichterstattung von Ausgaben.
state microsoft.graph.search.answerState Status der Textmarke. Mögliche Werte sind: published, draft, excluded, unknownFutureValue.
targetedVariations microsoft.graph.search.answerVariant-Auflistung Variationen eines Lesezeichens für verschiedene Länder/Regionen oder Geräte. Verwenden Sie diese Option, wenn Sie Benutzern je nach Gerät, Land/Region unterschiedlich Inhalte anzeigen müssen. Die Datums- und Gruppeneinstellungen gelten für alle Variationen.
webUrl Zeichenfolge Der URL-Link für die Textmarke. Wenn Benutzer dieses Lesezeichen in den Suchergebnissen auswählen, werden sie zu der angegebenen URL weitergeleitet. Geerbt von searchAnswer.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 201 Created Antwortcode mit der ID des erstellten Lesezeichens zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 201 Created
Location: /733b26d5-af76-4eea-ac69-1a0ce8716897
Content-Type: application/json

{
  "id": "733b26d5-af76-4eea-ac69-1a0ce8716897"
}