---
product: Chilkat
product_version: 11.7.0
language: xbase
language_label: Xbase++
class: AuthGoogle
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xbase_AuthGoogleRef.html
---
# Chilkat AuthGoogle — Xbase++ — v11.7.0

> Chilkat 11.7.0 · language=xbase · class=AuthGoogle
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/AuthGoogle.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/xbase/guide.md`.

## Purpose

**Obtain Google OAuth 2.0 access tokens using a service account.**

`Chilkat.AuthGoogle` obtains OAuth 2.0 access tokens for Google Cloud Platform APIs and Google Apps APIs using a Google service account. It supports JSON private keys and P12 private keys, OAuth scopes, optional delegated user access, custom JWT claims, access-token validity tracking, token lifetime settings, and integration with Chilkat request classes that need a Google bearer token.

**Service account auth**

Authenticate server-to-server using a Google service account rather than an interactive browser-based user consent flow.

**JSON or P12 keys**

Load service account credentials from modern JSON private keys or from legacy P12 private key files.

**Scopes and claims**

Specify the OAuth scopes required by the target Google API and add custom JWT claims when needed.

**Delegated user access**

Use domain-wide delegation by setting a subject email when the service account is authorized to act on behalf of a Google Workspace user.

**Access-token tracking**

Inspect the generated access token, expiration time, remaining lifetime, and validity state before using or refreshing credentials.

**Chilkat API integration**

Pass the resulting bearer token to Chilkat HTTP, REST, storage, mail, or other Google API request workflows.

**Common pattern:** Load the service account JSON key or P12 key, set the service account email, required `Scope`, optional delegated `SubEmailAddress`, and token lifetime, then call `ObtainAccessToken`. Use `AuthGoogle` for service-account OAuth flows; use `Chilkat.OAuth2` when the application needs an interactive three-legged OAuth flow involving a user's browser consent.

For an extended overview, see [AuthGoogle Class Overview](https://www.chilkatsoft.com/authgoogle_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```xbase
LOCAL oAuthGoogle
oAuthGoogle := CreateObject("Chilkat.AuthGoogle")

// ... use oAuthGoogle ...

oAuthGoogle:destroy()
```

Xbase++ uses the Chilkat ActiveX through the automation object returned by `CreateObject()`; properties and methods are accessed with the send operator (`oHttp:ConnectTimeout := 30`, `oHttp:Download(cUrl, cPath)`), and `:destroy()` releases the object. Register the Chilkat ActiveX matching the bitness of your Xbase++ application. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `CreateObject("Chilkat.AuthGoogle.11")` for Chilkat v11.\*.\*.

Boolean properties, arguments and return values are integers in the ActiveX: pass `1` or `0`, and test a method's success with `== 1`. A method that fails to return an object returns `NIL`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are automation objects too and should likewise be released with `:destroy()`. Methods and properties that pass or return raw byte arrays are not shown on this page; use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Xbase++.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `oAuthGoogle:DebugLogFilePath // Character` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `oAuthGoogle:LastErrorHtml // Character (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `oAuthGoogle:LastErrorText // Character (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `oAuthGoogle:LastErrorXml // Character (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `oAuthGoogle:LastMethodSuccess // Numeric` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `oAuthGoogle:LastStringResult // Character (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `oAuthGoogle:LastStringResultLen // Numeric (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `oAuthGoogle:VerboseLogging // Numeric` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `oAuthGoogle:Version // Character (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessToken` | property, read/write | `oAuthGoogle:AccessToken // Character` |
| `EmailAddress` | property, read/write | `oAuthGoogle:EmailAddress // Character` |
| `ExpireNumSeconds` | property, read/write | `oAuthGoogle:ExpireNumSeconds // Numeric` |
| `Iat` | property, read/write | `oAuthGoogle:Iat // Numeric` |
| `JsonKey` | property, read/write | `oAuthGoogle:JsonKey // Character` |
| `NumSecondsRemaining` | property, read-only | `oAuthGoogle:NumSecondsRemaining // Numeric (read-only)` |
| `Scope` | property, read/write | `oAuthGoogle:Scope // Character` |
| `SubEmailAddress` | property, read/write | `oAuthGoogle:SubEmailAddress // Character` |
| `Valid` | property, read-only | `oAuthGoogle:Valid // Numeric (read-only)` |
| `AddClaims` | method | `nSuccess := oAuthGoogle:AddClaims(oJson) // returns Numeric (1/0)` |
| `GetP12` | method | `oPfx := oAuthGoogle:GetP12() // returns ChilkatPfx` |
| `LoadTaskCaller` | method | `nSuccess := oAuthGoogle:LoadTaskCaller(oTask) // returns Numeric (1/0)` |
| `ObtainAccessToken` | method | `nSuccess := oAuthGoogle:ObtainAccessToken(oConnection) // returns Numeric (1/0)` |
| `SetP12` | method | `nSuccess := oAuthGoogle:SetP12(oKey) // returns Numeric (1/0)` |

## Properties

### AuthGoogle.AccessToken

`Chilkat 11.7.0 · xbase · AuthGoogle · AccessToken · property · read/write · since 9.5.0.58`

```xbase
oAuthGoogle:AccessToken  // Character
```

The access token to be used in Google API requests. This property is set on a successful call to ObtainAccessToken.

