1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceGoogleAds
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceGoogleAds

Explore with Pulumi AI

SourceGoogleAds Resource

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.SourceGoogleAds;
import com.pulumi.airbyte.SourceGoogleAdsArgs;
import com.pulumi.airbyte.inputs.SourceGoogleAdsConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceGoogleAdsConfigurationCredentialsArgs;
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 mySourceGoogleads = new SourceGoogleAds("mySourceGoogleads", SourceGoogleAdsArgs.builder()
            .configuration(SourceGoogleAdsConfigurationArgs.builder()
                .conversion_window_days(14)
                .credentials(SourceGoogleAdsConfigurationCredentialsArgs.builder()
                    .accessToken("...my_access_token...")
                    .clientId("...my_client_id...")
                    .clientSecret("...my_client_secret...")
                    .developerToken("...my_developer_token...")
                    .refreshToken("...my_refresh_token...")
                    .build())
                .custom_queries_array(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .customer_id("6783948572,5839201945")
                .customer_status_filter("SUSPENDED")
                .end_date("2017-01-30")
                .start_date("2017-01-25")
                .build())
            .definitionId("340bf2e2-1dfb-458f-b22d-521448c56250")
            .secretId("...my_secret_id...")
            .workspaceId("b2e3af36-07c6-4325-9aae-252084b9ca1b")
            .build());

    }
}
Copy
resources:
  mySourceGoogleads:
    type: airbyte:SourceGoogleAds
    properties:
      configuration:
        conversion_window_days: 14
        credentials:
          accessToken: '...my_access_token...'
          clientId: '...my_client_id...'
          clientSecret: '...my_client_secret...'
          developerToken: '...my_developer_token...'
          refreshToken: '...my_refresh_token...'
        custom_queries_array:
          - query: SELECT segments.ad_destination_type, campaign.advertising_channel_sub_type FROM campaign WHERE campaign.status = 'PAUSED'
            tableName: '...my_table_name...'
        customer_id: 6783948572,5839201945
        customer_status_filter:
          - SUSPENDED
        end_date: 2017-01-30
        start_date: 2017-01-25
      definitionId: 340bf2e2-1dfb-458f-b22d-521448c56250
      secretId: '...my_secret_id...'
      workspaceId: b2e3af36-07c6-4325-9aae-252084b9ca1b
Copy

Create SourceGoogleAds Resource

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

Constructor syntax

