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
#>