R googlesheets4 request_generate 生成 Google Sheets API 请求

使用其发现文档 (https://www.googleapis.com/discovery/v1/apis/sheets/v4/rest) 中的 Sheets API 知识生成请求。使用request_make()执行请求。相反，大多数用户应该使用更高级别的包装器来促进常见任务，例如读取或写入工作表或单元格范围。这里的函数供内部使用以及围绕 Sheets API 进行编程。

request_generate() 允许您提供最少的输入。它需要端点的昵称并且：

• 使用 API 规范查找 method 、 path 和 base_url 。

• 检查 params 端点的有效性和完整性。使用 params 进行 URL 端点替换，并将剩余参数分为用于正文的参数和用于查询的参数。

• 当且仅当 token = NULL 时，才向查询添加 API key 。

用法

request_generate(
  endpoint = character(),
  params = list(),
  key = NULL,
  token = gs4_token()
)

参数

endpoint

特点。 googlesheets4 中内置的所选 Sheets API v4 端点之一的昵称。在gs4_endpoints() 中了解更多信息。

params

点名名单。指定用于端点 URL 替换、查询或正文的参数。

key

API key 。不包含令牌的请求需要。 Google 文档“凭据、访问、安全性和身份”(https://support.google.com/googleapi/answer/6158857?hl=en&ref_topic=7013279) 解释了在没有令牌的情况下需要 API key 的情况。按照优先顺序，将参考以下来源：正式的 key 参数、params 中的 key 参数、使用 gs4_auth_configure() 设置并使用 gs4_api_key() 检索的用户配置的 API key 。

token

将其设置为 NULL 以禁止包含令牌。请注意，如果已通过 gs4_deauth() 进行身份验证 de-activated ，则 gs4_token() 实际上将返回 NULL 。

值

list()
组件有method,url,body， 和token，适合作为输入request_make().

也可以看看

例子

req <- request_generate(
  "sheets.spreadsheets.get",
  list(spreadsheetId = gs4_example("deaths")),
  key = "PRETEND_I_AM_AN_API_KEY",
  token = NULL
)
req
#> $method
#> [1] "GET"
#> 
#> $url
#> [1] "https://sheets.googleapis.com/v4/spreadsheets/1VTJjWoP1nshbyxmL9JqXgdVsimaYty21LGxxs018H2Y?key=PRETEND_I_AM_AN_API_KEY"
#> 
#> $body
#> named list()
#> 
#> $token
#> NULL
#>