Skip to content

Latest commit

 

History

History
163 lines (114 loc) · 7.29 KB

source_linkedin_ads.md

File metadata and controls

163 lines (114 loc) · 7.29 KB
page_title subcategory description
airbyte_source_linkedin_ads Resource - terraform-provider-airbyte
SourceLinkedinAds Resource

airbyte_source_linkedin_ads (Resource)

SourceLinkedinAds Resource

Example Usage

resource "airbyte_source_linkedin_ads" "my_source_linkedinads" {
  configuration = {
    account_ids = [
      4
    ]
    ad_analytics_reports = [
      {
        name             = "...my_name..."
        pivot_by         = "MEMBER_JOB_TITLE"
        time_granularity = "MONTHLY"
      }
    ]
    credentials = {
      access_token = {
        access_token = "...my_access_token..."
      }
    }
    lookback_window = 3
    start_date      = "2021-05-17"
  }
  definition_id = "6103991f-50f8-4ff5-a7c2-f07535bd7995"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "a6809f5e-180e-4fd3-8ff7-576172bbda48"
}

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)
  • resource_allocation (Attributes) 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. (see below for nested schema)
  • source_id (String)
  • source_type (String)

Nested Schema for configuration

Required:

  • start_date (String) UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated.

Optional:

  • account_ids (List of Number) Specify the account IDs to pull data from, separated by a space. Leave this field empty if you want to pull the data from all accounts accessible by the authenticated user. See the LinkedIn docs to locate these IDs.
  • ad_analytics_reports (Attributes List) (see below for nested schema)
  • credentials (Attributes) (see below for nested schema)
  • lookback_window (Number) How far into the past to look for records. (in days). Default: 0

Nested Schema for configuration.ad_analytics_reports

Required:

  • name (String) The name for the custom report.
  • pivot_by (String) Choose a category to pivot your analytics report around. This selection will organize your data based on the chosen attribute, allowing you to analyze trends and performance from different perspectives. must be one of ["COMPANY", "ACCOUNT", "SHARE", "CAMPAIGN", "CREATIVE", "CAMPAIGN_GROUP", "CONVERSION", "CONVERSATION_NODE", "CONVERSATION_NODE_OPTION_INDEX", "SERVING_LOCATION", "CARD_INDEX", "MEMBER_COMPANY_SIZE", "MEMBER_INDUSTRY", "MEMBER_SENIORITY", "MEMBER_JOB_TITLE", "MEMBER_JOB_FUNCTION", "MEMBER_COUNTRY_V2", "MEMBER_REGION_V2", "MEMBER_COMPANY", "PLACEMENT_NAME", "IMPRESSION_DEVICE_TYPE"]
  • time_granularity (String) Choose how to group the data in your report by time. The options are:
    - 'ALL': A single result summarizing the entire time range.
    - 'DAILY': Group results by each day.
    - 'MONTHLY': Group results by each month.
    - 'YEARLY': Group results by each year.
    Selecting a time grouping helps you analyze trends and patterns over different time periods. must be one of ["ALL", "DAILY", "MONTHLY", "YEARLY"]

Nested Schema for configuration.credentials

Optional:

Nested Schema for configuration.credentials.access_token

Required:

  • access_token (String, Sensitive) The access token generated for your developer application. Refer to our documentation for more information.

Nested Schema for configuration.credentials.o_auth20

Required:

  • client_id (String, Sensitive) The client ID of your developer application. Refer to our documentation for more information.
  • client_secret (String, Sensitive) The client secret of your developer application. Refer to our documentation for more information.
  • refresh_token (String, Sensitive) The key to refresh the expired access token. Refer to our documentation for more information.

Nested Schema for resource_allocation

Read-Only:

Nested Schema for resource_allocation.default

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Nested Schema for resource_allocation.job_specific

Read-Only:

  • job_type (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"]
  • resource_requirements (Attributes) optional resource requirements to run workers (blank for unbounded allocations) (see below for nested schema)

Nested Schema for resource_allocation.job_specific.resource_requirements

Read-Only:

  • cpu_limit (String)
  • cpu_request (String)
  • ephemeral_storage_limit (String)
  • ephemeral_storage_request (String)
  • memory_limit (String)
  • memory_request (String)

Import

Import is supported using the following syntax:

terraform import airbyte_source_linkedin_ads.my_airbyte_source_linkedin_ads ""