tap-apple-search-ads - Meltano Hub

Apple Search Ads

tap-apple-search-ads (ticketswap variant)🥈

The tap-apple-search-ads extractor pulls data from Apple Search Ads that can then be sent to a destination using a loader.

Alternate Implementations

mighty-digital
(default)🥈
TicketSwap🥈

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-apple-search-ads extractor to your project using
```
meltano add
```
:

meltano add extractor tap-apple-search-ads --variant ticketswap

Configure the tap-apple-search-ads settings using

meltano config

:

meltano config tap-apple-search-ads set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-apple-search-ads test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-apple-search-ads may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
batch
catalog
discover
schema-flattening
state
stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-apple-search-ads settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

client_id
client_secret
end_date
org_id
start_date

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
faker_config.locale
faker_config.seed
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-apple-search-ads list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Client ID (client_id)

Environment variable: TAP_APPLE_SEARCH_ADS_CLIENT_ID

The client id to authenticate against the API service

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set client_id [value]

Client Secret (client_secret)

Environment variable: TAP_APPLE_SEARCH_ADS_CLIENT_SECRET

The client secret to authenticate against the API service

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set client_secret [value]

End Date (end_date)

Environment variable: TAP_APPLE_SEARCH_ADS_END_DATE

End date for reporting streams, format in YYYY-MM-DD.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set end_date [value]

Org ID (org_id)

Environment variable: TAP_APPLE_SEARCH_ADS_ORG_ID

The organisation id in your apple search ads.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set org_id [value]

Start Date (start_date)

Environment variable: TAP_APPLE_SEARCH_ADS_START_DATE

Start date for reporting streams, format in YYYY-MM-DD.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set start_date [value]

Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

Environment variable: TAP_APPLE_SEARCH_ADS_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

Environment variable: TAP_APPLE_SEARCH_ADS_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_APPLE_SEARCH_ADS_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

Environment variable: TAP_APPLE_SEARCH_ADS_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set batch_config storage.root [value]

Faker Config Locale (faker_config.locale)

Environment variable: TAP_APPLE_SEARCH_ADS_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set faker_config locale [value]

Faker Config Seed (faker_config.seed)

Environment variable: TAP_APPLE_SEARCH_ADS_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set faker_config seed [value]

Flattening Enabled (flattening_enabled)

Environment variable: TAP_APPLE_SEARCH_ADS_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_APPLE_SEARCH_ADS_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_APPLE_SEARCH_ADS_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_APPLE_SEARCH_ADS_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-apple-search-ads extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-apple-search-ads --variant ticketswap

Maintenance Status

Repo

https://github.com/TicketSwap/tap-apple-search-ads

Maintainer

Keywords