connectors.google_ads

Create source

post/connectors/google_ads/create-source

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/connectors/google_ads/create-source
  • Auth: none declared

Request body

o_auth_idstring
authorizer_idstring
nullable_fieldsboolean

Setting this parameter to true allows the use of null values. If set to false, default values for each data type will be used instead.

ensure_data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

connector_idstring
template_idstring
labelstring
allow_emptyboolean

Setting this parameter to true allows extraction operations to proceed even if they produce 0 rows. If set to false, the operation will result in an error if no rows are extracted.

date_rangestring nullable
use_extraction_timestampboolean
use_hashboolean
use_date_startboolean
use_date_stopboolean
use_masked_columnsboolean
hash_columnsstring[]

Array of strings.

masked_columnsstring[]

Array of strings.

google_customer_idstring

This field is deprecated, use googleCustomerIds instead.

customer_client_idstring

This field is deprecated, use customerClientIds instead.

customer_client_idsstring[]

An array containing multiple Google Ads account IDs, utilized for multi-account extraction scenarios.

google_customer_idsstring[]

An array containing multiple Google Ads account IDs, utilized for multi-account extraction scenarios.

report_typestring
use_account_idboolean
use_account_nameboolean
account_namestring
segmentstring[]

Array of Segments. This field is deprecated, use segments instead

segmentsstring[]

Array of Segments.

metricstring[]

Array of Metrics. This field is deprecated, use metrics instead

metricsstring[]

Array of Metrics.

attributesstring[]

Array of attributes.

attributestring[]

Array of attributes. This field is deprecated, use attributes instead.

where_filterstring
startstring

Static start date of the query date range, in the format YYYY-MM-DD. Takes effect only when dateRange is not set.

stopstring

Static end date of the query date range, in the format YYYY-MM-DD. Takes effect only when dateRange is not set.

keywordsstring

Comma-separated list of seed keywords for Keyword Planner historical metrics.

geo_target_constantsstring

Comma-separated list of Google geo target constant IDs.

languagestring

Google language constant ID.

keyword_plan_networkstring

Example request

{
  "authorizer_id": "P6T8tazCWdf3pkVzIAlnZa10gh",
  "ensure_data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "date_range": "1d1",
  "hash_columns": [
    "id",
    "date_start"
  ],
  "masked_columns": [
    "name",
    "email"
  ],
  "customer_client_ids": [
    "000075694820000",
    "000077345370000"
  ],
  "google_customer_ids": [
    "00075694820000",
    "000077345370000"
  ],
  "segment": [
    "date"
  ],
  "segments": [
    "date"
  ],
  "metric": [
    "clicks",
    "cost_micros",
    "all_conversions"
  ],
  "metrics": [
    "clicks",
    "cost_micros",
    "all_conversions"
  ],
  "attributes": [
    "campaign.id",
    "campaign.name"
  ],
  "attribute": [
    "campaign.id",
    "campaign.name"
  ],
  "start": "2025-01-01",
  "stop": "2025-03-31"
}

Response

Create source

external_idstring nullable

The id of the document in external systems. By setting external_id you can link document with external systems id.

is_lockedboolean

You may mark the document as locked to prevent accidental changes. When locked, the document cannot be modified or deleted.

labelstring
descriptionstring
typestring
customer_idstring
created_atinteger
updated_atinteger

Changes

No recorded changes to this operation across all 1 revision of this API.