signet Create

Article
05/02/2024

Espace de noms : microsoft.graph.search

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Create un nouvel objet bookmark.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	❌	❌	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	SearchConfiguration.Read.All	SearchConfiguration.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	SearchConfiguration.Read.All	SearchConfiguration.ReadWrite.All

Requête HTTP

POST /search/bookmarks

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet bookmark .

Le tableau suivant indique les propriétés disponibles lorsque vous créez un signet.

Propriété	Type	Description
availabilityEndDateTime	DateTimeOffset	Date et heure auxquelles le signet cesse d’apparaître en tant que résultat de recherche. Définissez comme `null` pour toujours disponible. Le type d’horodatage représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : `2014-01-01T00:00:00Z`.
availabilityStartDateTime	DateTimeOffset	Date et heure auxquelles le signet commence à apparaître en tant que résultat de recherche. Définissez comme `null` pour toujours disponible. Le type d’horodatage représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : `2014-01-01T00:00:00Z`.
categories	String collection	Catégories couramment utilisées pour décrire ce signet. Par exemple, `IT` et `HR`.
description	Chaîne	Description du signet qui s’affiche sur la page des résultats de la recherche. Hérité de searchAnswer.
displayName	Chaîne	Nom du signet affiché dans les résultats de la recherche. Hérité de searchAnswer.
groupIds	String collection	Liste des groupes de sécurité qui peuvent afficher ce signet.
keywords	microsoft.graph.search.answerKeyword	Mots clés qui déclenchent l’affichage de ce signet dans les résultats de recherche.
languageTags	String collection	Liste des noms de langue spécifiques à la zone géographique dans laquelle ce signet peut être affiché. Chaque valeur de balise de langue suit le modèle {language}-{region}. Par exemple, `en-us` est l’anglais tel qu’utilisé dans le États-Unis. Pour obtenir la liste des valeurs possibles, consultez Balises de langue prises en charge.
Plates-formes	collection microsoft.graph.devicePlatformType	Liste des appareils et systèmes d’exploitation qui peuvent afficher ce signet. Les valeurs possibles sont `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `unknown`, `androidASOP`, `androidMobileApplicationManagement`, `iOSMobileApplicationManagement`, `unknownFutureValue`.
powerAppIds	Collection de chaînes	Liste des applications Power Apps associées à ce signet. Si les utilisateurs ajoutent des applications Power Apps existantes à un signet, ils peuvent effectuer des tâches directement dans la page des résultats de la recherche, telles que la saisie de congés ou la création de rapports de dépenses.
state	microsoft.graph.search.answerState	État du signet. Les valeurs possibles sont les suivantes : `published`, `draft`, `excluded`, `unknownFutureValue`.
targetedVariations	collection microsoft.graph.search.answerVariant	Variantes d’un signet pour différents pays ou appareils. Utilisez lorsque vous devez afficher un contenu différent aux utilisateurs en fonction de leur appareil, pays/région, ou les deux. Les paramètres de date et de groupe s’appliquent à toutes les variantes.
webUrl	Chaîne	Lien URL du signet. Lorsque les utilisateurs sélectionnent ce signet dans les résultats de la recherche, ils sont dirigés vers l’URL spécifiée. Hérité de searchAnswer.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse avec l’ID du signet créé.

Exemples

Demande

L’exemple suivant illustre une demande.

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


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

// Dependencies
using Microsoft.Graph.Beta.Models.Search;
using Microsoft.Graph.Beta.Models;

var requestBody = new Bookmark
{
	DisplayName = "Contoso Install Site",
	WebUrl = "http://www.contoso.com/",
	Description = "Try or buy Contoso for Home or Business and view product information",
	Keywords = new AnswerKeyword
	{
		Keywords = new List<string>
		{
			"Contoso",
			"install",
		},
		ReservedKeywords = new List<string>
		{
			"Unique keyword",
		},
		MatchSimilarKeywords = true,
	},
	AvailabilityStartDateTime = null,
	AvailabilityEndDateTime = null,
	Platforms = new List<DevicePlatformType?>
	{
		DevicePlatformType.Android,
	},
	TargetedVariations = new List<AnswerVariant>
	{
		new AnswerVariant
		{
			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 = AnswerState.Published,
};

// 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.PostAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



mgc-beta search bookmarks create --body '{\
  "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"\
}\
'

Importante



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

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

requestBody := graphmodelssearch.NewBookmark()
displayName := "Contoso Install Site"
requestBody.SetDisplayName(&displayName) 
webUrl := "http://www.contoso.com/"
requestBody.SetWebUrl(&webUrl) 
description := "Try or buy Contoso for Home or Business and view product information"
requestBody.SetDescription(&description) 
keywords := graphmodelssearch.NewAnswerKeyword()
keywords := []string {
	"Contoso",
	"install",
}
keywords.SetKeywords(keywords)
reservedKeywords := []string {
	"Unique keyword",
}
keywords.SetReservedKeywords(reservedKeywords)
matchSimilarKeywords := true
keywords.SetMatchSimilarKeywords(&matchSimilarKeywords) 
requestBody.SetKeywords(keywords)
availabilityStartDateTime := null
requestBody.SetAvailabilityStartDateTime(&availabilityStartDateTime) 
availabilityEndDateTime := null
requestBody.SetAvailabilityEndDateTime(&availabilityEndDateTime) 
platforms := []graphmodels.DevicePlatformTypeable {
	devicePlatformType := graphmodels.WINDOWS_DEVICEPLATFORMTYPE 
	requestBody.SetDevicePlatformType(&devicePlatformType)
}
requestBody.SetPlatforms(platforms)


answerVariant := graphmodelssearch.NewAnswerVariant()
languageTag := "es-es"
answerVariant.SetLanguageTag(&languageTag) 
displayName := "Sitio de instalación Contoso"
answerVariant.SetDisplayName(&displayName) 
description := "Pruebe o compre Contoso hogar o negocios y vea la información del producto"
answerVariant.SetDescription(&description) 

targetedVariations := []graphmodelssearch.AnswerVariantable {
	answerVariant,
}
requestBody.SetTargetedVariations(targetedVariations)
state := graphmodels.PUBLISHED_ANSWERSTATE 
requestBody.SetState(&state) 

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

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.models.search.Bookmark bookmark = new com.microsoft.graph.beta.models.search.Bookmark();
bookmark.setDisplayName("Contoso Install Site");
bookmark.setWebUrl("http://www.contoso.com/");
bookmark.setDescription("Try or buy Contoso for Home or Business and view product information");
com.microsoft.graph.beta.models.search.AnswerKeyword keywords = new com.microsoft.graph.beta.models.search.AnswerKeyword();
LinkedList<String> keywords1 = new LinkedList<String>();
keywords1.add("Contoso");
keywords1.add("install");
keywords.setKeywords(keywords1);
LinkedList<String> reservedKeywords = new LinkedList<String>();
reservedKeywords.add("Unique keyword");
keywords.setReservedKeywords(reservedKeywords);
keywords.setMatchSimilarKeywords(true);
bookmark.setKeywords(keywords);
bookmark.setAvailabilityStartDateTime(null);
bookmark.setAvailabilityEndDateTime(null);
LinkedList<DevicePlatformType> platforms = new LinkedList<DevicePlatformType>();
platforms.add(DevicePlatformType.Android);
bookmark.setPlatforms(platforms);
LinkedList<com.microsoft.graph.beta.models.search.AnswerVariant> targetedVariations = new LinkedList<com.microsoft.graph.beta.models.search.AnswerVariant>();
com.microsoft.graph.beta.models.search.AnswerVariant answerVariant = new com.microsoft.graph.beta.models.search.AnswerVariant();
answerVariant.setLanguageTag("es-es");
answerVariant.setDisplayName("Sitio de instalación Contoso");
answerVariant.setDescription("Pruebe o compre Contoso hogar o negocios y vea la información del producto");
targetedVariations.add(answerVariant);
bookmark.setTargetedVariations(targetedVariations);
bookmark.setState(com.microsoft.graph.beta.models.search.AnswerState.Published);
com.microsoft.graph.models.search.Bookmark result = graphClient.search().bookmarks().post(bookmark);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const bookmark = {
  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'
};

await client.api('/search/bookmarks')
	.version('beta')
	.post(bookmark);

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Search\Bookmark;
use Microsoft\Graph\Beta\Generated\Models\Search\AnswerKeyword;
use Microsoft\Graph\Beta\Generated\Models\DevicePlatformType;
use Microsoft\Graph\Beta\Generated\Models\Search\AnswerVariant;
use Microsoft\Graph\Beta\Generated\Models\Search\AnswerState;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Bookmark();
$requestBody->setDisplayName('Contoso Install Site');
$requestBody->setWebUrl('http://www.contoso.com/');
$requestBody->setDescription('Try or buy Contoso for Home or Business and view product information');
$keywords = new AnswerKeyword();
$keywords->setKeywords(['Contoso', 'install', 	]);
$keywords->setReservedKeywords(['Unique keyword', 	]);
$keywords->setMatchSimilarKeywords(true);
$requestBody->setKeywords($keywords);
$requestBody->setAvailabilityStartDateTime(null);
$requestBody->setAvailabilityEndDateTime(null);
$requestBody->setPlatforms([new DevicePlatformType('windows'),	]);
$targetedVariationsAnswerVariant1 = new AnswerVariant();
$targetedVariationsAnswerVariant1->setLanguageTag('es-es');
$targetedVariationsAnswerVariant1->setDisplayName('Sitio de instalación Contoso');
$targetedVariationsAnswerVariant1->setDescription('Pruebe o compre Contoso hogar o negocios y vea la información del producto');
$targetedVariationsArray []= $targetedVariationsAnswerVariant1;
$requestBody->setTargetedVariations($targetedVariationsArray);

$requestBody->setState(new AnswerState('published'));

$result = $graphServiceClient->search()->bookmarks()->post($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Search

$params = @{
	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"
}

New-MgBetaSearchBookmark -BodyParameter $params

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.search.bookmark import Bookmark
from msgraph_beta.generated.models.search.answer_keyword import AnswerKeyword
from msgraph_beta.generated.models.device_platform_type import DevicePlatformType
from msgraph_beta.generated.models.search.answer_variant import AnswerVariant
from msgraph_beta.generated.models.answer_state import AnswerState
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Bookmark(
	display_name = "Contoso Install Site",
	web_url = "http://www.contoso.com/",
	description = "Try or buy Contoso for Home or Business and view product information",
	keywords = AnswerKeyword(
		keywords = [
			"Contoso",
			"install",
		],
		reserved_keywords = [
			"Unique keyword",
		],
		match_similar_keywords = True,
	),
	availability_start_date_time = None,
	availability_end_date_time = None,
	platforms = [
		DevicePlatformType.Android,
	],
	targeted_variations = [
		AnswerVariant(
			language_tag = "es-es",
			display_name = "Sitio de instalación Contoso",
			description = "Pruebe o compre Contoso hogar o negocios y vea la información del producto",
		),
	],
	state = AnswerState.Published,
)

result = await graph_client.search.bookmarks.post(request_body)

Importante

Réponse

L’exemple suivant illustre la réponse.

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

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

Partager via

signet Create

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemples

Demande

Réponse

Commentaires

Ressources supplémentaires