airbyte 0.13.0, Jun 13 25

airbyte 0.13.0 published on Friday, Jun 13, 2025 by airbytehq

airbyte.SourceGoogleSheets

Explore with Pulumi AI

airbyte 0.13.0 published on Friday, Jun 13, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceGoogleSheets;
import com.pulumi.airbyte.SourceGoogleSheetsArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSheetsConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSheetsConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceGooglesheets = new SourceGoogleSheets("mySourceGooglesheets", SourceGoogleSheetsArgs.builder()
            .configuration(SourceGoogleSheetsConfigurationArgs.builder()
                .allow_leading_numbers(true)
                .batch_size(10)
                .combine_letter_number_pairs(false)
                .combine_number_word_pairs(true)
                .credentials(SourceGoogleSheetsConfigurationCredentialsArgs.builder()
                    .serviceAccountKeyAuthentication(SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs.builder()
                        .serviceAccountInfo("{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID, \"private_key_id\": YOUR_PRIVATE_KEY, ... }")
                        .build())
                    .build())
                .names_conversion(false)
                .remove_leading_trailing_underscores(true)
                .remove_special_characters(false)
                .spreadsheet_id("https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit")
                .stream_name_overrides(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .definitionId("8010dc77-56bf-4220-982b-1460e03dad99")
            .secretId("...my_secret_id...")
            .workspaceId("6266806c-1cd7-4250-b2c6-f4ef1504f265")
            .build());

    }
}

resources:
  mySourceGooglesheets:
    type: airbyte:SourceGoogleSheets
    properties:
      configuration:
        allow_leading_numbers: true
        batch_size: 10
        combine_letter_number_pairs: false
        combine_number_word_pairs: true
        credentials:
          serviceAccountKeyAuthentication:
            serviceAccountInfo: '{ "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... }'
        names_conversion: false
        remove_leading_trailing_underscores: true
        remove_special_characters: false
        spreadsheet_id: https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit
        stream_name_overrides:
          - customStreamName: '...my_custom_stream_name...'
            sourceStreamName: '...my_source_stream_name...'
      definitionId: 8010dc77-56bf-4220-982b-1460e03dad99
      secretId: '...my_secret_id...'
      workspaceId: 6266806c-1cd7-4250-b2c6-f4ef1504f265

Create SourceGoogleSheets Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceGoogleSheets(name: string, args: SourceGoogleSheetsArgs, opts?: CustomResourceOptions);

