---
product: Chilkat
product_version: 11.7.0
language: xojo
language_label: Xojo
class: AuthGoogle
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xojoAuthGoogleRef.html
---
# Chilkat AuthGoogle — Xojo — v11.7.0

> Chilkat 11.7.0 · language=xojo · 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/xojo/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**

```xojo
Dim authGoogle As New Chilkat.AuthGoogle
```

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 Xojo.

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` | `DebugLogFilePath As String` | 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` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessToken` | property, read/write | `AccessToken As String` |
| `EmailAddress` | property, read/write | `EmailAddress As String` |
| `ExpireNumSeconds` | property, read/write | `ExpireNumSeconds As Int32` |
| `Iat` | property, read/write | `Iat As Int32` |
| `JsonKey` | property, read/write | `JsonKey As String` |
| `NumSecondsRemaining` | property, read-only | `NumSecondsRemaining As Int32 (read-only)` |
| `Scope` | property, read/write | `Scope As String` |
| `SubEmailAddress` | property, read/write | `SubEmailAddress As String` |
| `Valid` | property, read-only | `Valid As Boolean (read-only)` |
| `AddClaims` | method | `Function AddClaims(json As Chilkat.JsonObject) As Boolean` |
| `GetP12` | method | `Function GetP12() As Chilkat.Pfx` |
| `LoadTaskCaller` | method | `Function LoadTaskCaller(task As Chilkat.Task) As Boolean` |
| `ObtainAccessToken` | method | `Function ObtainAccessToken(connection As Chilkat.Socket) As Boolean` |
| `SetP12` | method | `Function SetP12(key As Chilkat.Pfx) As Boolean` |

## Properties

### AuthGoogle.AccessToken

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

```xojo
AccessToken As String
```

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 · xojo · AuthGoogle · EmailAddress · property · read/write · since 9.5.0.58`

```xojo
EmailAddress As String
```

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 · xojo · AuthGoogle · ExpireNumSeconds · property · read/write · since 9.5.0.58`

```xojo
ExpireNumSeconds As Int32
```

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 · xojo · AuthGoogle · Iat · property · read/write · since 9.5.0.77`

```xojo
Iat As Int32
```

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 · xojo · AuthGoogle · JsonKey · property · read/write · since 9.5.0.58`

```xojo
JsonKey As String
```

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 · xojo · AuthGoogle · NumSecondsRemaining · property · read-only · since 9.5.0.58`

```xojo
NumSecondsRemaining As Int32 (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 · xojo · AuthGoogle · Scope · property · read/write · since 9.5.0.58`

```xojo
Scope As String
```

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

### AuthGoogle.SubEmailAddress

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

```xojo
SubEmailAddress As String
```

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

### AuthGoogle.Valid

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

```xojo
Valid As Boolean (read-only)
```

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

## Methods

### AuthGoogle.AddClaims

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

```xojo
Function AddClaims(json As Chilkat.JsonObject) As Boolean
```

Adds additional custom claims to the JWT claims set.

Returns True for success, False for failure.

### AuthGoogle.GetP12

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

```xojo
Function GetP12() As Chilkat.Pfx
```

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 · xojo · AuthGoogle · LoadTaskCaller · method · since 9.5.0.80`

```xojo
Function LoadTaskCaller(task As Chilkat.Task) As Boolean
```

Loads the caller of the task's async method.

Returns True for success, False for failure.

### AuthGoogle.ObtainAccessToken

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

```xojo
Function ObtainAccessToken(connection As Chilkat.Socket) As Boolean
```

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 True for success, False for failure.

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

### AuthGoogle.SetP12

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

```xojo
Function SetP12(key As Chilkat.Pfx) As Boolean
```

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 True for success, False for failure.

## Events and callbacks

In Xojo, Chilkat events are handled by subclassing. Add a new class to your project that inherits from Chilkat.AuthGoogle, then override the event methods you want to respond to. Any method you don't override keeps its default do-nothing behavior, so you only need to write the ones you actually care about.

From that point on, create and use an instance of your subclass wherever you would have used a Chilkat.AuthGoogle. The events fire on your instance automatically as the object does its work.

**For example:**

```vb
class MyAuthGoogle
    Inherits Chilkat.AuthGoogle

    Function AbortCheck() As Boolean
    Function PercentDone(pctDone As Int32) As Boolean
    Sub ProgressInfo(name As String, value As String)
    Sub TaskCompleted(task As Chilkat.Task)

End Class
```

### AuthGoogle.AbortCheck (event)

`Chilkat 11.7.0 · xojo · AuthGoogle · AbortCheck · event`

```xojo
Function AbortCheck() As Boolean
```

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

### AuthGoogle.PercentDone (event)

`Chilkat 11.7.0 · xojo · AuthGoogle · PercentDone · event`

```xojo
Function PercentDone(pctDone As Int32) As Boolean
```

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the `abort` output argument to `True`. This will cause the method to terminate and return a failure status or corresponding failure value.

### AuthGoogle.ProgressInfo (event)

`Chilkat 11.7.0 · xojo · AuthGoogle · ProgressInfo · event`

```xojo
Sub ProgressInfo(name As String, value As String)
```

This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

### AuthGoogle.TaskCompleted (event)

`Chilkat 11.7.0 · xojo · AuthGoogle · TaskCompleted · event`

```xojo
Sub TaskCompleted(task As Chilkat.Task)
```

Called from the background thread when an asynchronous task completes.

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

```xojo
Function ObtainAccessTokenAsync(connection As Chilkat.Socket) As Chilkat.Task
```

## Related classes

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