batch.admin.directory.v1: Makes a Batch API Request to the Admin SDK API

Description Usage Arguments Details See Also

View source: R/batchRequests.R

Description

Autogenerated via package_make.

Usage

1
2
3
4
5
6
7
8
9
batch.admin.directory.v1(
  requests,
  content_ids,
  gargle_token = gargle::token_fetch(),
  base_url = "https://admin.googleapis.com",
  batch_path = "batch/admin/directory/v1",
  batch_delim = "gpm_batch_delimiter",
  return_response = F
)

Arguments

requests

A list of requests to the same endpoint based on generated functions from this package. Set return_request = TRUE for the function calls.

content_ids

A list of the same length as requests with identifiers for the data returned. These will be the names of the list of results when setting return_response = FALSE.

gargle_token

A token prepared by one of gargle's token generating functions. Defaults to gargle::token_fetch(...) with appropriate scopes. See token_fetch for more info.

base_url

The base URL for the API. Defaults to 'https://admin.googleapis.com'.

batch_path

Defaults to 'batch/admin/directory/v1'. If you get a 404 error, you will need to consult the API documentation to find the correct batch path.

batch_delim

A string used to separate requests in the batch request body. Defaults to 'gpm_batch_delimiter'.

return_response

Whether to return the response or the response content. Defaults to FALSE (return response content).

Details

The server's response is a single standard HTTP response with a multipart/mixed content type; each part is the response to one of the requests in the batched request, in the same order as the requests.

See Also

Sample Gmail Batch Request Info


samterfa/gapiAdminSDK documentation built on Dec. 22, 2021, 10:11 p.m.