new SourceGoogleAds(name: string, args: SourceGoogleAdsArgs, opts?: CustomResourceOptions);
@overload
def SourceGoogleAds(resource_name: str,
                    args: SourceGoogleAdsArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SourceGoogleAds(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceGoogleAdsConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)
func NewSourceGoogleAds(ctx *Context, name string, args SourceGoogleAdsArgs, opts ...ResourceOption) (*SourceGoogleAds, error)
public SourceGoogleAds(string name, SourceGoogleAdsArgs args, CustomResourceOptions? opts = null)
public SourceGoogleAds(String name, SourceGoogleAdsArgs args)
public SourceGoogleAds(String name, SourceGoogleAdsArgs args, CustomResourceOptions options)
type: airbyte:SourceGoogleAds
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceGoogleAdsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceGoogleAdsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceGoogleAdsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceGoogleAdsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceGoogleAdsArgs
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 sourceGoogleAdsResource = new Airbyte.SourceGoogleAds("sourceGoogleAdsResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGoogleAdsConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceGoogleAdsConfigurationCredentialsArgs
        {
            ClientId = "string",
            ClientSecret = "string",
            DeveloperToken = "string",
            RefreshToken = "string",
            AccessToken = "string",
        },
        ConversionWindowDays = 0,
        CustomQueriesArrays = new[]
        {
            new Airbyte.Inputs.SourceGoogleAdsConfigurationCustomQueriesArrayArgs
            {
                Query = "string",
                TableName = "string",
            },
        },
        CustomerId = "string",
        CustomerStatusFilters = new[]
        {
            "string",
        },
        EndDate = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceGoogleAds(ctx, "sourceGoogleAdsResource", &airbyte.SourceGoogleAdsArgs{
Configuration: &.SourceGoogleAdsConfigurationArgs{
Credentials: &.SourceGoogleAdsConfigurationCredentialsArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
DeveloperToken: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
AccessToken: pulumi.String("string"),
},
ConversionWindowDays: pulumi.Float64(0),
CustomQueriesArrays: .SourceGoogleAdsConfigurationCustomQueriesArrayArray{
&.SourceGoogleAdsConfigurationCustomQueriesArrayArgs{
Query: pulumi.String("string"),
TableName: pulumi.String("string"),
},
},
CustomerId: pulumi.String("string"),
CustomerStatusFilters: pulumi.StringArray{
pulumi.String("string"),
},
EndDate: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceGoogleAdsResource = new SourceGoogleAds("sourceGoogleAdsResource", SourceGoogleAdsArgs.builder()
    .configuration(SourceGoogleAdsConfigurationArgs.builder()
        .credentials(SourceGoogleAdsConfigurationCredentialsArgs.builder()
            .clientId("string")
            .clientSecret("string")
            .developerToken("string")
            .refreshToken("string")
            .accessToken("string")
            .build())
        .conversionWindowDays(0)
        .customQueriesArrays(SourceGoogleAdsConfigurationCustomQueriesArrayArgs.builder()
            .query("string")
            .tableName("string")
            .build())
        .customerId("string")
        .customerStatusFilters("string")
        .endDate("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_google_ads_resource = airbyte.SourceGoogleAds("sourceGoogleAdsResource",
    configuration={
        "credentials": {
            "client_id": "string",
            "client_secret": "string",
            "developer_token": "string",
            "refresh_token": "string",
            "access_token": "string",
        },
        "conversion_window_days": 0,
        "custom_queries_arrays": [{
            "query": "string",
            "table_name": "string",
        }],
        "customer_id": "string",
        "customer_status_filters": ["string"],
        "end_date": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceGoogleAdsResource = new airbyte.SourceGoogleAds("sourceGoogleAdsResource", {
    configuration: {
        credentials: {
            clientId: "string",
            clientSecret: "string",
            developerToken: "string",
            refreshToken: "string",
            accessToken: "string",
        },
        conversionWindowDays: 0,
        customQueriesArrays: [{
            query: "string",
            tableName: "string",
        }],
        customerId: "string",
        customerStatusFilters: ["string"],
        endDate: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceGoogleAds
properties:
    configuration:
        conversionWindowDays: 0
        credentials:
            accessToken: string
            clientId: string
            clientSecret: string
            developerToken: string
            refreshToken: string
        customQueriesArrays:
            - query: string
              tableName: string
        customerId: string
        customerStatusFilters:
            - string
        endDate: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourceGoogleAds 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 SourceGoogleAds resource accepts the following input properties:

Configuration This property is required. SourceGoogleAdsConfiguration
WorkspaceId This property is required. 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 This property is required. SourceGoogleAdsConfigurationArgs
WorkspaceId This property is required. 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 This property is required. SourceGoogleAdsConfiguration
workspaceId This property is required. 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 This property is required. SourceGoogleAdsConfiguration
workspaceId This property is required. 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 This property is required. SourceGoogleAdsConfigurationArgs
workspace_id This property is required. 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 This property is required. Property Map
workspaceId This property is required. 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 SourceGoogleAds resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceGoogleAdsResourceAllocation
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 SourceGoogleAdsResourceAllocation
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 SourceGoogleAdsResourceAllocation
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 SourceGoogleAdsResourceAllocation
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 SourceGoogleAdsResourceAllocation
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 SourceGoogleAds Resource

Get an existing SourceGoogleAds 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?: SourceGoogleAdsState, opts?: CustomResourceOptions): SourceGoogleAds
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceGoogleAdsConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceGoogleAdsResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceGoogleAds
func GetSourceGoogleAds(ctx *Context, name string, id IDInput, state *SourceGoogleAdsState, opts ...ResourceOption) (*SourceGoogleAds, error)
public static SourceGoogleAds Get(string name, Input<string> id, SourceGoogleAdsState? state, CustomResourceOptions? opts = null)
public static SourceGoogleAds get(String name, Output<String> id, SourceGoogleAdsState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceGoogleAds    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 SourceGoogleAdsConfiguration
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 SourceGoogleAdsResourceAllocation
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 SourceGoogleAdsConfigurationArgs
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 SourceGoogleAdsResourceAllocationArgs
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 SourceGoogleAdsConfiguration
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 SourceGoogleAdsResourceAllocation
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 SourceGoogleAdsConfiguration
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 SourceGoogleAdsResourceAllocation
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 SourceGoogleAdsConfigurationArgs
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 SourceGoogleAdsResourceAllocationArgs
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

SourceGoogleAdsConfiguration
, SourceGoogleAdsConfigurationArgs

Credentials This property is required. SourceGoogleAdsConfigurationCredentials
ConversionWindowDays double
A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see \n\nGoogle's documentation\n\n. Default: 14
CustomQueriesArrays List<SourceGoogleAdsConfigurationCustomQueriesArray>
CustomerId string
Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
CustomerStatusFilters List<string>
A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads \n\ndocumentation\n\n.
EndDate string
UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)
StartDate string
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)
Credentials This property is required. SourceGoogleAdsConfigurationCredentials
ConversionWindowDays float64
A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see \n\nGoogle's documentation\n\n. Default: 14
CustomQueriesArrays []SourceGoogleAdsConfigurationCustomQueriesArray
CustomerId string
Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
CustomerStatusFilters []string
A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads \n\ndocumentation\n\n.
EndDate string
UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)
StartDate string
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)
credentials This property is required. SourceGoogleAdsConfigurationCredentials
conversionWindowDays Double
A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see \n\nGoogle's documentation\n\n. Default: 14
customQueriesArrays List<SourceGoogleAdsConfigurationCustomQueriesArray>
customerId String
Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
customerStatusFilters List<String>
A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads \n\ndocumentation\n\n.
endDate String
UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)
startDate String
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)
credentials This property is required. SourceGoogleAdsConfigurationCredentials
conversionWindowDays number
A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see \n\nGoogle's documentation\n\n. Default: 14
customQueriesArrays SourceGoogleAdsConfigurationCustomQueriesArray[]
customerId string
Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
customerStatusFilters string[]
A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads \n\ndocumentation\n\n.
endDate string
UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)
startDate string
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)
credentials This property is required. SourceGoogleAdsConfigurationCredentials
conversion_window_days float
A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see \n\nGoogle's documentation\n\n. Default: 14
custom_queries_arrays Sequence[SourceGoogleAdsConfigurationCustomQueriesArray]
customer_id str
Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
customer_status_filters Sequence[str]
A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads \n\ndocumentation\n\n.
end_date str
UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)
start_date str
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)
credentials This property is required. Property Map
conversionWindowDays Number
A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see \n\nGoogle's documentation\n\n. Default: 14
customQueriesArrays List<Property Map>
customerId String
Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
customerStatusFilters List<String>
A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads \n\ndocumentation\n\n.
endDate String
UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)
startDate String
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)

