LinkedIn Ads

tap-linkedin-ads (meltanolabs variant)🥇

LinkedIn Ad Platform

The tap-linkedin-ads extractor pulls data from LinkedIn Ads that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

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

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-linkedin-ads extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-linkedin-ads
  2. Configure the tap-linkedin-ads settings using 
    meltano config
     : 
    3. meltano config tap-linkedin-ads set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-linkedin-ads test

Next steps

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

Capabilities

The current capabilities for tap-linkedin-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-linkedin-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:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-linkedin-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.

Access Token (access_token)

  • Environment variable: TAP_LINKEDIN_ADS_ACCESS_TOKEN

The token to authenticate against the API service


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set access_token [value]

Accounts (accounts)

  • Environment variable: TAP_LINKEDIN_ADS_ACCOUNTS

LinkedInAds Account ID


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set accounts [value]

Campaign (campaign)

  • Environment variable: TAP_LINKEDIN_ADS_CAMPAIGN

LinkedInAds Campaign ID


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set campaign [value]

Campaign Group (campaign_group)

  • Environment variable: TAP_LINKEDIN_ADS_CAMPAIGN_GROUP

LinkedInAds Campaign Group ID. Used for the campaign_group stream


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set campaign_group [value]

Creative (creative)

  • Environment variable: TAP_LINKEDIN_ADS_CREATIVE

LinkedInAds Creative ID. Used for the creative stream


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set creative [value]

End Date (end_date)

  • Environment variable: TAP_LINKEDIN_ADS_END_DATE

The latest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set end_date [value]

OAuth Credentials Client ID (oauth_credentials.client_id)

  • Environment variable: TAP_LINKEDIN_ADS_OAUTH_CREDENTIALS_CLIENT_ID

LinkedIn Ads Client ID


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set oauth_credentials client_id [value]

OAuth Credentials Client Secret (oauth_credentials.client_secret)

  • Environment variable: TAP_LINKEDIN_ADS_OAUTH_CREDENTIALS_CLIENT_SECRET

LinkedIn Ads Client Secret


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set oauth_credentials client_secret [value]

OAuth Credentials Refresh Token (oauth_credentials.refresh_token)

  • Environment variable: TAP_LINKEDIN_ADS_OAUTH_CREDENTIALS_REFRESH_TOKEN

LinkedIn Ads Refresh Token


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set oauth_credentials refresh_token [value]

Owner (owner)

  • Environment variable: TAP_LINKEDIN_ADS_OWNER

LinkedInAds Owner ID


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set owner [value]

Start Date (start_date)

  • Environment variable: TAP_LINKEDIN_ADS_START_DATE

The earliest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set start_date [value]

User Agent (user_agent)

  • Environment variable: TAP_LINKEDIN_ADS_USER_AGENT
  • Default Value: tap-linkedin-ads <api_user_email@your_company.com>

API ID


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set user_agent [value]
Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

  • Environment variable: TAP_LINKEDIN_ADS_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_LINKEDIN_ADS_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_LINKEDIN_ADS_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Root (batch_config.storage.root)

  • Environment variable: TAP_LINKEDIN_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-linkedin-ads set batch_config storage.root [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_LINKEDIN_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-linkedin-ads set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_LINKEDIN_ADS_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-linkedin-ads set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_LINKEDIN_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-linkedin-ads set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_LINKEDIN_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-linkedin-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-linkedin-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-linkedin-ads

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/MeltanoLabs/tap-linkedin-ads
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • meltano_sdk