Class ExportGoogleFormsCSVAction

Action to export Google Forms responses as CSV format

Security: This action uses secure credential lookup via Company Integrations. API credentials are retrieved from environment variables or the database based on CompanyID.

Example

await runAction({
  ActionName: 'Export Google Forms Responses to CSV',
  Params: [{
    Name: 'CompanyID',
    Value: 'company-uuid-here'
  }, {
    Name: 'FormID',
    Value: '1a2b3c4d5e6f7g8h9i0j'
  }, {
    Name: 'IncludeMetadata',
    Value: true
  }]
});

Hierarchy (View Summary)

GoogleFormsBaseAction
- ExportGoogleFormsCSVAction

Constructors

constructor

new ExportGoogleFormsCSVAction(): ExportGoogleFormsCSVAction
Returns ExportGoogleFormsCSVAction
Inherited from GoogleFormsBaseAction.constructor

Accessors

`Protected`apiBaseUrl

get apiBaseUrl(): string
Returns string
Inherited from GoogleFormsBaseAction.apiBaseUrl
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:140

Description

get Description(): string
Returns string
- Defined in BizApps/FormBuilders/src/providers/google-forms/actions/export-csv.action.ts:32

`Protected`formPlatform

get formPlatform(): string
The form platform this action is designed for (e.g., 'Typeform', 'Google Forms', etc.)

Returns string
Inherited from GoogleFormsBaseAction.formPlatform
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:132

`Protected`integrationName

get integrationName(): string
The integration name to look up in the Integration entity

Returns string
Inherited from GoogleFormsBaseAction.integrationName
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:136

Params

get Params(): ActionParam[]
Returns ActionParam[]
- Defined in BizApps/FormBuilders/src/providers/google-forms/actions/export-csv.action.ts:138

Methods

`Protected`buildFilter

buildFilter(
conditions: { timestampAfter?: Date; timestampBefore?: Date },
): string
Build filter string for Google Forms API Filters use a SQL-like syntax: timestamp > "2024-01-01T00:00:00Z"
Parameters
- conditions: { timestampAfter?: Date; timestampBefore?: Date }
Returns string
Inherited from GoogleFormsBaseAction.buildFilter
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:502

`Protected`buildFormErrorMessage

buildFormErrorMessage(
    operation: string,
    details: string,
    systemError?: any,
): string
Helper to build consistent error messages for form operations
Parameters
- operation: string
- details: string
- OptionalsystemError: any
Returns string
Inherited from GoogleFormsBaseAction.buildFormErrorMessage
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:289

`Protected`calculateAverageCompletionTime

calculateAverageCompletionTime(responses: FormResponse[]): number
Calculate average completion time from responses
Parameters
- responses: FormResponse[]
Returns number
Inherited from GoogleFormsBaseAction.calculateAverageCompletionTime
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:333

`Protected`calculateCompletionRate

calculateCompletionRate(completed: number, total: number): number
Calculate completion rate percentage
Parameters
- completed: number
- total: number
Returns number
Inherited from GoogleFormsBaseAction.calculateCompletionRate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:263

`Protected`convertToCSV

convertToCSV(
    responses: FormResponse[],
    includeMetadata?: boolean,
    delimiter?: string,
): { csv: string; headers: string[] }
Convert responses to CSV format
Parameters
- responses: FormResponse[]
- includeMetadata: boolean = false
- delimiter: string = ','
Returns { csv: string; headers: string[] }
Inherited from GoogleFormsBaseAction.convertToCSV
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:382

`Protected`createOAuth2Manager

createOAuth2Manager(
companyId: string,
contextUser: UserInfo,
): Promise<OAuth2Manager>
Creates an OAuth2Manager instance for the specified company. Override this method in provider-specific base classes to configure OAuth2 endpoints.
Parameters
- companyId: string
  The MemberJunction company ID
- contextUser: UserInfo
  The user context
Returns Promise<OAuth2Manager>
OAuth2Manager instance or null if OAuth2 is not configured
Inherited from GoogleFormsBaseAction.createOAuth2Manager
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:221

`Protected`extractEmailFromResponses

extractEmailFromResponses(responses: FormResponse[]): string[]
Extract email addresses from response answers
Parameters
- responses: FormResponse[]
Returns string[]
Inherited from GoogleFormsBaseAction.extractEmailFromResponses
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:300

`Protected`extractQuestions

extractQuestions(
formDetails: GoogleFormsDetails,
): { id: string; required: boolean; title: string; type: string }[]
Extract question information from form details Useful for building comprehensive reports with question titles
Parameters
- formDetails: GoogleFormsDetails
Returns { id: string; required: boolean; title: string; type: string }[]
Inherited from GoogleFormsBaseAction.extractQuestions
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:453

`Protected`findTopAnswers

findTopAnswers(
    responses: FormResponse[],
    fieldId: string,
    limit?: number,
): { answer: string; count: number }[]
Find most common answers for choice fields
Parameters
- responses: FormResponse[]
- fieldId: string
- limit: number = 10
Returns { answer: string; count: number }[]
Inherited from GoogleFormsBaseAction.findTopAnswers
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:356

`Protected`formatDuration

