1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceGoogleSearchConsole
airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbyte.SourceGoogleSearchConsole

Explore with Pulumi AI

SourceGoogleSearchConsole 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.SourceGoogleSearchConsole;
import com.pulumi.airbyte.SourceGoogleSearchConsoleArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSearchConsoleConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSearchConsoleConfigurationAuthorizationArgs;
import com.pulumi.airbyte.inputs.SourceGoogleSearchConsoleConfigurationAuthorizationServiceAccountKeyAuthenticationArgs;
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 mySourceGooglesearchconsole = new SourceGoogleSearchConsole("mySourceGooglesearchconsole", SourceGoogleSearchConsoleArgs.builder()
            .configuration(SourceGoogleSearchConsoleConfigurationArgs.builder()
                .authorization(SourceGoogleSearchConsoleConfigurationAuthorizationArgs.builder()
                    .serviceAccountKeyAuthentication(SourceGoogleSearchConsoleConfigurationAuthorizationServiceAccountKeyAuthenticationArgs.builder()
                        .email("...my_email...")
                        .serviceAccountInfo("{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID, \"private_key_id\": YOUR_PRIVATE_KEY, ... }")
                        .build())
                    .build())
                .custom_reports_array(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .data_state("final")
                .end_date("2021-12-12")
                .site_urls("...")
                .start_date("2022-02-19")
                .build())
            .definitionId("38737380-4b05-400b-8478-4fc78e02be0f")
            .secretId("...my_secret_id...")
            .workspaceId("6406adf4-523d-4b9e-8f60-e386f18bd02c")
            .build());

    }
}
Copy
resources:
  mySourceGooglesearchconsole:
    type: airbyte:SourceGoogleSearchConsole
    properties:
      configuration:
        authorization:
          serviceAccountKeyAuthentication:
            email: '...my_email...'
            serviceAccountInfo: '{ "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... }'
        custom_reports_array:
          - dimensions: []
            name: '...my_name...'
        data_state: final
        end_date: 2021-12-12
        site_urls:
          - '...'
        start_date: 2022-02-19
      definitionId: 38737380-4b05-400b-8478-4fc78e02be0f
      secretId: '...my_secret_id...'
      workspaceId: 6406adf4-523d-4b9e-8f60-e386f18bd02c
Copy

Create SourceGoogleSearchConsole Resource

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

Constructor syntax

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

@overload
def SourceGoogleSearchConsole(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              configuration: Optional[SourceGoogleSearchConsoleConfigurationArgs] = None,
                              workspace_id: Optional[str] = None,
                              definition_id: Optional[str] = None,
                              name: Optional[str] = None,
                              secret_id: Optional[str] = None)
