Global

projectId

string

Yes

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

keyFilename

string

Yes

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.

email

string

Yes

Account email address. Required when using a .pem or .p12 keyFilename.

credentials

object

Yes

Credentials object.

Values in credentials have the following properties:

autoRetry

boolean

Yes

Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.

Defaults to true.

maxRetries

number

Yes

Maximum number of automatic retries attempted before returning the error.

Defaults to 3.

promise

Constructor

Yes

Custom promise module to use instead of native Promises.

apiEndpoint

string

Yes

The API endpoint of the service used to make requests. Defaults to www.googleapis.com