formatDuration(seconds: number): string
Format duration in seconds to human readable format
Parameters
- seconds: number
Returns string
Inherited from GoogleFormsBaseAction.formatDuration
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:271

`Protected`formatFormDate

formatFormDate(date: Date): string
Standard date format for form platforms (ISO 8601)
Parameters
- date: Date
Returns string
Inherited from GoogleFormsBaseAction.formatFormDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:246

`Protected`formatGoogleFormsDate

formatGoogleFormsDate(date: Date): string
Format date for Google Forms API (RFC3339 format)
Parameters
- date: Date
Returns string
Inherited from GoogleFormsBaseAction.formatGoogleFormsDate
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:438

`Protected`getAllGoogleFormsResponses

getAllGoogleFormsResponses(
    formId: string,
    accessToken: string,
    options?: { filter?: string; maxResponses?: number },
): Promise<GoogleFormsResponseItem[]>
Get all responses with automatic pagination using pageToken
Parameters
- formId: string
- accessToken: string
- Optionaloptions: { filter?: string; maxResponses?: number }
Returns Promise<GoogleFormsResponseItem[]>
Inherited from GoogleFormsBaseAction.getAllGoogleFormsResponses
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:226

`Protected`getAPICredentials

getAPICredentials(
integration: MJCompanyIntegrationEntity,
): Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
Gets API credentials - first tries environment variables, then falls back to database
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
Inherited from GoogleFormsBaseAction.getAPICredentials
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:148

`Protected`getAxiosInstance

getAxiosInstance(accessToken: string): AxiosInstance
Get axios instance with Google Forms authentication (OAuth 2.0)
Parameters
- accessToken: string
Returns AxiosInstance
Inherited from GoogleFormsBaseAction.getAxiosInstance
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:150

`Protected`getCommonFormParams

getCommonFormParams(): ActionParam[]
Common form builder parameters that many actions will need. CompanyID is required for secure credential lookup. FormID is the platform-specific form identifier.

Returns ActionParam[]
Inherited from GoogleFormsBaseAction.getCommonFormParams
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:78

`Protected`getCompanyIntegration

getCompanyIntegration(
companyId: string,
contextUser: UserInfo,
): Promise<MJCompanyIntegrationEntity>
Gets the company integration record for the specified company and form platform
Parameters
- companyId: string
- contextUser: UserInfo
Returns Promise<MJCompanyIntegrationEntity>
Inherited from GoogleFormsBaseAction.getCompanyIntegration
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:96

`Protected`getCredentialFromEnv

getCredentialFromEnv(companyId: string, credentialType: string): string
Gets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_TYPEFORM_12345_API_TOKEN

Falls back to: BIZAPPS_{PROVIDER}_{CREDENTIAL_TYPE} if no company-specific credential found Example fallback: BIZAPPS_TYPEFORM_API_TOKEN
Parameters
- companyId: string
- credentialType: string
Returns string
Inherited from GoogleFormsBaseAction.getCredentialFromEnv
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:128

`Protected`getGoogleFormsDetails

getGoogleFormsDetails(
formId: string,
accessToken: string,
): Promise<GoogleFormsDetails>
Get form details including questions and settings
Parameters
- formId: string
- accessToken: string
Returns Promise<GoogleFormsDetails>
Inherited from GoogleFormsBaseAction.getGoogleFormsDetails
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:295

`Protected`getGoogleFormsResponses

getGoogleFormsResponses(
    formId: string,
    accessToken: string,
    options?: { filter?: string; pageSize?: number; pageToken?: string },
): Promise<GoogleFormsResponsesResult>
Get responses from a Google Form
Parameters
- formId: string
- accessToken: string
- Optionaloptions: { filter?: string; pageSize?: number; pageToken?: string }
Returns Promise<GoogleFormsResponsesResult>
Inherited from GoogleFormsBaseAction.getGoogleFormsResponses
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:186

`Protected`getParamValue

getParamValue(params: ActionParam[], paramName: string): any
Helper to get parameter value with type safety
Parameters
- params: ActionParam[]
- paramName: string
Returns any
Inherited from GoogleFormsBaseAction.getParamValue
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:238

`Protected`getSecureAPIToken

getSecureAPIToken(companyId: string, contextUser: UserInfo): Promise<string>
Helper to securely retrieve API token for a company. This method should be used by all form builder actions instead of accepting tokens as parameters.
Parameters
- companyId: string
  The MemberJunction company ID (required)
- contextUser: UserInfo
  The user context for database queries
Returns Promise<string>
The API token for the specified company

Throws
Error if no credentials are found or company integration is not configured
Inherited from GoogleFormsBaseAction.getSecureAPIToken
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:183

`Protected`getSingleGoogleFormsResponse

getSingleGoogleFormsResponse(
    formId: string,
    responseId: string,
    accessToken: string,
): Promise<GoogleFormsResponseItem>
Get a single response by ID
Parameters
- formId: string
- responseId: string
- accessToken: string
Returns Promise<GoogleFormsResponseItem>
Inherited from GoogleFormsBaseAction.getSingleGoogleFormsResponse
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:275

`Protected`groupResponsesByDate