SourceGoogleAdsConfigurationCredentials
, SourceGoogleAdsConfigurationCredentialsArgs

ClientId This property is required. string
The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
ClientSecret This property is required. string
The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
DeveloperToken This property is required. string
The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
RefreshToken This property is required. string
The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
AccessToken string
The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
ClientId This property is required. string
The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
ClientSecret This property is required. string
The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
DeveloperToken This property is required. string
The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
RefreshToken This property is required. string
The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
AccessToken string
The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
clientId This property is required. String
The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
clientSecret This property is required. String
The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
developerToken This property is required. String
The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
refreshToken This property is required. String
The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
accessToken String
The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
clientId This property is required. string
The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
clientSecret This property is required. string
The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
developerToken This property is required. string
The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
refreshToken This property is required. string
The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
accessToken string
The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
client_id This property is required. str
The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
client_secret This property is required. str
The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
developer_token This property is required. str
The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
refresh_token This property is required. str
The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
access_token str
The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
clientId This property is required. String
The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
clientSecret This property is required. String
The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
developerToken This property is required. String
The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
refreshToken This property is required. String
The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.
accessToken String
The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our \n\ndocumentation\n\n.

SourceGoogleAdsConfigurationCustomQueriesArray
, SourceGoogleAdsConfigurationCustomQueriesArrayArgs