**Important:** This class is used for authenticating calls to the Google Cloud Platform API and Google Apps API using a **service account.**. For 3-legged OAuth2, where a browser must be used to interactively get permission from the Google account owner, use the Chilkat OAuth2 class/object.

### AuthGoogle.EmailAddress

`Chilkat 11.7.0 · xbase · AuthGoogle · EmailAddress · property · read/write · since 9.5.0.58`

```xbase
oAuthGoogle:EmailAddress  // Character
```

The client email address of the service account. If a JSON key is used, then the client_email should already be specified within the JSON key, and this property is unused. This property must be set if using a P12 key.

### AuthGoogle.ExpireNumSeconds

`Chilkat 11.7.0 · xbase · AuthGoogle · ExpireNumSeconds · property · read/write · since 9.5.0.58`

```xbase
oAuthGoogle:ExpireNumSeconds  // Numeric
```

The expiration time, in seconds, of the access token to be requested. The maximum value is 1 hour (3600 seconds). The default value is 3600.

### AuthGoogle.Iat

`Chilkat 11.7.0 · xbase · AuthGoogle · Iat · property · read/write · since 9.5.0.77`

```xbase
oAuthGoogle:Iat  // Numeric
```

This property can be set to override the default current date/time value for the `iat` claim of the JWT. It can be set to a value indicating the number of seconds from 1970-01-01T00:00:00Z UTC.

The default value is 0, which indicates to use the iat value for the current system date/time. Unless explicitly needed, always leave this property at the default value.

### AuthGoogle.JsonKey

`Chilkat 11.7.0 · xbase · AuthGoogle · JsonKey · property · read/write · since 9.5.0.58`

```xbase
oAuthGoogle:JsonKey  // Character
```

The JSON key for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

### AuthGoogle.NumSecondsRemaining

`Chilkat 11.7.0 · xbase · AuthGoogle · NumSecondsRemaining · property · read-only · since 9.5.0.58`

```xbase
oAuthGoogle:NumSecondsRemaining  // Numeric (read-only)
```

If the access token is valid, contains the number of seconds remaining until it expires. A value of 0 indicates an invalid or expired access token.

### AuthGoogle.Scope

`Chilkat 11.7.0 · xbase · AuthGoogle · Scope · property · read/write · since 9.5.0.58`

```xbase
oAuthGoogle:Scope  // Character
```

A space-delimited list of the permissions that the application requests.

### AuthGoogle.SubEmailAddress

`Chilkat 11.7.0 · xbase · AuthGoogle · SubEmailAddress · property · read/write · since 9.5.0.58`

```xbase
oAuthGoogle:SubEmailAddress  // Character
```

The email address of the user for which the application is requesting delegated access.

### AuthGoogle.Valid

`Chilkat 11.7.0 · xbase · AuthGoogle · Valid · property · read-only · since 9.5.0.58`

```xbase
oAuthGoogle:Valid  // Numeric (read-only)
```

`1` if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

## Methods

### AuthGoogle.AddClaims

`Chilkat 11.7.0 · xbase · AuthGoogle · AddClaims · method · since 9.5.0.99`

```xbase
nSuccess := oAuthGoogle:AddClaims(oJson)  // returns Numeric (1/0)
```

Adds additional custom claims to the JWT claims set.

Returns 1 for success, 0 for failure.

### AuthGoogle.GetP12

`Chilkat 11.7.0 · xbase · AuthGoogle · GetP12 · method · since 9.5.0.58`

```xbase
oPfx := oAuthGoogle:GetP12()  // returns ChilkatPfx
```

Returns the private key in a PFX (P12) object. This is only possible if the private key was previously set by calling SetP12.

Returns `NIL` on failure

### AuthGoogle.LoadTaskCaller

`Chilkat 11.7.0 · xbase · AuthGoogle · LoadTaskCaller · method · since 9.5.0.80`

```xbase
nSuccess := oAuthGoogle:LoadTaskCaller(oTask)  // returns Numeric (1/0)
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

### AuthGoogle.ObtainAccessToken

`Chilkat 11.7.0 · xbase · AuthGoogle · ObtainAccessToken · method · since 9.5.0.58`

```xbase
nSuccess := oAuthGoogle:ObtainAccessToken(oConnection)  // returns Numeric (1/0)
```

Sends the HTTP request to fetch the access token. When this method completes successfully, the access token is available in the AccessToken property. The `connection` is an existing connection to www.googleapis.com.

**Important:** Make sure your computer's date/time is accurately set to the current date/time, otherwise you'll get a 400 response status code with this error: `Invalid JWT: Token must be a short-lived token (60 minutes) and in a reasonable timeframe. Check your iat and exp values and use a clock with skew to account for clock differences between systems.`.

Returns 1 for success, 0 for failure.

Async variant: `ObtainAccessTokenAsync` — same arguments, returns a `Task` (see Async variants below).

### AuthGoogle.SetP12

`Chilkat 11.7.0 · xbase · AuthGoogle · SetP12 · method · since 9.5.0.58`

```xbase
nSuccess := oAuthGoogle:SetP12(oKey)  // returns Numeric (1/0)
```

Sets the P12 private key to be used for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

Returns 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```xbase
oTask := oAuthGoogle:ObtainAccessTokenAsync(oConnection)  // returns ChilkatTask
```

## Related classes

[`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xbase/classes/JsonObject.md), [`Pfx`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xbase/classes/Pfx.md), [`Socket`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xbase/classes/Socket.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/xbase/classes/Task.md)