groupResponsesByDate(responses: FormResponse[]): Record<string, number>
Group responses by date
Parameters
- responses: FormResponse[]
Returns Record<string, number>
Inherited from GoogleFormsBaseAction.groupResponsesByDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:319

`Protected`handleGoogleFormsError

handleGoogleFormsError(error: any): Error
Handle Google Forms-specific errors
Parameters
- error: any
Returns Error
Inherited from GoogleFormsBaseAction.handleGoogleFormsError
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:403

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Overrides GoogleFormsBaseAction.InternalRunAction
- Defined in BizApps/FormBuilders/src/providers/google-forms/actions/export-csv.action.ts:36

`Protected`isQuiz

isQuiz(formDetails: GoogleFormsDetails): boolean
Check if a form is a quiz
Parameters
- formDetails: GoogleFormsDetails
Returns boolean
Inherited from GoogleFormsBaseAction.isQuiz
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:494

`Protected`normalizeGoogleFormsResponse

normalizeGoogleFormsResponse(
gfResponse: GoogleFormsResponseItem,
formDetails?: GoogleFormsDetails,
): FormResponse
Normalize Google Forms response to common format
Parameters
- gfResponse: GoogleFormsResponseItem
- OptionalformDetails: GoogleFormsDetails
Returns FormResponse
Inherited from GoogleFormsBaseAction.normalizeGoogleFormsResponse
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:314

`Protected`parseFormDate

parseFormDate(dateString: string | number): Date
Parse date from form platform format
Parameters
- dateString: string | number
Returns Date
Inherited from GoogleFormsBaseAction.parseFormDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:253

`Protected`parseGoogleFormsDate

parseGoogleFormsDate(dateValue: string): Date
Parse Google Forms date string (RFC3339 format)
Parameters
- dateValue: string
Returns Date
Inherited from GoogleFormsBaseAction.parseGoogleFormsDate
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:445

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from GoogleFormsBaseAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:37

`Protected`sleep

sleep(ms: number): Promise<void>
Sleep helper for rate limiting and pagination delays
Parameters
- ms: number
Returns Promise<void>
Inherited from GoogleFormsBaseAction.sleep
- Defined in BizApps/FormBuilders/src/providers/google-forms/googleforms-base.action.ts:431

Class ExportGoogleFormsCSVAction

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns ExportGoogleFormsCSVAction

Accessors

ProtectedapiBaseUrl

Returns string

Description

Returns string

ProtectedformPlatform

Returns string

ProtectedintegrationName

Returns string

Params

Returns ActionParam[]

Methods

ProtectedbuildFilter

Parameters

Returns string

ProtectedbuildFormErrorMessage

Parameters

Returns string

ProtectedcalculateAverageCompletionTime

Parameters

Returns number

ProtectedcalculateCompletionRate

Parameters

Returns number

ProtectedconvertToCSV

Parameters

Returns { csv: string; headers: string[] }

ProtectedcreateOAuth2Manager

Parameters

Returns Promise<OAuth2Manager>

ProtectedextractEmailFromResponses

Parameters

Returns string[]

ProtectedextractQuestions

Parameters

Returns { id: string; required: boolean; title: string; type: string }[]

ProtectedfindTopAnswers

Parameters

Returns { answer: string; count: number }[]

ProtectedformatDuration

Parameters

Returns string

ProtectedformatFormDate

Parameters

Returns string

ProtectedformatGoogleFormsDate

Parameters

Returns string

ProtectedgetAllGoogleFormsResponses

Parameters

Returns Promise<GoogleFormsResponseItem[]>

ProtectedgetAPICredentials

Parameters

Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>

ProtectedgetAxiosInstance

Parameters

Returns AxiosInstance

ProtectedgetCommonFormParams

Returns ActionParam[]

ProtectedgetCompanyIntegration

Parameters

Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

Parameters

Returns string

ProtectedgetGoogleFormsDetails

Parameters

Returns Promise<GoogleFormsDetails>

ProtectedgetGoogleFormsResponses

Parameters

`Protected`apiBaseUrl

`Protected`formPlatform

`Protected`integrationName

`Protected`buildFilter

`Protected`buildFormErrorMessage

`Protected`calculateAverageCompletionTime

`Protected`calculateCompletionRate

`Protected`convertToCSV

`Protected`createOAuth2Manager

`Protected`extractEmailFromResponses

`Protected`extractQuestions

`Protected`findTopAnswers

`Protected`formatDuration

`Protected`formatFormDate

`Protected`formatGoogleFormsDate

`Protected`getAllGoogleFormsResponses

`Protected`getAPICredentials

`Protected`getAxiosInstance

`Protected`getCommonFormParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getGoogleFormsDetails

`Protected`getGoogleFormsResponses

`Protected`getParamValue

`Protected`getSecureAPIToken

`Protected`getSingleGoogleFormsResponse

`Protected`groupResponsesByDate

`Protected`handleGoogleFormsError

`Protected`InternalRunAction

`Protected`isQuiz

`Protected`normalizeGoogleFormsResponse

`Protected`parseFormDate

`Protected`parseGoogleFormsDate

`Protected`sleep