$darkmode
this class provides the REST client API for communication with Google servers More...
Public Member Functions | |
constructor (hash< auto > opts, *softbool do_not_connect) | |
creates the object with the given options More... | |
Static Public Member Functions | |
static hash< auto > | getOptions (hash< auto > opts) |
returns options for GoogleRestClient::constructor() | |
Public Attributes | |
const | ApiProfiles |
API profiles. | |
const | DefaultAuthArgs = {"access_type": "offline"} |
Default addition auth request arguments. | |
const | DefaultAuthUrl = "https://accounts.google.com/o/oauth2/v2/auth" |
Default authorization request URL. | |
const | DefaultData = "json" |
Default "data" option value. | |
const | DefaultGooglePingHeaders |
Default Google ping headers. | |
const | DefaultGooglePingMethod = "GET" |
Default Google ping method. | |
const | DefaultGrantType = "authorization_code" |
Default OAuth2 grant type. | |
const | DefaultOptions |
Default constructor options. | |
const | DefaultTokenUrl = "https://oauth2.googleapis.com/token" |
Default token request URL. | |
const | DefaultUrl = "https://www.googleapis.com" |
Default Google REST API URL. | |
this class provides the REST client API for communication with Google servers
You must use an OAuth2 token by setting the token
and oauth2_refresh_token
options; the following options need to be set as well:
oauth2_client_id:
the OAuth2 client IDoauth2_client_secret:
the OAuth2 client secretThen an external program has to guide the user through using the authorization_grant flow to get a token to use; this module does not implement that flow.
"+"
characters in URI paths as "%2B"
, as the Google API server will return a 400 Bad Request
error to requests with this character unencoded GoogleRestClient::GoogleRestClient::constructor | ( | hash< auto > | opts, |
*softbool | do_not_connect | ||
) |
creates the object with the given options
opts | valid options are all the options for the RestClient class; note that the URL is set by default if not provided (see DefaultUrl); the following options are unique to this class:
|
do_not_connect | if False (the default), then a connection will be immediately established to the remote server |
RESTCLIENT-ERROR | invalid option passed to constructor, unsupported data serialization, etc |