Skip to content

Latest commit

 

History

History
174 lines (128 loc) · 9.3 KB

source_bing_ads.md

File metadata and controls

174 lines (128 loc) · 9.3 KB
page_title subcategory description
airbyte_source_bing_ads Resource - terraform-provider-airbyte
SourceBingAds Resource

airbyte_source_bing_ads (Resource)

SourceBingAds Resource

Example Usage

resource "airbyte_source_bing_ads" "my_source_bingads" {
  configuration = {
    account_names = [
      {
        name     = "...my_name..."
        operator = "Equals"
      }
    ]
    additional_properties = "{ \"see\": \"documentation\" }"
    client_id             = "...my_client_id..."
    client_secret         = "...my_client_secret..."
    custom_reports = [
      {
        disable_custom_report_names_camel_to_snake_conversion = true
        name                                                  = "Account Performance"
        report_aggregation                                    = "...my_report_aggregation..."
        report_columns = [
          "..."
        ]
        reporting_object = "AdExtensionDetailReportRequest"
      }
    ]
    developer_token    = "...my_developer_token..."
    lookback_window    = 80
    refresh_token      = "...my_refresh_token..."
    reports_start_date = "2021-12-24"
    tenant_id          = "...my_tenant_id..."
  }
  definition_id = "8a913fc3-a81b-4dc2-af5d-8db1e8246d7a"
  name          = "...my_name..."
  secret_id     = "...my_secret_id..."
  workspace_id  = "4b3ac887-f124-40a8-ae8c-9b91fd955bc7"
}

Schema

Required

  • configuration (Attributes) The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source. (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. Default: "47f25999-dd5e-4636-8c39-e7cea2453331"; 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:

  • client_id (String, Sensitive) The Client ID of your Microsoft Advertising developer application.
  • developer_token (String, Sensitive) Developer token associated with user. See more info in the docs.
  • refresh_token (String, Sensitive) Refresh Token to renew the expired Access Token.

Optional:

  • account_names (Attributes List) Predicates that will be used to sync data by specific accounts. (see below for nested schema)
  • additional_properties (String) Parsed as JSON.
  • client_secret (String, Sensitive) The Client Secret of your Microsoft Advertising developer application. Default: ""
  • custom_reports (Attributes List) You can add your Custom Bing Ads report by creating one. (see below for nested schema)
  • lookback_window (Number) Also known as attribution or conversion window. How far into the past to look for records (in days). If your conversion window has an hours/minutes granularity, round it up to the number of days exceeding. Used only for performance report streams in incremental mode without specified Reports Start Date. Default: 0
  • reports_start_date (String) The start date from which to begin replicating report data. Any data generated before this date will not be replicated in reports. This is a UTC date in YYYY-MM-DD format. If not set, data from previous and current calendar year will be replicated.
  • tenant_id (String, Sensitive) The Tenant ID of your Microsoft Advertising developer application. Set this to "common" unless you know you need a different value. Default: "common"

Nested Schema for configuration.account_names

Required:

  • name (String) Account Name is a string value for comparing with the specified predicate.
  • operator (String) An Operator that will be used to filter accounts. The Contains predicate has features for matching words, matching inflectional forms of words, searching using wildcard characters, and searching using proximity. The Equals is used to return all rows where account name is equal(=) to the string that you provided. must be one of ["Contains", "Equals"]

Nested Schema for configuration.custom_reports

Required:

  • name (String) The name of the custom report, this name would be used as stream name
  • report_aggregation (String) A list of available aggregations.
  • report_columns (List of String) A list of available report object columns. You can find it in description of reporting object that you want to add to custom report.
  • reporting_object (String) The name of the the object derives from the ReportRequest object. You can find it in Bing Ads Api docs - Reporting API - Reporting Data Objects. must be one of ["AccountPerformanceReportRequest", "AdDynamicTextPerformanceReportRequest", "AdExtensionByAdReportRequest", "AdExtensionByKeywordReportRequest", "AdExtensionDetailReportRequest", "AdGroupPerformanceReportRequest", "AdPerformanceReportRequest", "AgeGenderAudienceReportRequest", "AudiencePerformanceReportRequest", "CallDetailReportRequest", "CampaignPerformanceReportRequest", "ConversionPerformanceReportRequest", "DestinationUrlPerformanceReportRequest", "DSAAutoTargetPerformanceReportRequest", "DSACategoryPerformanceReportRequest", "DSASearchQueryPerformanceReportRequest", "GeographicPerformanceReportRequest", "GoalsAndFunnelsReportRequest", "HotelDimensionPerformanceReportRequest", "HotelGroupPerformanceReportRequest", "KeywordPerformanceReportRequest", "NegativeKeywordConflictReportRequest", "ProductDimensionPerformanceReportRequest", "ProductMatchCountReportRequest", "ProductNegativeKeywordConflictReportRequest", "ProductPartitionPerformanceReportRequest", "ProductPartitionUnitPerformanceReportRequest", "ProductSearchQueryPerformanceReportRequest", "ProfessionalDemographicsAudienceReportRequest", "PublisherUsagePerformanceReportRequest", "SearchCampaignChangeHistoryReportRequest", "SearchQueryPerformanceReportRequest", "ShareOfVoiceReportRequest", "UserLocationPerformanceReportRequest"]

Optional:

  • disable_custom_report_names_camel_to_snake_conversion (Boolean) When enabled, disables the automatic conversion of custom report names from camelCase to snake_case. By default, custom report names are automatically converted (e.g., 'MyCustomReport' becomes 'my_custom_report'). Enable this option if you want to use the exact report names you specify. Default: false

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.
  • 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:

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

import {
  to = airbyte_source_bing_ads.my_airbyte_source_bing_ads
  id = "..."
}

The terraform import command can be used, for example:

terraform import airbyte_source_bing_ads.my_airbyte_source_bing_ads "..."