添加已命名项Add Named Item

使用用户的公式区域设置,将新名称添加到给定范围的集合。Adds a new name to the collection of the given scope using the user's locale for the formula.

权限Permissions

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

权限类型Permission type 权限(从最低特权到最高特权)Permissions (from least to most privileged)
委派(工作或学校帐户)Delegated (work or school account) Files.ReadWrite、Sites.Read.AllFiles.ReadWrite, Sites.Read.All
委派(个人 Microsoft 帐户)Delegated (personal Microsoft account) 不支持。Not supported.
应用程序Application Sites.Read.AllSites.Read.All

HTTP 请求HTTP request

POST /workbook/names/add
POST /workbook/worksheets({id|name})/names/add

请求标头Request headers

名称Name 说明Description
AuthorizationAuthorization Bearer {token}。必需。Bearer {token}. Required.
Workbook-Session-IdWorkbook-Session-Id 确定是否保留更改的工作簿会话 ID。可选。Workbook session Id that determines if changes are persisted or not. Optional.

请求正文Request body

在请求正文中,提供具有以下参数的 JSON 对象。In the request body, provide a JSON object with the following parameters.

参数Parameter 类型Type 说明Description
namename stringstring 已命名项的名称。The name of the named item.
referencereference JsonJson 名称将引用的公式或区域。The formula or the range that the name will refer to.
commentcomment 字符串string 与此已命名项相关联的注释。The comment associated with the named item

响应Response

如果成功, 此方法在200 OK响应正文中返回响应代码和WorkbookNamedItem对象。If successful, this method returns 200 OK response code and WorkbookNamedItem object in the response body.

示例Example

下面是一个如何调用此 API 的示例。Here is an example of how to call this API.

请求Request

下面是一个请求示例。Here is an example of the request.

POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/add
Content-type: application/json
Content-length: 54

{
  "name": "test5",
  "reference": "=Sheet1!$F$15:$N$27",
  "comment": "Comment for the named item"
}


响应Response

下面是一个响应示例。注意:为了简单起见,可能会将此处所示的响应对象截断。将从实际调用中返回所有属性。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 109

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#workbookNamedItem",
    "@odata.type": "#microsoft.graph.workbookNamedItem",
    "@odata.id": "/users('ca41eb6e-5828-486b-ab52-c3bd1f7a4047')/drive/root/workbook/names(%27test5%27)",
    "comment": "Comment for the named item",
    "name": "test5",
    "scope": "Workbook",
    "type": "Range",
    "value": "Sheet1!$F$15:$N$27",
    "visible": true
}