After installing the plugin, you need to configure its properties so that it works correctly with your Google credentials and your application's requirements.
Go to the Installed Plugins Section :
Configure the Properties :
Below are detailed explanations of each property you need to configure:
Property |
Type |
Description |
Default Value |
---|---|---|---|
|
Text |
The Google API key required to authenticate and access the Google Picker and Google Drive APIs. This key allows your application to securely communicate with Google services. It must be generated from the Google Cloud Console for your specific project. If this value is invalid or missing, the plugin will not connect to Google services. |
- |
|
Text |
The OAuth 2.0 client ID that identifies your application to Google. This ID is essential for the authentication and authorization process that allows users to access their Google Drive files through your application. It must be generated specifically for web applications in the Google Cloud Console. |
- |
|
Text |
The Google app ID associated with your Google Cloud project. This identifier links requests to the API with your specific project and is necessary for the Picker API to function correctly. |
- |
Property |
Type |
Description |
Default Value |
---|---|---|---|
|
Text |
Language code that determines the language of the Google Picker interface. For example, 'es' for Spanish, 'en' for English, 'fr' for French, etc. This value affects all texts, buttons, and messages displayed in the Google Drive picker interface. If left blank, the plugin will automatically use the language configured in the user's browser (navigator.language). If the browser's language is unavailable or cannot be determined, 'es' (Spanish) will be used as the default. |
Browser Language |
Property |
Type |
Description |
Default Value |
---|---|---|---|
|
Dropdown |
Defines the operation mode of the Google Drive picker, determining what type of interaction and results will be provided. |
|
Available Options for view_mode
:
select
: Selection Mode (default): Allows users to select files from Google Drive and returns basic information about the selected files. Useful when only access to file metadata or references is needed. Triggers the onFilesSelected
event upon completion.download
: Download Mode: Optimized for downloading files. In addition to basic file information, generates direct download URLs adapted to the file type (e.g., exports Google Docs to downloadable formats like DOCX, XLSX, etc.). Automatically initiates download for a single file. Triggers the onFilesDownload
event upon completion.share
: Share Mode: Focused on generating various types of links for sharing selected files. Provides URLs for viewing, editing, embedding in websites, and optimized for social media. Ideal when different sharing options are needed. Triggers the onFilesShare
event upon completion.all
: Full Mode: Combines all functionalities of the above modes. Provides complete information, including basic metadata, download URLs, and all sharing link options. It’s the most versatile option when full access is required. Automatically initiates download for a single file. Triggers the onFilesAll
event upon completion.
Property |
Type |
Description |
Default Value |
---|---|---|---|
|
Dropdown (List) |
Defines which types of files will be displayed in the Google Drive picker. This setting filters the files that users can view and select, making navigation and selection easier when only certain file types are required. |
|
Available Options for file_type
:
all
: Displays all available file types in Google Drive.images
: Displays only image files (jpg, png, gif, etc.).videos
: Displays only video files (mp4, mov, avi, etc.).documents
: Displays only Google Docs and other document formats.spreadsheets
: Displays only Google Sheets and other spreadsheet formats.presentations
: Displays only Google Slides and other presentation formats.folders
: Displays only folders to allow navigation through the Google Drive structure.
Property |
Type |
Description |
Default Value |
---|---|---|---|
|
Checkbox |
Determines whether users can select multiple files at once in the picker. When enabled, users can hold down the Ctrl key (or Cmd on Mac) to select multiple files. When disabled, only one file can be selected at a time. Useful for limiting selection to a single file when processing or displaying one item at a time is required. |
Enabled |
|
Number |
Sets the maximum number of files a user can select simultaneously. This limitation applies after the user completes their selection and helps prevent overloading during file processing. If a user selects more files than allowed, a custom error message is displayed, and the selection is not processed. If left blank or set to null, there will be no limit on the number of selectable files. |
No limit (null) |
|
Number |
Defines the maximum allowed size for each individual file in megabytes (MB). Files exceeding this size are automatically excluded from the final selection. This limitation prevents performance issues when uploading large files or storage restrictions. If users select files exceeding this limit, a custom warning message is displayed, and the files are filtered out. If left blank or set to null, there will be no size restriction. |
No limit (null) |
|
Checkbox |
Controls whether users can upload new files to Google Drive directly from the picker. When enabled, an additional option appears in the picker allowing users to upload files from their device. These files are saved to Google Drive and can then be selected immediately. When disabled, users can only select files already existing in their Google Drive. |
Enabled |
Property |
Type |
Description |
Default Value |
---|---|---|---|
|
Text |
Custom message displayed when a user selects more files than allowed by the |
"You have selected more files than allowed. Please select up to {max_files} files." |
|
Text |
Custom message displayed when some of the selected files exceed the maximum allowed size configured in |
"Some files exceed the maximum allowed size of {max_file_size} MB and have been excluded." |
Property |
Type |
Description |
Default Value |
---|---|---|---|
|
Text |
Defines the origins (domains) from which the plugin is allowed to run. This is a critical security measure that prevents unauthorized use of the plugin from unapproved domains. It can be configured as a comma-separated list of domains or an array of strings. Wildcards (e.g., |
Current application domain |
|
Checkbox |
Enables additional and strict security checks during plugin operation. When enabled, the plugin verifies the runtime environment and blocks operations in environments considered insecure (such as non-HTTPS connections, presence of open developer tools, or execution within unauthorized iframes). This setting provides an additional layer of protection against malicious use but may limit functionality in certain development environments. |
Disabled |
|
Number |
Sets the inactivity timeout in minutes before the user's session expires automatically. When this time is reached without user interaction (no mouse movements, key presses, or clicks), the access token is removed, and the |
0 (disabled) |
api_key_google
:
client_id_google
:
app_id_google
:
language
:
view_mode
:
select
: Standard selection mode that returns basic file information.download
: Optimized for downloading files and generates direct download URLs.share
: Focused on generating shareable links with different options.all
: Combines all the above functionalities into a single mode.file_type
:
all
- All filesimages
- Imagesvideos
- Videosdocuments
- Google Docsspreadsheets
- Spreadsheetspresentations
- Presentationsfolders
- Foldersmax_files
:
max_file_size
:
enable_file_upload
:
true
): Allows users to upload new files from the Picker.false
): Only allows users to select existing files in Google Drive.allowed_origins
:
*.mydomain.com
) to allow all subdomains.strict_security
:
true
): Applies strict security checks and blocks operations in insecure environments.false
): Allows operations with basic security checks.inactivity_timeout
:
error_message
:
warning_message
:
Was this page helpful?
Thank you for your feedback!
Please Login First
Comments (00)