@overload
def SourceGoogleSheets(resource_name: str,
                       args: SourceGoogleSheetsArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def SourceGoogleSheets(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       configuration: Optional[SourceGoogleSheetsConfigurationArgs] = None,
                       workspace_id: Optional[str] = None,
                       definition_id: Optional[str] = None,
                       name: Optional[str] = None,
                       secret_id: Optional[str] = None)

func NewSourceGoogleSheets(ctx *Context, name string, args SourceGoogleSheetsArgs, opts ...ResourceOption) (*SourceGoogleSheets, error)

public SourceGoogleSheets(string name, SourceGoogleSheetsArgs args, CustomResourceOptions? opts = null)

public SourceGoogleSheets(String name, SourceGoogleSheetsArgs args)
public SourceGoogleSheets(String name, SourceGoogleSheetsArgs args, CustomResourceOptions options)

type: airbyte:SourceGoogleSheets
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceGoogleSheetsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceGoogleSheetsArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceGoogleSheetsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceGoogleSheetsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceGoogleSheetsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceGoogleSheetsResource = new Airbyte.SourceGoogleSheets("sourceGoogleSheetsResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGoogleSheetsConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceGoogleSheetsConfigurationCredentialsArgs
        {
            AuthenticateViaGoogleOAuth = new Airbyte.Inputs.SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs
            {
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
            },
            ServiceAccountKeyAuthentication = new Airbyte.Inputs.SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs
            {
                ServiceAccountInfo = "string",
            },
        },
        SpreadsheetId = "string",
        AllowLeadingNumbers = false,
        BatchSize = 0,
        CombineLetterNumberPairs = false,
        CombineNumberWordPairs = false,
        NamesConversion = false,
        RemoveLeadingTrailingUnderscores = false,
        RemoveSpecialCharacters = false,
        StreamNameOverrides = new[]
        {
            new Airbyte.Inputs.SourceGoogleSheetsConfigurationStreamNameOverrideArgs
            {
                CustomStreamName = "string",
                SourceStreamName = "string",
            },
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceGoogleSheets(ctx, "sourceGoogleSheetsResource", &airbyte.SourceGoogleSheetsArgs{
	Configuration: &airbyte.SourceGoogleSheetsConfigurationArgs{
		Credentials: &airbyte.SourceGoogleSheetsConfigurationCredentialsArgs{
			AuthenticateViaGoogleOAuth: &airbyte.SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs{
				ClientId:     pulumi.String("string"),
				ClientSecret: pulumi.String("string"),
				RefreshToken: pulumi.String("string"),
			},
			ServiceAccountKeyAuthentication: &airbyte.SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs{
				ServiceAccountInfo: pulumi.String("string"),
			},
		},
		SpreadsheetId:                    pulumi.String("string"),
		AllowLeadingNumbers:              pulumi.Bool(false),
		BatchSize:                        pulumi.Float64(0),
		CombineLetterNumberPairs:         pulumi.Bool(false),
		CombineNumberWordPairs:           pulumi.Bool(false),
		NamesConversion:                  pulumi.Bool(false),
		RemoveLeadingTrailingUnderscores: pulumi.Bool(false),
		RemoveSpecialCharacters:          pulumi.Bool(false),
		StreamNameOverrides: airbyte.SourceGoogleSheetsConfigurationStreamNameOverrideArray{
			&airbyte.SourceGoogleSheetsConfigurationStreamNameOverrideArgs{
				CustomStreamName: pulumi.String("string"),
				SourceStreamName: pulumi.String("string"),
			},
		},
	},
	WorkspaceId:  pulumi.String("string"),
	DefinitionId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	SecretId:     pulumi.String("string"),
})

var sourceGoogleSheetsResource = new SourceGoogleSheets("sourceGoogleSheetsResource", SourceGoogleSheetsArgs.builder()
    .configuration(SourceGoogleSheetsConfigurationArgs.builder()
        .credentials(SourceGoogleSheetsConfigurationCredentialsArgs.builder()
            .authenticateViaGoogleOAuth(SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs.builder()
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .build())
            .serviceAccountKeyAuthentication(SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs.builder()
                .serviceAccountInfo("string")
                .build())
            .build())
        .spreadsheetId("string")
        .allowLeadingNumbers(false)
        .batchSize(0.0)
        .combineLetterNumberPairs(false)
        .combineNumberWordPairs(false)
        .namesConversion(false)
        .removeLeadingTrailingUnderscores(false)
        .removeSpecialCharacters(false)
        .streamNameOverrides(SourceGoogleSheetsConfigurationStreamNameOverrideArgs.builder()
            .customStreamName("string")
            .sourceStreamName("string")
            .build())
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_google_sheets_resource = airbyte.SourceGoogleSheets("sourceGoogleSheetsResource",
    configuration={
        "credentials": {
            "authenticate_via_google_o_auth": {
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
            },
            "service_account_key_authentication": {
                "service_account_info": "string",
            },
        },
        "spreadsheet_id": "string",
        "allow_leading_numbers": False,
        "batch_size": 0,
        "combine_letter_number_pairs": False,
        "combine_number_word_pairs": False,
        "names_conversion": False,
        "remove_leading_trailing_underscores": False,
        "remove_special_characters": False,
        "stream_name_overrides": [{
            "custom_stream_name": "string",
            "source_stream_name": "string",
        }],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceGoogleSheetsResource = new airbyte.SourceGoogleSheets("sourceGoogleSheetsResource", {
    configuration: {
        credentials: {
            authenticateViaGoogleOAuth: {
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
            },
            serviceAccountKeyAuthentication: {
                serviceAccountInfo: "string",
            },
        },
        spreadsheetId: "string",
        allowLeadingNumbers: false,
        batchSize: 0,
        combineLetterNumberPairs: false,
        combineNumberWordPairs: false,
        namesConversion: false,
        removeLeadingTrailingUnderscores: false,
        removeSpecialCharacters: false,
        streamNameOverrides: [{
            customStreamName: "string",
            sourceStreamName: "string",
        }],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceGoogleSheets
properties:
    configuration:
        allowLeadingNumbers: false
        batchSize: 0
        combineLetterNumberPairs: false
        combineNumberWordPairs: false
        credentials:
            authenticateViaGoogleOAuth:
                clientId: string
                clientSecret: string
                refreshToken: string
            serviceAccountKeyAuthentication:
                serviceAccountInfo: string
        namesConversion: false
        removeLeadingTrailingUnderscores: false
        removeSpecialCharacters: false
        spreadsheetId: string
        streamNameOverrides:
            - customStreamName: string
              sourceStreamName: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceGoogleSheets Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceGoogleSheets resource accepts the following input properties:

Configuration SourceGoogleSheetsConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceGoogleSheetsConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceGoogleSheetsConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceGoogleSheetsConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceGoogleSheetsConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceGoogleSheets resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
resource_allocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceGoogleSheets Resource

Get an existing SourceGoogleSheets resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceGoogleSheetsState, opts?: CustomResourceOptions): SourceGoogleSheets

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceGoogleSheetsConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceGoogleSheetsResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceGoogleSheets

func GetSourceGoogleSheets(ctx *Context, name string, id IDInput, state *SourceGoogleSheetsState, opts ...ResourceOption) (*SourceGoogleSheets, error)

public static SourceGoogleSheets Get(string name, Input<string> id, SourceGoogleSheetsState? state, CustomResourceOptions? opts = null)

public static SourceGoogleSheets get(String name, Output<String> id, SourceGoogleSheetsState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceGoogleSheets    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configuration SourceGoogleSheetsConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceGoogleSheetsConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceGoogleSheetsResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceGoogleSheetsConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceGoogleSheetsConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceGoogleSheetsResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceGoogleSheetsConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
resource_allocation SourceGoogleSheetsResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceGoogleSheetsConfiguration, SourceGoogleSheetsConfigurationArgs

Credentials SourceGoogleSheetsConfigurationCredentials

Credentials for connecting to the Google Sheets API

SpreadsheetId string

Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.

AllowLeadingNumbers bool

Allows column names to start with numbers. Example: "50th Percentile" → "50_th_percentile" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

BatchSize double

Default value is 1000000. An integer representing row batch size for each sent request to Google Sheets API. Row batch size means how many rows are processed from the google sheet, for example default value 1000000 would process rows 2-1000002, then 1000003-2000003 and so on. Based on Google Sheets API limits documentation, it is possible to send up to 300 requests per minute, but each individual request has to be processed under 180 seconds, otherwise the request returns a timeout error. In regards to this information, consider network speed and number of columns of the google sheet when deciding a batch_size value. Default: 1000000

CombineLetterNumberPairs bool

Combines adjacent letters and numbers. Example: "Q3 2023" → "q3_2023" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

CombineNumberWordPairs bool

Combines adjacent numbers and words. Example: "50th Percentile?" → "50th_percentile" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

NamesConversion bool

Converts column names to a SQL-compliant format (snake_case, lowercase, etc). If enabled, you can further customize the sanitization using the options below. Default: false

RemoveLeadingTrailingUnderscores bool

Removes leading and trailing underscores from column names. Does not remove leading underscores from column names that start with a number. Example: "50th Percentile? "→ "_50_th_percentile" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

RemoveSpecialCharacters bool

Removes all special characters from column names. Example: "Example ID*" → "example_id" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

StreamNameOverrides List<SourceGoogleSheetsConfigurationStreamNameOverride>

Overridden streams will default to Sync Mode: Full Refresh (Append), which does not support primary keys. If you want to use primary keys and deduplication, update the sync mode to "Full Refresh | Overwrite + Deduped" in your connection settings. Allows you to rename streams (Google Sheet tab names) as they appear in Airbyte. Each item should be an object with a source_stream_name (the exact name of the sheet/tab in your spreadsheet) and a custom_stream_name (the name you want it to appear as in Airbyte and the destination). If a source_stream_name is not found in your spreadsheet, it will be ignored and the default name will be used. This feature only affects stream (sheet/tab) names, not field/column names. If you want to rename fields or column names, you can do so using the Airbyte Mappings feature after your connection is created. See the Airbyte documentation for more details on how to use Mappings. Examples:

To rename a sheet called "Sheet1" to "sales_data", and "2024 Q1" to "q1_2024": [ { "source_stream_name": "Sheet1", "custom_stream_name": "sales_data" }, { "source_stream_name": "2024 Q1", "custom_stream_name": "q1_2024" } ]
If you do not wish to rename any streams, leave this blank.

Credentials SourceGoogleSheetsConfigurationCredentials

Credentials for connecting to the Google Sheets API

SpreadsheetId string

Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.

AllowLeadingNumbers bool

BatchSize float64

CombineLetterNumberPairs bool

Combines adjacent letters and numbers. Example: "Q3 2023" → "q3_2023" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

CombineNumberWordPairs bool

NamesConversion bool

Converts column names to a SQL-compliant format (snake_case, lowercase, etc). If enabled, you can further customize the sanitization using the options below. Default: false

RemoveLeadingTrailingUnderscores bool

RemoveSpecialCharacters bool

StreamNameOverrides []SourceGoogleSheetsConfigurationStreamNameOverride

To rename a sheet called "Sheet1" to "sales_data", and "2024 Q1" to "q1_2024": [ { "source_stream_name": "Sheet1", "custom_stream_name": "sales_data" }, { "source_stream_name": "2024 Q1", "custom_stream_name": "q1_2024" } ]
If you do not wish to rename any streams, leave this blank.

credentials SourceGoogleSheetsConfigurationCredentials

Credentials for connecting to the Google Sheets API

spreadsheetId String

Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.

allowLeadingNumbers Boolean

batchSize Double

combineLetterNumberPairs Boolean

Combines adjacent letters and numbers. Example: "Q3 2023" → "q3_2023" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

combineNumberWordPairs Boolean

namesConversion Boolean

Converts column names to a SQL-compliant format (snake_case, lowercase, etc). If enabled, you can further customize the sanitization using the options below. Default: false

removeLeadingTrailingUnderscores Boolean

removeSpecialCharacters Boolean

streamNameOverrides List<SourceGoogleSheetsConfigurationStreamNameOverride>

To rename a sheet called "Sheet1" to "sales_data", and "2024 Q1" to "q1_2024": [ { "source_stream_name": "Sheet1", "custom_stream_name": "sales_data" }, { "source_stream_name": "2024 Q1", "custom_stream_name": "q1_2024" } ]
If you do not wish to rename any streams, leave this blank.

credentials SourceGoogleSheetsConfigurationCredentials

Credentials for connecting to the Google Sheets API

spreadsheetId string

Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.

allowLeadingNumbers boolean

batchSize number

combineLetterNumberPairs boolean

Combines adjacent letters and numbers. Example: "Q3 2023" → "q3_2023" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

combineNumberWordPairs boolean

namesConversion boolean

Converts column names to a SQL-compliant format (snake_case, lowercase, etc). If enabled, you can further customize the sanitization using the options below. Default: false

removeLeadingTrailingUnderscores boolean

removeSpecialCharacters boolean

streamNameOverrides SourceGoogleSheetsConfigurationStreamNameOverride[]

To rename a sheet called "Sheet1" to "sales_data", and "2024 Q1" to "q1_2024": [ { "source_stream_name": "Sheet1", "custom_stream_name": "sales_data" }, { "source_stream_name": "2024 Q1", "custom_stream_name": "q1_2024" } ]
If you do not wish to rename any streams, leave this blank.

credentials SourceGoogleSheetsConfigurationCredentials

Credentials for connecting to the Google Sheets API

spreadsheet_id str

Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.

allow_leading_numbers bool

batch_size float

combine_letter_number_pairs bool

Combines adjacent letters and numbers. Example: "Q3 2023" → "q3_2023" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

combine_number_word_pairs bool

names_conversion bool

Converts column names to a SQL-compliant format (snake_case, lowercase, etc). If enabled, you can further customize the sanitization using the options below. Default: false

remove_leading_trailing_underscores bool

remove_special_characters bool

stream_name_overrides Sequence[SourceGoogleSheetsConfigurationStreamNameOverride]

To rename a sheet called "Sheet1" to "sales_data", and "2024 Q1" to "q1_2024": [ { "source_stream_name": "Sheet1", "custom_stream_name": "sales_data" }, { "source_stream_name": "2024 Q1", "custom_stream_name": "q1_2024" } ]
If you do not wish to rename any streams, leave this blank.

credentials Property Map

Credentials for connecting to the Google Sheets API

spreadsheetId String

Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.

allowLeadingNumbers Boolean

batchSize Number

combineLetterNumberPairs Boolean

Combines adjacent letters and numbers. Example: "Q3 2023" → "q3_2023" This option will only work if "Convert Column Names to SQL-Compliant Format (names_conversion)" is enabled. Default: false

combineNumberWordPairs Boolean

namesConversion Boolean

Converts column names to a SQL-compliant format (snake_case, lowercase, etc). If enabled, you can further customize the sanitization using the options below. Default: false

removeLeadingTrailingUnderscores Boolean

removeSpecialCharacters Boolean

streamNameOverrides List<Property Map>

To rename a sheet called "Sheet1" to "sales_data", and "2024 Q1" to "q1_2024": [ { "source_stream_name": "Sheet1", "custom_stream_name": "sales_data" }, { "source_stream_name": "2024 Q1", "custom_stream_name": "q1_2024" } ]
If you do not wish to rename any streams, leave this blank.

SourceGoogleSheetsConfigurationCredentials, SourceGoogleSheetsConfigurationCredentialsArgs

AuthenticateViaGoogleOAuth SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth
ServiceAccountKeyAuthentication SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication

AuthenticateViaGoogleOAuth SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth
ServiceAccountKeyAuthentication SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication

authenticateViaGoogleOAuth SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth
serviceAccountKeyAuthentication SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication

authenticateViaGoogleOAuth SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth
serviceAccountKeyAuthentication SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication

authenticate_via_google_o_auth SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth
service_account_key_authentication SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication

authenticateViaGoogleOAuth Property Map
serviceAccountKeyAuthentication Property Map

SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth, SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs

ClientId string: Enter your Google application's Client ID. See Google's documentation for more information.
ClientSecret string: Enter your Google application's Client Secret. See Google's documentation for more information.
RefreshToken string: Enter your Google application's refresh token. See Google's documentation for more information.

ClientId string: Enter your Google application's Client ID. See Google's documentation for more information.
ClientSecret string: Enter your Google application's Client Secret. See Google's documentation for more information.
RefreshToken string: Enter your Google application's refresh token. See Google's documentation for more information.

clientId String: Enter your Google application's Client ID. See Google's documentation for more information.
clientSecret String: Enter your Google application's Client Secret. See Google's documentation for more information.
refreshToken String: Enter your Google application's refresh token. See Google's documentation for more information.

clientId string: Enter your Google application's Client ID. See Google's documentation for more information.
clientSecret string: Enter your Google application's Client Secret. See Google's documentation for more information.
refreshToken string: Enter your Google application's refresh token. See Google's documentation for more information.

client_id str: Enter your Google application's Client ID. See Google's documentation for more information.
client_secret str: Enter your Google application's Client Secret. See Google's documentation for more information.
refresh_token str: Enter your Google application's refresh token. See Google's documentation for more information.

clientId String: Enter your Google application's Client ID. See Google's documentation for more information.
clientSecret String: Enter your Google application's Client Secret. See Google's documentation for more information.
refreshToken String: Enter your Google application's refresh token. See Google's documentation for more information.

SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication, SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs

ServiceAccountInfo string: The JSON key of the service account to use for authorization. Read more here.

ServiceAccountInfo string: The JSON key of the service account to use for authorization. Read more here.

serviceAccountInfo String: The JSON key of the service account to use for authorization. Read more here.

serviceAccountInfo string: The JSON key of the service account to use for authorization. Read more here.

service_account_info str: The JSON key of the service account to use for authorization. Read more here.

serviceAccountInfo String: The JSON key of the service account to use for authorization. Read more here.

SourceGoogleSheetsConfigurationStreamNameOverride, SourceGoogleSheetsConfigurationStreamNameOverrideArgs

CustomStreamName string: The name you want this stream to appear as in Airbyte and your destination.
SourceStreamName string: The exact name of the sheet/tab in your Google Spreadsheet.

CustomStreamName string: The name you want this stream to appear as in Airbyte and your destination.
SourceStreamName string: The exact name of the sheet/tab in your Google Spreadsheet.

customStreamName String: The name you want this stream to appear as in Airbyte and your destination.
sourceStreamName String: The exact name of the sheet/tab in your Google Spreadsheet.

customStreamName string: The name you want this stream to appear as in Airbyte and your destination.
sourceStreamName string: The exact name of the sheet/tab in your Google Spreadsheet.

custom_stream_name str: The name you want this stream to appear as in Airbyte and your destination.
source_stream_name str: The exact name of the sheet/tab in your Google Spreadsheet.

customStreamName String: The name you want this stream to appear as in Airbyte and your destination.
sourceStreamName String: The exact name of the sheet/tab in your Google Spreadsheet.

SourceGoogleSheetsResourceAllocation, SourceGoogleSheetsResourceAllocationArgs

Default SourceGoogleSheetsResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceGoogleSheetsResourceAllocationJobSpecific>

Default SourceGoogleSheetsResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceGoogleSheetsResourceAllocationJobSpecific

default_ SourceGoogleSheetsResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceGoogleSheetsResourceAllocationJobSpecific>

default SourceGoogleSheetsResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceGoogleSheetsResourceAllocationJobSpecific[]

default SourceGoogleSheetsResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceGoogleSheetsResourceAllocationJobSpecific]

default Property Map: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceGoogleSheetsResourceAllocationDefault, SourceGoogleSheetsResourceAllocationDefaultArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

SourceGoogleSheetsResourceAllocationJobSpecific, SourceGoogleSheetsResourceAllocationJobSpecificArgs

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
ResourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
ResourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
resourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType string: enum that describes the different types of jobs that the platform runs. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
resourceRequirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

job_type str: enum that describes the different types of jobs that the platform runs. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
resource_requirements SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["get_spec", "check_connection", "discover_schema", "sync", "reset_connection", "connection_updater", "replicate"]
resourceRequirements Property Map: optional resource requirements to run workers (blank for unbounded allocations)

SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements, SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirementsArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

Import

$ pulumi import airbyte:index/sourceGoogleSheets:SourceGoogleSheets my_airbyte_source_google_sheets ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.13.0 published on Friday, Jun 13, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceGoogleSheets

On this page

On this page

Example Usage

Create SourceGoogleSheets Resource

Constructor syntax

Parameters

Constructor example

SourceGoogleSheets Resource Properties

Inputs

Outputs

Look up Existing SourceGoogleSheets Resource

Supporting Types

SourceGoogleSheetsConfiguration, SourceGoogleSheetsConfigurationArgs

SourceGoogleSheetsConfigurationCredentials, SourceGoogleSheetsConfigurationCredentialsArgs

SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuth, SourceGoogleSheetsConfigurationCredentialsAuthenticateViaGoogleOAuthArgs

SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthentication, SourceGoogleSheetsConfigurationCredentialsServiceAccountKeyAuthenticationArgs

SourceGoogleSheetsConfigurationStreamNameOverride, SourceGoogleSheetsConfigurationStreamNameOverrideArgs

SourceGoogleSheetsResourceAllocation, SourceGoogleSheetsResourceAllocationArgs

SourceGoogleSheetsResourceAllocationDefault, SourceGoogleSheetsResourceAllocationDefaultArgs

SourceGoogleSheetsResourceAllocationJobSpecific, SourceGoogleSheetsResourceAllocationJobSpecificArgs

SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirements, SourceGoogleSheetsResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page