Skip to content

Latest commit

 

History

History
135 lines (97 loc) · 5.82 KB

source_google_search_console.md

File metadata and controls

135 lines (97 loc) · 5.82 KB
page_title subcategory description
airbyte_source_google_search_console Resource - terraform-provider-airbyte
SourceGoogleSearchConsole Resource

airbyte_source_google_search_console (Resource)

SourceGoogleSearchConsole Resource

Example Usage

resource "airbyte_source_google_search_console" "my_source_googlesearchconsole" {
  configuration = {
    authorization = {
      o_auth = {
        access_token  = "...my_access_token..."
        client_id     = "...my_client_id..."
        client_secret = "...my_client_secret..."
        refresh_token = "...my_refresh_token..."
      }
      service_account_key_authentication = {
        email                = "...my_email..."
        service_account_info = "{ \"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"
  }
  definition_id = "38737380-4b05-400b-8478-4fc78e02be0f"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "6406adf4-523d-4b9e-8f60-e386f18bd02c"
}

Schema

Required

  • configuration (Attributes) (see below for nested schema)
  • name (String) Name of the source e.g. dev-mysql-instance.
  • workspace_id (String)

Optional

  • definition_id (String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
  • secret_id (String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Read-Only

  • created_at (Number)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • authorization (Attributes) (see below for nested schema)
  • site_urls (List of String) The URLs of the website property attached to your GSC account. Learn more about properties here.

Optional:

  • custom_reports_array (Attributes List) You can add your Custom Analytics report by creating one. (see below for nested schema)
  • data_state (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 full documentation. Default: "final"; must be one of ["final", "all"]
  • end_date (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.
  • start_date (String) UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. Default: "2021-01-01"

Nested Schema for configuration.authorization

Optional:

Nested Schema for configuration.authorization.o_auth

Required:

  • client_id (String, Sensitive) The client ID of your Google Search Console developer application. Read more here.
  • client_secret (String, Sensitive) The client secret of your Google Search Console developer application. Read more here.
  • refresh_token (String, Sensitive) The token for obtaining a new access token. Read more here.

Optional:

  • access_token (String, Sensitive) Access token for making authenticated requests. Read more here.

Nested Schema for configuration.authorization.service_account_key_authentication

Required:

  • email (String) The email of the user which has permissions to access the Google Workspace Admin APIs.
  • service_account_info (String, Sensitive) The JSON key of the service account to use for authorization. Read more here.

Nested Schema for configuration.custom_reports_array

Required:

  • name (String) The name of the custom report, this name would be used as stream name

Optional:

  • dimensions (List of 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.

Import

Import is supported using the following syntax:

terraform import airbyte_source_google_search_console.my_airbyte_source_google_search_console ""