type de ressource classeur

Article
03/15/2023

Espace de noms: microsoft.graph

Objet de niveau supérieur qui contient les objets de classeur associés tels que les feuilles de calcul, les tableaux, les plages, etc.

Méthodes

Méthode	Type renvoyé	Description
Créer	workbookSessionInfo	Créez une session de classeur pour démarrer une session permanente ou non permanente.
Fermer la session	Aucun	Fermez une session existante.
Actualiser la session	Aucun	Actualisez une session existante.

Propriétés

Aucune.

Relations

Relation	Type	Description
commentaires	collection workbookComment	Représente une collection de commentaires dans un classeur.
noms	Collection workbookNamedItem	Représente une collection d’éléments nommés délimités aux classeurs (plages et constantes nommées). En lecture seule.
opérations	Collection workbookOperation	État des opérations du classeur. La récupération d’une collection d’opérations n’est pas prise en charge, mais vous pouvez récupérer l’état d’une opération longue si l’en-tête `Location` est renvoyé dans la réponse. Lecture seule.
tableaux	Collection WorkbookTable	Représente une collection de tableaux associés au classeur. En lecture seule.
feuilles de calcul	Collection WorkbookWorksheet	Représente une collection de feuilles de calcul associées au classeur. En lecture seule.

Fonctions

Fonctions Excel : Appellent une fonction de classeur en utilisant la syntaxe POST /me/drive/root/workbook/functions/{function-name} et en fournissant les arguments de fonction dans le corps à l’aide d’un objet JSON. L’élément value résultant de la fonction et les chaînes error sont renvoyés dans l’objet de résultat de la fonction. La valeur error « null » indique que la fonction a été exécutée.

La liste complète des fonctions prises en charge est disponible ici. Reportez-vous à la signature de fonction pour les types de données et les noms de paramètres spécifiques.

Remarques importantes :

Le paramètre d’entrée de plage est fourni à l’aide d’un objet de plage au lieu de la chaîne d’adresse de plage.
Le paramètre d’index est indexé sur 1 contrairement à l’index 0 utilisé dans la plupart des API.

Exemple : vlookup

Dans une feuille de calcul Excel, la fonction vlookup accepte les arguments suivants :

La valeur que vous souhaitez rechercher, également appelée valeur de recherche.
La plage dans laquelle se trouve la valeur de recherche. N’oubliez pas que la valeur de recherche doit toujours apparaître dans la première colonne de la plage pour que RECHERCHEV fonctionne correctement. Par exemple, si la valeur de recherche se trouve dans la cellule C2, votre plage doit commencer par C.
Le numéro de colonne dans la plage qui contient la valeur renvoyée. Par exemple, si vous spécifiez la plage B2:D11, vous devez compter B comme la première colonne, C comme la deuxième, et ainsi de suite.
Si vous le souhaitez, vous pouvez spécifier TRUE pour obtenir une correspondance approximative ou FALSE pour obtenir une correspondance exacte par rapport à la valeur renvoyée. Si vous n’indiquez rien, la valeur par défaut sera toujours TRUE, soit une correspondance approximative.

Dans une cellule, la fonction vlookup se présente comme suit :

=RECHERCHEV (valeur de recherche, plage contenant la valeur de recherche, numéro de colonne dans la plage contenant la valeur renvoyée, éventuellement spécifier TRUE pour obtenir une correspondance approximative ou FALSE pour une correspondance exacte)

(Consultez la documentation relative à la fonction RECHERCHEV dans Excel.)

L’exemple ci-dessous indique comment appeler la fonction vlookup et comment transmettre ces paramètres avec l’API REST Excel.

Demande :

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/vlookup
content-type: Application/Json 
authorization: Bearer {access-token} 
workbook-session-id: {session-id}

{
    "lookupValue": "Temperature",
    "tableArray": { "Address": "Sheet1!E1:G5" },
    "colIndexNum": 2,
    "rangeLookup": false
}

Réponse :

HTTP code: 200 OK
content-type: application/json;odata.metadata 

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
    "@odata.type": "#microsoft.graph.workbookFunctionResult",
    "@odata.id": "/users('f6d92604-4b76-4b70-9a4c-93dfbcc054d5')/drive/root/workbook/functions/vlookup()",
    "error": null,
    "value": "28.3"
}

Exemple : median

Dans une feuille de calcul Excel, la fonction median accepte une matrice d’une ou plusieurs plages d’entrées.

Dans une cellule, la fonction median se présente comme dans cet exemple :

=MEDIAN(A2:A6)

(Consultez la documentation relative à la fonction MEDIANE dans Excel.)

L’exemple ci-dessous indique comment appeler la fonction median, ainsi qu’une ou plusieurs plages d’entrées avec l’API REST Excel.

Demande :

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/median
content-type: Application/Json 
authorization: Bearer {access-token} 
workbook-session-id: {session-id}

{
   "values":[
      {
         "address":"Sheet2!A1:A5"
      },
      {
         "address":"Sheet2!B1:B5"
      }
   ]
}

Réponse :

HTTP code: 200 OK
content-type: application/json;odata.metadata 

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
  "@odata.type": "#microsoft.graph.workbookFunctionResult",
  "@odata.id": "/users('2abcad6a-2fca-4b6e-9577-e358a757d77d')/drive/root/workbook/functions/median()",
  "error": null,
  "value": 30
}

Représentation JSON

{
  "names": [{"@odata.type": "microsoft.graph.workbookNamedItem"}],
  "tables": [{"@odata.type": "microsoft.graph.workbookTable"}],
  "worksheets": [{"@odata.type": "microsoft.graph.workbookWorksheet"}]
}

Partager via