func NewSourceGoogleSearchConsole(ctx *Context, name string, args SourceGoogleSearchConsoleArgs, opts ...ResourceOption) (*SourceGoogleSearchConsole, error)
public SourceGoogleSearchConsole(string name, SourceGoogleSearchConsoleArgs args, CustomResourceOptions? opts = null)
public SourceGoogleSearchConsole(String name, SourceGoogleSearchConsoleArgs args)
public SourceGoogleSearchConsole(String name, SourceGoogleSearchConsoleArgs args, CustomResourceOptions options)
type: airbyte:SourceGoogleSearchConsole
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. SourceGoogleSearchConsoleArgs
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. SourceGoogleSearchConsoleArgs
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. SourceGoogleSearchConsoleArgs
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. SourceGoogleSearchConsoleArgs
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. SourceGoogleSearchConsoleArgs
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 sourceGoogleSearchConsoleResource = new Airbyte.SourceGoogleSearchConsole("sourceGoogleSearchConsoleResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGoogleSearchConsoleConfigurationArgs
    {
        Authorization = new Airbyte.Inputs.SourceGoogleSearchConsoleConfigurationAuthorizationArgs
        {
            OAuth = new Airbyte.Inputs.SourceGoogleSearchConsoleConfigurationAuthorizationOAuthArgs
            {
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
                AccessToken = "string",
            },
            ServiceAccountKeyAuthentication = new Airbyte.Inputs.SourceGoogleSearchConsoleConfigurationAuthorizationServiceAccountKeyAuthenticationArgs
            {
                Email = "string",
                ServiceAccountInfo = "string",
            },
        },
        SiteUrls = new[]
        {
            "string",
        },
        CustomReportsArrays = new[]
        {
            new Airbyte.Inputs.SourceGoogleSearchConsoleConfigurationCustomReportsArrayArgs
            {
                Name = "string",
                Dimensions = new[]
                {
                    "string",
                },
            },
        },
        DataState = "string",
        EndDate = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceGoogleSearchConsole(ctx, "sourceGoogleSearchConsoleResource", &airbyte.SourceGoogleSearchConsoleArgs{
Configuration: &.SourceGoogleSearchConsoleConfigurationArgs{
Authorization: &.SourceGoogleSearchConsoleConfigurationAuthorizationArgs{
OAuth: &.SourceGoogleSearchConsoleConfigurationAuthorizationOAuthArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
AccessToken: pulumi.String("string"),
},
ServiceAccountKeyAuthentication: &.SourceGoogleSearchConsoleConfigurationAuthorizationServiceAccountKeyAuthenticationArgs{
Email: pulumi.String("string"),
ServiceAccountInfo: pulumi.String("string"),
},
},
SiteUrls: pulumi.StringArray{
pulumi.String("string"),
},
CustomReportsArrays: .SourceGoogleSearchConsoleConfigurationCustomReportsArrayArray{
&.SourceGoogleSearchConsoleConfigurationCustomReportsArrayArgs{
Name: pulumi.String("string"),
Dimensions: pulumi.StringArray{
pulumi.String("string"),
},
},
},
DataState: 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 sourceGoogleSearchConsoleResource = new SourceGoogleSearchConsole("sourceGoogleSearchConsoleResource", SourceGoogleSearchConsoleArgs.builder()
    .configuration(SourceGoogleSearchConsoleConfigurationArgs.builder()
        .authorization(SourceGoogleSearchConsoleConfigurationAuthorizationArgs.builder()
            .oAuth(SourceGoogleSearchConsoleConfigurationAuthorizationOAuthArgs.builder()
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .accessToken("string")
                .build())
            .serviceAccountKeyAuthentication(SourceGoogleSearchConsoleConfigurationAuthorizationServiceAccountKeyAuthenticationArgs.builder()
                .email("string")
                .serviceAccountInfo("string")
                .build())
            .build())
        .siteUrls("string")
        .customReportsArrays(SourceGoogleSearchConsoleConfigurationCustomReportsArrayArgs.builder()
            .name("string")
            .dimensions("string")
            .build())
        .dataState("string")
        .endDate("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_google_search_console_resource = airbyte.SourceGoogleSearchConsole("sourceGoogleSearchConsoleResource",
    configuration={
        "authorization": {
            "o_auth": {
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
                "access_token": "string",
            },
            "service_account_key_authentication": {
                "email": "string",
                "service_account_info": "string",
            },
        },
        "site_urls": ["string"],
        "custom_reports_arrays": [{
            "name": "string",
            "dimensions": ["string"],
        }],
        "data_state": "string",
        "end_date": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceGoogleSearchConsoleResource = new airbyte.SourceGoogleSearchConsole("sourceGoogleSearchConsoleResource", {
    configuration: {
        authorization: {
            oAuth: {
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
                accessToken: "string",
            },
            serviceAccountKeyAuthentication: {
                email: "string",
                serviceAccountInfo: "string",
            },
        },
        siteUrls: ["string"],
        customReportsArrays: [{
            name: "string",
            dimensions: ["string"],
        }],
        dataState: "string",
        endDate: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceGoogleSearchConsole
properties:
    configuration:
        authorization:
            oAuth:
                accessToken: string
                clientId: string
                clientSecret: string
                refreshToken: string
            serviceAccountKeyAuthentication:
                email: string
                serviceAccountInfo: string
        customReportsArrays:
            - dimensions:
                - string
              name: string
        dataState: string
        endDate: string
        siteUrls:
            - string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceGoogleSearchConsoleConfiguration
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. SourceGoogleSearchConsoleConfigurationArgs
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. SourceGoogleSearchConsoleConfiguration
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. SourceGoogleSearchConsoleConfiguration
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. SourceGoogleSearchConsoleConfigurationArgs
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 SourceGoogleSearchConsole resource produces the following output properties:

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

Get an existing SourceGoogleSearchConsole 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?: SourceGoogleSearchConsoleState, opts?: CustomResourceOptions): SourceGoogleSearchConsole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceGoogleSearchConsoleConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceGoogleSearchConsoleResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceGoogleSearchConsole
func GetSourceGoogleSearchConsole(ctx *Context, name string, id IDInput, state *SourceGoogleSearchConsoleState, opts ...ResourceOption) (*SourceGoogleSearchConsole, error)
public static SourceGoogleSearchConsole Get(string name, Input<string> id, SourceGoogleSearchConsoleState? state, CustomResourceOptions? opts = null)
public static SourceGoogleSearchConsole get(String name, Output<String> id, SourceGoogleSearchConsoleState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceGoogleSearchConsole    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 SourceGoogleSearchConsoleConfiguration
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 SourceGoogleSearchConsoleResourceAllocation
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 SourceGoogleSearchConsoleConfigurationArgs
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 SourceGoogleSearchConsoleResourceAllocationArgs
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 SourceGoogleSearchConsoleConfiguration
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 SourceGoogleSearchConsoleResourceAllocation
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 SourceGoogleSearchConsoleConfiguration
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 SourceGoogleSearchConsoleResourceAllocation
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 SourceGoogleSearchConsoleConfigurationArgs
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 SourceGoogleSearchConsoleResourceAllocationArgs
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

SourceGoogleSearchConsoleConfiguration
, SourceGoogleSearchConsoleConfigurationArgs

Authorization This property is required. SourceGoogleSearchConsoleConfigurationAuthorization
SiteUrls This property is required. List<string>
The URLs of the website property attached to your GSC account. Learn more about properties \n\nhere\n\n.
CustomReportsArrays List<SourceGoogleSearchConsoleConfigurationCustomReportsArray>
You can add your Custom Analytics report by creating one.
DataState string
If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our \n\nfull documentation\n\n. Default: "final"; must be one of ["final", "all"]
EndDate string
UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.
StartDate string
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. Default: "2021-01-01"
Authorization This property is required. SourceGoogleSearchConsoleConfigurationAuthorization
SiteUrls This property is required. []string
The URLs of the website property attached to your GSC account. Learn more about properties \n\nhere\n\n.
CustomReportsArrays []SourceGoogleSearchConsoleConfigurationCustomReportsArray
You can add your Custom Analytics report by creating one.
DataState string
If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our \n\nfull documentation\n\n. Default: "final"; must be one of ["final", "all"]
EndDate string
UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.
StartDate string
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. Default: "2021-01-01"
authorization This property is required. SourceGoogleSearchConsoleConfigurationAuthorization
siteUrls This property is required. List<String>
The URLs of the website property attached to your GSC account. Learn more about properties \n\nhere\n\n.
customReportsArrays List<SourceGoogleSearchConsoleConfigurationCustomReportsArray>
You can add your Custom Analytics report by creating one.
dataState String
If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our \n\nfull documentation\n\n. Default: "final"; must be one of ["final", "all"]
endDate String
UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.
startDate String
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. Default: "2021-01-01"
authorization This property is required. SourceGoogleSearchConsoleConfigurationAuthorization
siteUrls This property is required. string[]
The URLs of the website property attached to your GSC account. Learn more about properties \n\nhere\n\n.
customReportsArrays SourceGoogleSearchConsoleConfigurationCustomReportsArray[]
You can add your Custom Analytics report by creating one.
dataState string
If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our \n\nfull documentation\n\n. Default: "final"; must be one of ["final", "all"]
endDate string
UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.
startDate string
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. Default: "2021-01-01"
authorization This property is required. SourceGoogleSearchConsoleConfigurationAuthorization
site_urls This property is required. Sequence[str]
The URLs of the website property attached to your GSC account. Learn more about properties \n\nhere\n\n.
custom_reports_arrays Sequence[SourceGoogleSearchConsoleConfigurationCustomReportsArray]
You can add your Custom Analytics report by creating one.
data_state str
If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our \n\nfull documentation\n\n. Default: "final"; must be one of ["final", "all"]
end_date str
UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.
start_date str
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. Default: "2021-01-01"
authorization This property is required. Property Map
siteUrls This property is required. List<String>
The URLs of the website property attached to your GSC account. Learn more about properties \n\nhere\n\n.
customReportsArrays List<Property Map>
You can add your Custom Analytics report by creating one.
dataState String
If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our \n\nfull documentation\n\n. Default: "final"; must be one of ["final", "all"]
endDate String
UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.
startDate String
UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. Default: "2021-01-01"

SourceGoogleSearchConsoleConfigurationAuthorization
, SourceGoogleSearchConsoleConfigurationAuthorizationArgs

SourceGoogleSearchConsoleConfigurationAuthorizationOAuth
, SourceGoogleSearchConsoleConfigurationAuthorizationOAuthArgs

ClientId This property is required. string
The client ID of your Google Search Console developer application. Read more \n\nhere\n\n.
ClientSecret This property is required. string
The client secret of your Google Search Console developer application. Read more \n\nhere\n\n.
RefreshToken This property is required. string
The token for obtaining a new access token. Read more \n\nhere\n\n.
AccessToken string
Access token for making authenticated requests. Read more \n\nhere\n\n.
ClientId This property is required. string
The client ID of your Google Search Console developer application. Read more \n\nhere\n\n.
ClientSecret This property is required. string
The client secret of your Google Search Console developer application. Read more \n\nhere\n\n.
RefreshToken This property is required. string
The token for obtaining a new access token. Read more \n\nhere\n\n.
AccessToken string
Access token for making authenticated requests. Read more \n\nhere\n\n.
clientId This property is required. String
The client ID of your Google Search Console developer application. Read more \n\nhere\n\n.
clientSecret This property is required. String
The client secret of your Google Search Console developer application. Read more \n\nhere\n\n.
refreshToken This property is required. String
The token for obtaining a new access token. Read more \n\nhere\n\n.
accessToken String
Access token for making authenticated requests. Read more \n\nhere\n\n.
clientId This property is required. string
The client ID of your Google Search Console developer application. Read more \n\nhere\n\n.
clientSecret This property is required. string
The client secret of your Google Search Console developer application. Read more \n\nhere\n\n.
refreshToken This property is required. string
The token for obtaining a new access token. Read more \n\nhere\n\n.
accessToken string
Access token for making authenticated requests. Read more \n\nhere\n\n.
client_id This property is required. str
The client ID of your Google Search Console developer application. Read more \n\nhere\n\n.
client_secret This property is required. str
The client secret of your Google Search Console developer application. Read more \n\nhere\n\n.
refresh_token This property is required. str
The token for obtaining a new access token. Read more \n\nhere\n\n.
access_token str
Access token for making authenticated requests. Read more \n\nhere\n\n.
clientId This property is required. String
The client ID of your Google Search Console developer application. Read more \n\nhere\n\n.
clientSecret This property is required. String
The client secret of your Google Search Console developer application. Read more \n\nhere\n\n.
refreshToken This property is required. String
The token for obtaining a new access token. Read more \n\nhere\n\n.
accessToken String
Access token for making authenticated requests. Read more \n\nhere\n\n.

SourceGoogleSearchConsoleConfigurationAuthorizationServiceAccountKeyAuthentication
, SourceGoogleSearchConsoleConfigurationAuthorizationServiceAccountKeyAuthenticationArgs

Email This property is required. string
The email of the user which has permissions to access the Google Workspace Admin APIs.
ServiceAccountInfo This property is required. string
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
Email This property is required. string
The email of the user which has permissions to access the Google Workspace Admin APIs.
ServiceAccountInfo This property is required. string
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
email This property is required. String
The email of the user which has permissions to access the Google Workspace Admin APIs.
serviceAccountInfo This property is required. String
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
email This property is required. string
The email of the user which has permissions to access the Google Workspace Admin APIs.
serviceAccountInfo This property is required. string
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
email This property is required. str
The email of the user which has permissions to access the Google Workspace Admin APIs.
service_account_info This property is required. str
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.
email This property is required. String
The email of the user which has permissions to access the Google Workspace Admin APIs.
serviceAccountInfo This property is required. String
The JSON key of the service account to use for authorization. Read more \n\nhere\n\n.

SourceGoogleSearchConsoleConfigurationCustomReportsArray
, SourceGoogleSearchConsoleConfigurationCustomReportsArrayArgs

Name This property is required. string
The name of the custom report, this name would be used as stream name
Dimensions List<string>
A list of available dimensions. Please note, that for technical reasons date is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with site_url and search_type.
Name This property is required. string
The name of the custom report, this name would be used as stream name
Dimensions []string
A list of available dimensions. Please note, that for technical reasons date is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with site_url and search_type.
name This property is required. String
The name of the custom report, this name would be used as stream name
dimensions List<String>
A list of available dimensions. Please note, that for technical reasons date is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with site_url and search_type.
name This property is required. string
The name of the custom report, this name would be used as stream name
dimensions string[]
A list of available dimensions. Please note, that for technical reasons date is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with site_url and search_type.
name This property is required. str
The name of the custom report, this name would be used as stream name
dimensions Sequence[str]
A list of available dimensions. Please note, that for technical reasons date is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with site_url and search_type.
name This property is required. String
The name of the custom report, this name would be used as stream name
dimensions List<String>
A list of available dimensions. Please note, that for technical reasons date is the default dimension which will be included in your query whether you specify it or not. Primary key will consist of your custom dimensions and the default dimension along with site_url and search_type.

SourceGoogleSearchConsoleResourceAllocation
, SourceGoogleSearchConsoleResourceAllocationArgs

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

SourceGoogleSearchConsoleResourceAllocationDefault
, SourceGoogleSearchConsoleResourceAllocationDefaultArgs

SourceGoogleSearchConsoleResourceAllocationJobSpecific
, SourceGoogleSearchConsoleResourceAllocationJobSpecificArgs

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 SourceGoogleSearchConsoleResourceAllocationJobSpecificResourceRequirements
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 SourceGoogleSearchConsoleResourceAllocationJobSpecificResourceRequirements
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 SourceGoogleSearchConsoleResourceAllocationJobSpecificResourceRequirements
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 SourceGoogleSearchConsoleResourceAllocationJobSpecificResourceRequirements
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 SourceGoogleSearchConsoleResourceAllocationJobSpecificResourceRequirements
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)

SourceGoogleSearchConsoleResourceAllocationJobSpecificResourceRequirements
, SourceGoogleSearchConsoleResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceGoogleSearchConsole:SourceGoogleSearchConsole my_airbyte_source_google_search_console ""
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.