Query This property is required. string
A custom defined GAQL query for building the report. Avoid including the segments.date field; wherever possible, Airbyte will automatically include it for incremental syncs. For more information, refer to \n\nGoogle's documentation\n\n.
TableName This property is required. string
The table name in your destination database for the chosen query.
Query This property is required. string
A custom defined GAQL query for building the report. Avoid including the segments.date field; wherever possible, Airbyte will automatically include it for incremental syncs. For more information, refer to \n\nGoogle's documentation\n\n.
TableName This property is required. string
The table name in your destination database for the chosen query.
query This property is required. String
A custom defined GAQL query for building the report. Avoid including the segments.date field; wherever possible, Airbyte will automatically include it for incremental syncs. For more information, refer to \n\nGoogle's documentation\n\n.
tableName This property is required. String
The table name in your destination database for the chosen query.
query This property is required. string
A custom defined GAQL query for building the report. Avoid including the segments.date field; wherever possible, Airbyte will automatically include it for incremental syncs. For more information, refer to \n\nGoogle's documentation\n\n.
tableName This property is required. string
The table name in your destination database for the chosen query.
query This property is required. str
A custom defined GAQL query for building the report. Avoid including the segments.date field; wherever possible, Airbyte will automatically include it for incremental syncs. For more information, refer to \n\nGoogle's documentation\n\n.
table_name This property is required. str
The table name in your destination database for the chosen query.
query This property is required. String
A custom defined GAQL query for building the report. Avoid including the segments.date field; wherever possible, Airbyte will automatically include it for incremental syncs. For more information, refer to \n\nGoogle's documentation\n\n.
tableName This property is required. String
The table name in your destination database for the chosen query.

SourceGoogleAdsResourceAllocation
, SourceGoogleAdsResourceAllocationArgs

Default SourceGoogleAdsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceGoogleAdsResourceAllocationJobSpecific>
Default SourceGoogleAdsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceGoogleAdsResourceAllocationJobSpecific
default_ SourceGoogleAdsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceGoogleAdsResourceAllocationJobSpecific>
default SourceGoogleAdsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceGoogleAdsResourceAllocationJobSpecific[]
default SourceGoogleAdsResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceGoogleAdsResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceGoogleAdsResourceAllocationDefault
, SourceGoogleAdsResourceAllocationDefaultArgs

SourceGoogleAdsResourceAllocationJobSpecific
, SourceGoogleAdsResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceGoogleAdsResourceAllocationJobSpecificResourceRequirements
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 ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceGoogleAdsResourceAllocationJobSpecificResourceRequirements
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 ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceGoogleAdsResourceAllocationJobSpecificResourceRequirements
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 ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceGoogleAdsResourceAllocationJobSpecificResourceRequirements
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 ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceGoogleAdsResourceAllocationJobSpecificResourceRequirements
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 ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourceGoogleAdsResourceAllocationJobSpecificResourceRequirements
, SourceGoogleAdsResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceGoogleAds:SourceGoogleAds my_airbyte_source_google_ads ""
Copy

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.