| Name | meltano-tap-linkedin-ads JSON |
| Version |
0.0.1a2
JSON |
| download |
| home_page | |
| Summary | `tap-linkedin-ads` is a Singer tap for linkedin, built with the Meltano SDK for Singer Taps. |
| upload_time | 2023-05-31 17:01:54 |
| maintainer | |
| docs_url | None |
| author | Meltano |
| requires_python | >=3.7.1,<3.12 |
| license | Elastic-2.0 |
| keywords |
elt
linkedin
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `tap-linkedin-ads`
Singer tap for extracting data from the LinkedIn Ads Marketing API.
Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| access_token | True | None | The token to authenticate against the API service |
| start_date | True | None | The earliest record date to sync |
| end_date | False | 2023-05-09 02:04:18.151589 | The latest record date to sync |
| user_agent | False | tap-linkedin-ads <api_user_email@your_company.com> | API ID |
| api_version | False | 202207 | LinkedInAds API Version |
| accounts | True | None | LinkedInAds Account ID |
| campaign | True | None | LinkedInAds Campaign ID |
| owner | True | None | LinkedInAds Owner ID |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth| False | None | The max depth to flatten schemas. |
A full list of supported settings and capabilities is available by running: `tap-linkedin-ads --about`
### Owner
The `owner` setting is required for pulling data from the VideoAds endpoint. You can find the owner ID by making a
request to the adAccounts endpoint:
https://api.linkedin.com/rest/adAccounts?q=search&start=0&count=10
The owner ID can be found in the response under "reference": "urn:li:organization:`{OWNER}`"
## Installation
```bash
pipx install git+https://github.com/MeltanoLabs/tap-linkedin-ads.git@main
```
### Authentication
The tap requires a LinkedInAds OAuth 2.0 access token to make API requests
The access token requires the following permissions:
`r_ads`: read ads
`rw_ads`: read-write ads
`r_ads_reporting`: read ads reporting
Access tokens expire after 60 days and require a user to manually authenticate
again. See the [LinkedInAds API docs](https://learn.microsoft.com/en-us/linkedin/shared/authentication/postman-getting-started) for more info
## Usage
### AdAnalytics API Column Limitation
The AdAnalytics endpoint in the LinkedInAds API can call up to 20 columns at a time, we can create child classes which have 20 columns in them, we can merge their output with get records function.
### SDK X-Restli-Protocol Limitation
The creatives endpoint requires X-Restli-Protocol to be set to 2.0.0. The request URL for tap-linkedin-ads uses parentheses ‘()’. '(' and ')' are typically
encoded in a request URL, but are not when the X-Restli-Protocol is 2.0.0. An SDK update for expanded escape characters is currently WIP [link github issue]
### Metadata Columns
- `add_metadata_columns:` Setting this config to 'true' adds the `_SDC_BATCHED_AT`, `_SDC_DELETED_AT` and `_SDC_EXTRACTED_AT` metadata columns to the loaded tables
### Elastic License 2.0
The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.
### Executing the Tap Directly
```bash
tap-linkedin-ads --version
tap-linkedin-ads --help
tap-linkedin-ads --config CONFIG --discover > ./catalog.json
```
## Contributing
This project uses parent-child streams. Learn more about them [here](https://gitlab.com/meltano/sdk/-/blob/main/docs/parent_streams.md).
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `lib_tap_linkedin_ads_sdk/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-linkedin-ads` CLI interface directly using `poetry run`:
```bash
poetry run tap-linkedin-ads --help
```
### Testing with [Meltano](https://www.meltano.com)
_**Note:** This tap will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios._
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-linkedin-ads
meltano install tap-linkedin-ads
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-linkedin-ads --version
# OR run a test `elt` pipeline:
meltano elt tap-linkedin-ads target-jsonl
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.
Raw data
{
"_id": null,
"home_page": "",
"name": "meltano-tap-linkedin-ads",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "ELT,linkedin",
"author": "Meltano",
"author_email": "hello@meltano.com",
"download_url": "https://files.pythonhosted.org/packages/73/72/fb51a7e200caa7d813b015d6c846486d282676250b742577a69934180327/meltano_tap_linkedin_ads-0.0.1a2.tar.gz",
"platform": null,
"description": "# `tap-linkedin-ads`\n\nSinger tap for extracting data from the LinkedIn Ads Marketing API.\n\nBuilt with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| access_token | True | None | The token to authenticate against the API service |\n| start_date | True | None | The earliest record date to sync |\n| end_date | False | 2023-05-09 02:04:18.151589 | The latest record date to sync |\n| user_agent | False | tap-linkedin-ads <api_user_email@your_company.com> | API ID |\n| api_version | False | 202207 | LinkedInAds API Version |\n| accounts | True | None | LinkedInAds Account ID |\n| campaign | True | None | LinkedInAds Campaign ID |\n| owner | True | None | LinkedInAds Owner ID |\n| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |\n| flattening_max_depth| False | None | The max depth to flatten schemas. |\n\nA full list of supported settings and capabilities is available by running: `tap-linkedin-ads --about`\n\n\n### Owner\n\nThe `owner` setting is required for pulling data from the VideoAds endpoint. You can find the owner ID by making a\nrequest to the adAccounts endpoint:\n\n https://api.linkedin.com/rest/adAccounts?q=search&start=0&count=10\n\n The owner ID can be found in the response under \"reference\": \"urn:li:organization:`{OWNER}`\"\n\n\n## Installation\n\n```bash\npipx install git+https://github.com/MeltanoLabs/tap-linkedin-ads.git@main\n```\n### Authentication\n\nThe tap requires a LinkedInAds OAuth 2.0 access token to make API requests\n\nThe access token requires the following permissions:\n\n`r_ads`: read ads\n`rw_ads`: read-write ads\n`r_ads_reporting`: read ads reporting\n\nAccess tokens expire after 60 days and require a user to manually authenticate\nagain. See the [LinkedInAds API docs](https://learn.microsoft.com/en-us/linkedin/shared/authentication/postman-getting-started) for more info\n\n## Usage\n\n### AdAnalytics API Column Limitation\n\nThe AdAnalytics endpoint in the LinkedInAds API can call up to 20 columns at a time, we can create child classes which have 20 columns in them, we can merge their output with get records function.\n\n### SDK X-Restli-Protocol Limitation\n\nThe creatives endpoint requires X-Restli-Protocol to be set to 2.0.0. The request URL for tap-linkedin-ads uses parentheses \u2018()\u2019. '(' and ')' are typically\nencoded in a request URL, but are not when the X-Restli-Protocol is 2.0.0. An SDK update for expanded escape characters is currently WIP [link github issue]\n\n\n### Metadata Columns\n\n- `add_metadata_columns:` Setting this config to 'true' adds the `_SDC_BATCHED_AT`, `_SDC_DELETED_AT` and `_SDC_EXTRACTED_AT` metadata columns to the loaded tables\n\n### Elastic License 2.0\n\nThe licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.\n\n### Executing the Tap Directly\n\n```bash\ntap-linkedin-ads --version\ntap-linkedin-ads --help\ntap-linkedin-ads --config CONFIG --discover > ./catalog.json\n```\n\n## Contributing\n\nThis project uses parent-child streams. Learn more about them [here](https://gitlab.com/meltano/sdk/-/blob/main/docs/parent_streams.md).\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `lib_tap_linkedin_ads_sdk/tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-linkedin-ads` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-linkedin-ads --help\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd tap-linkedin-ads\nmeltano install tap-linkedin-ads\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-linkedin-ads --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-linkedin-ads target-jsonl\n```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n\n",
"bugtrack_url": null,
"license": "Elastic-2.0",
"summary": "`tap-linkedin-ads` is a Singer tap for linkedin, built with the Meltano SDK for Singer Taps.",
"version": "0.0.1a2",
"project_urls": null,
"split_keywords": [
"elt",
"linkedin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1738d99f99ea689f7006eeba59aceae964b6788860caa41d4d4a836a547ed055",
"md5": "0488aca0b789d43c00f38e4bc897f93a",
"sha256": "66a9916a087f42e1879e072d24cf034718ef3f27ae75942d6aa7c32aa38a099d"
},
"downloads": -1,
"filename": "meltano_tap_linkedin_ads-0.0.1a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0488aca0b789d43c00f38e4bc897f93a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 15435,
"upload_time": "2023-05-31T17:01:53",
"upload_time_iso_8601": "2023-05-31T17:01:53.909354Z",
"url": "https://files.pythonhosted.org/packages/17/38/d99f99ea689f7006eeba59aceae964b6788860caa41d4d4a836a547ed055/meltano_tap_linkedin_ads-0.0.1a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7372fb51a7e200caa7d813b015d6c846486d282676250b742577a69934180327",
"md5": "bbd7bd447400754df80c2347447060d3",
"sha256": "f2d5e481ac76db19ec5e5d83c67b9afac63e8333dbc54d20239d9efe4489f3e6"
},
"downloads": -1,
"filename": "meltano_tap_linkedin_ads-0.0.1a2.tar.gz",
"has_sig": false,
"md5_digest": "bbd7bd447400754df80c2347447060d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 15431,
"upload_time": "2023-05-31T17:01:54",
"upload_time_iso_8601": "2023-05-31T17:01:54.942989Z",
"url": "https://files.pythonhosted.org/packages/73/72/fb51a7e200caa7d813b015d6c846486d282676250b742577a69934180327/meltano_tap_linkedin_ads-0.0.1a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 17:01:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "meltano-tap-linkedin-ads"
}
