Conference Data

This service allows scripts to configure and build conferencing data objects that interact
with Google Calendar.

> [!NOTE]
> Currently you can only use this service in conjunction with [Calendar conferencing add-ons](https://developers.google.com/gsuite/add-ons/guides/glossary#calendar_conferencing_add-on) or [Google Workspace add-ons](https://developers.google.com/gsuite/add-ons/concepts/types#g_suite_add-ons) that interact with Google Calendar conferencing. Only add-ons that connect to third-party conferencing systems have need of this service.

## Classes

| Name | Brief description |
|---|---|
| `https://developers.google.com/apps-script/reference/conference-data/conference-data` | Container for all conference-related information. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Builder for creating for `https://developers.google.com/apps-script/reference/conference-data/conference-data` objects. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-service` | Service that scripts can use to create conferencing information. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-error` | Error that occurred in a conferencing add-on. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-error-type` | Enum that defines the types of errors that you can specify in a `https://developers.google.com/apps-script/reference/conference-data/conference-error`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-parameter` | Solution-specific parameter available fo the add-on's use. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point` | Definition of a specific way to join a conference. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point-feature` | Enum that defines the features of the entry point that can be created by a conferencing add-on. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point-type` | Enum that defines the types of entry points that can be created by a conferencing add-on. |

## `https://developers.google.com/apps-script/reference/conference-data/conference-data`

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/conference-data/conference-data#printJson()` | `String` | Prints the JSON representation of this object. |

## `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder`

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#addConferenceParameter(ConferenceParameter)` | `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Adds a `https://developers.google.com/apps-script/reference/conference-data/conference-parameter` to this `https://developers.google.com/apps-script/reference/conference-data/conference-data`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#addEntryPoint(EntryPoint)` | `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Adds an `https://developers.google.com/apps-script/reference/conference-data/entry-point` to this `https://developers.google.com/apps-script/reference/conference-data/conference-data`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#build()` | `https://developers.google.com/apps-script/reference/conference-data/conference-data` | Builds and validates the `https://developers.google.com/apps-script/reference/conference-data/conference-data`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setConferenceId(String)` | `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Sets the conference ID of this `https://developers.google.com/apps-script/reference/conference-data/conference-data`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setConferenceSolutionId(String)` | `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Sets the conference solution ID defined in the addon's manifest. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setError(ConferenceError)` | `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Sets the `https://developers.google.com/apps-script/reference/conference-data/conference-error` of this `https://developers.google.com/apps-script/reference/conference-data/conference-data`, indicating that the conference was not successfully created. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setNotes(String)` | `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Sets the additional notes of this `https://developers.google.com/apps-script/reference/conference-data/conference-data`, such as instructions from the administrator or legal notices. |

## `https://developers.google.com/apps-script/reference/conference-data/conference-data-service`

### Properties

| Property | Type | Description |
|---|---|---|
| `ConferenceErrorType` | `https://developers.google.com/apps-script/reference/conference-data/conference-error-type` | The `https://developers.google.com/apps-script/reference/conference-data/conference-error-type` enumeration. |
| `EntryPointFeature` | `https://developers.google.com/apps-script/reference/conference-data/entry-point-feature` | The `https://developers.google.com/apps-script/reference/conference-data/entry-point-feature` enumeration. |
| `EntryPointType` | `https://developers.google.com/apps-script/reference/conference-data/entry-point-type` | The `https://developers.google.com/apps-script/reference/conference-data/entry-point-type` enumeration. |

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newConferenceDataBuilder()` | `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder` | Returns a new, empty `https://developers.google.com/apps-script/reference/conference-data/conference-data-builder`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newConferenceError()` | `https://developers.google.com/apps-script/reference/conference-data/conference-error` | Returns a new, empty `https://developers.google.com/apps-script/reference/conference-data/conference-error`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newConferenceParameter()` | `https://developers.google.com/apps-script/reference/conference-data/conference-parameter` | Returns a new, empty `https://developers.google.com/apps-script/reference/conference-data/conference-parameter`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newEntryPoint()` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | Returns a new, empty `https://developers.google.com/apps-script/reference/conference-data/entry-point`. |

## `https://developers.google.com/apps-script/reference/conference-data/conference-error`

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/conference-data/conference-error#setAuthenticationUrl(String)` | `https://developers.google.com/apps-script/reference/conference-data/conference-error` | If the error type is `https://developers.google.com/apps-script/reference/conference-data/conference-error-type#AUTHENTICATION`, the add-on must provide a URL calling back into the add-on to allow users to log in. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-error#setConferenceErrorType(ConferenceErrorType)` | `https://developers.google.com/apps-script/reference/conference-data/conference-error` | Sets the error type of this `https://developers.google.com/apps-script/reference/conference-data/conference-error`. |

## `https://developers.google.com/apps-script/reference/conference-data/conference-error-type`

### Properties

| Property | Type | Description |
|---|---|---|
| `AUTHENTICATION` | `Enum` | An authentication error during conference data generation. |
| `CONFERENCE_SOLUTION_FORBIDDEN` | `Enum` | The user is not allowed to use the selected conference solution (but might be allowed to use other solutions offered by the add-on). |
| `PERMANENT` | `Enum` | A permanent error during conference data generation. |
| `PERMISSION_DENIED` | `Enum` | The user isn't allowed to perform an action in the third-party conferencing system. |
| `TEMPORARY` | `Enum` | A temporary error during conference data generation. |
| `UNKNOWN` | `Enum` | An unknown error during conference data generation. |

## `https://developers.google.com/apps-script/reference/conference-data/conference-parameter`

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/conference-data/conference-parameter#setKey(String)` | `https://developers.google.com/apps-script/reference/conference-data/conference-parameter` | Sets the key of this `https://developers.google.com/apps-script/reference/conference-data/conference-parameter`. |
| `https://developers.google.com/apps-script/reference/conference-data/conference-parameter#setValue(String)` | `https://developers.google.com/apps-script/reference/conference-data/conference-parameter` | Sets the value of this `https://developers.google.com/apps-script/reference/conference-data/conference-parameter`. |

## `https://developers.google.com/apps-script/reference/conference-data/entry-point`

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#addFeature(EntryPointFeature)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | Adds the feature of the entry point, such as being toll or toll-free. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setAccessCode(String)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | An access code for accessing the conference. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setEntryPointType(EntryPointType)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | Sets the type of this entry point. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setMeetingCode(String)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | A meeting code for accessing the conference. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setPasscode(String)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | A passcode for accessing the conference. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setPassword(String)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | A password code for accessing the conference. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setPin(String)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | A PIN code for accessing the conference. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setRegionCode(String)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | The CLDR/ISO 3166 region code for the country associated with this entry point. |
| `https://developers.google.com/apps-script/reference/conference-data/entry-point#setUri(String)` | `https://developers.google.com/apps-script/reference/conference-data/entry-point` | Sets the URI for joining the conference through this entry point. |

## `https://developers.google.com/apps-script/reference/conference-data/entry-point-feature`

### Properties

| Property | Type | Description |
|---|---|---|
| `UNKNOWN_FEATURE` | `Enum` | Do not use. |
| `TOLL` | `Enum` | Applies to PHONE entry point only. |
| `TOLL_FREE` | `Enum` | Applies to PHONE entry point only. |

## `https://developers.google.com/apps-script/reference/conference-data/entry-point-type`

### Properties

| Property | Type | Description |
|---|---|---|
| `VIDEO` | `Enum` | A video entry point for a conference. |
| `PHONE` | `Enum` | A phone entry point for a conference. |
| `MORE` | `Enum` | A link to more information about entry points into a conference. |
| `SIP` | `Enum` | A SIP entry point for a conference. |