diff --git a/_changelog-files/2023/2023-11-29-linkedin-ads-v3.md b/_changelog-files/2023/2023-11-29-linkedin-ads-v3.md new file mode 100644 index 000000000..5d8ca92ff --- /dev/null +++ b/_changelog-files/2023/2023-11-29-linkedin-ads-v3.md @@ -0,0 +1,15 @@ +--- +title: "LinkedIn Ads integration: New version (v3) now available!" +content-type: "changelog-entry" +date: 2023-11-29 +entry-type: new-feature +entry-category: integration +connection-id: linkedin-ads +connection-version: 3 +pull-request: "https://github.com/singer-io/tap-linkedin-ads/pull/64" +--- +{{ site.data.changelog.metadata.single-integration | flatify }} + +A new version (v{{ this-connection.this-version }}) of our {{ this-connection.display_name }} integration is now available! + +We've upgraded the {{ this-connection.display_name }} API from `202302` to `202309`. This upgrade bring some updates to the `video_ads` stream, including a new Primary Key and a new Replication Key. \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/account_users.json b/_data/taps/schemas/linkedin-ads/v3/json/account_users.json new file mode 100644 index 000000000..bbf717804 --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/account_users.json @@ -0,0 +1,96 @@ +{ + "additionalProperties": false, + "properties": { + "account": { + "type": [ + "null", + "string" + ] + }, + "account_id": { + "type": [ + "null", + "integer" + ] + }, + "campaign_contact": { + "type": [ + "null", + "boolean" + ] + }, + "change_audit_stamps": { + "additionalProperties": false, + "properties": { + "created": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "last_modified": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "created_time": { + "type": [ + "null", + "date-time" + ] + }, + "last_modified_time": { + "type": [ + "null", + "date-time" + ] + }, + "role": { + "type": [ + "null", + "string" + ] + }, + "user": { + "type": [ + "null", + "string" + ] + }, + "user_person_id": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/accounts.json b/_data/taps/schemas/linkedin-ads/v3/json/accounts.json new file mode 100644 index 000000000..b34feea53 --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/accounts.json @@ -0,0 +1,199 @@ +{ + "additionalProperties": false, + "properties": { + "change_audit_stamps": { + "additionalProperties": false, + "properties": { + "created": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "last_modified": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "created_time": { + "type": [ + "null", + "date-time" + ] + }, + "currency": { + "type": [ + "null", + "string" + ] + }, + "id": { + "type": [ + "null", + "integer" + ] + }, + "last_modified_time": { + "type": [ + "null", + "date-time" + ] + }, + "name": { + "type": [ + "null", + "string" + ] + }, + "notified_on_campaign_optimization": { + "type": [ + "null", + "boolean" + ] + }, + "notified_on_creative_approval": { + "type": [ + "null", + "boolean" + ] + }, + "notified_on_creative_rejection": { + "type": [ + "null", + "boolean" + ] + }, + "notified_on_end_of_campaign": { + "type": [ + "null", + "boolean" + ] + }, + "notified_on_new_features_enabled": { + "type": [ + "null", + "boolean" + ] + }, + "reference": { + "type": [ + "null", + "string" + ] + }, + "reference_organization_id": { + "type": [ + "null", + "integer" + ] + }, + "reference_person_id": { + "type": [ + "null", + "string" + ] + }, + "serving_statuses": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "status": { + "type": [ + "null", + "string" + ] + }, + "test": { + "type": [ + "null", + "boolean" + ] + }, + "total_budget": { + "additionalProperties": false, + "properties": { + "amount": { + "type": [ + "null", + "number" + ] + }, + "currency_code": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "total_budget_ends_at": { + "type": [ + "null", + "date-time" + ] + }, + "type": { + "type": [ + "null", + "string" + ] + }, + "version": { + "additionalProperties": false, + "properties": { + "version_tag": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/ad_analytics_by_campaign.json b/_data/taps/schemas/linkedin-ads/v3/json/ad_analytics_by_campaign.json new file mode 100644 index 000000000..b7b7f5577 --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/ad_analytics_by_campaign.json @@ -0,0 +1,754 @@ +{ + "additionalProperties": false, + "properties": { + "action_clicks": { + "type": [ + "null", + "integer" + ] + }, + "ad_unit_clicks": { + "type": [ + "null", + "integer" + ] + }, + "approximate_unique_impressions": { + "type": [ + "null", + "integer" + ] + }, + "average_daily_reach_metrics": { + "additionalProperties": false, + "properties": { + "approximate_cost_in_currency_per_thousand_members_reached": { + "type": [ + "null", + "number" + ] + }, + "approximate_frequency": { + "type": [ + "null", + "number" + ] + }, + "approximate_reach": { + "type": [ + "null", + "number" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "average_previous_seven_day_reach_metrics": { + "additionalProperties": false, + "properties": { + "approximate_cost_in_currency_per_thousand_members_reached": { + "type": [ + "null", + "number" + ] + }, + "approximate_frequency": { + "type": [ + "null", + "number" + ] + }, + "approximate_reach": { + "type": [ + "null", + "number" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "average_previous_thirty_day_reach_metrics": { + "additionalProperties": false, + "properties": { + "approximate_cost_in_currency_per_thousand_members_reached": { + "type": [ + "null", + "number" + ] + }, + "approximate_frequency": { + "type": [ + "null", + "number" + ] + }, + "approximate_reach": { + "type": [ + "null", + "number" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "campaign": { + "type": [ + "null", + "string" + ] + }, + "campaign_id": { + "type": [ + "null", + "integer" + ] + }, + "card_clicks": { + "type": [ + "null", + "integer" + ] + }, + "card_impressions": { + "type": [ + "null", + "integer" + ] + }, + "clicks": { + "type": [ + "null", + "integer" + ] + }, + "comment_likes": { + "type": [ + "null", + "integer" + ] + }, + "comments": { + "type": [ + "null", + "integer" + ] + }, + "company_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "conversion_value_in_local_currency": { + "type": [ + "null", + "number" + ] + }, + "cost_in_local_currency": { + "type": [ + "null", + "number" + ] + }, + "cost_in_usd": { + "type": [ + "null", + "number" + ] + }, + "date_range": { + "additionalProperties": false, + "properties": { + "end": { + "additionalProperties": false, + "properties": { + "day": { + "type": [ + "null", + "integer" + ] + }, + "month": { + "type": [ + "null", + "integer" + ] + }, + "year": { + "type": [ + "null", + "integer" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "start": { + "additionalProperties": false, + "properties": { + "day": { + "type": [ + "null", + "integer" + ] + }, + "month": { + "type": [ + "null", + "integer" + ] + }, + "year": { + "type": [ + "null", + "integer" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "document_completions": { + "type": [ + "null", + "integer" + ] + }, + "document_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "document_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "document_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "download_clicks": { + "type": [ + "null", + "integer" + ] + }, + "end_at": { + "type": [ + "null", + "date-time" + ] + }, + "external_website_conversions": { + "type": [ + "null", + "integer" + ] + }, + "external_website_post_click_conversions": { + "type": [ + "null", + "integer" + ] + }, + "external_website_post_view_conversions": { + "type": [ + "null", + "integer" + ] + }, + "follows": { + "type": [ + "null", + "integer" + ] + }, + "full_screen_plays": { + "type": [ + "null", + "integer" + ] + }, + "impressions": { + "type": [ + "null", + "integer" + ] + }, + "job_applications": { + "type": [ + "null", + "number" + ] + }, + "job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "landing_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "lead_generation_mail_contact_info_shares": { + "type": [ + "null", + "integer" + ] + }, + "lead_generation_mail_interested_clicks": { + "type": [ + "null", + "integer" + ] + }, + "likes": { + "type": [ + "null", + "integer" + ] + }, + "one_click_lead_form_opens": { + "type": [ + "null", + "integer" + ] + }, + "one_click_leads": { + "type": [ + "null", + "integer" + ] + }, + "opens": { + "type": [ + "null", + "integer" + ] + }, + "other_engagements": { + "type": [ + "null", + "integer" + ] + }, + "pivot": { + "type": [ + "null", + "string" + ] + }, + "pivot_value": { + "type": [ + "null", + "string" + ] + }, + "pivot_values": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "post_click_job_applications": { + "type": [ + "null", + "number" + ] + }, + "post_click_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "post_click_registrations": { + "type": [ + "null", + "number" + ] + }, + "post_view_job_applications": { + "type": [ + "null", + "number" + ] + }, + "post_view_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "post_view_registrations": { + "type": [ + "null", + "number" + ] + }, + "reactions": { + "type": [ + "null", + "integer" + ] + }, + "registrations": { + "type": [ + "null", + "number" + ] + }, + "sends": { + "type": [ + "null", + "integer" + ] + }, + "shares": { + "type": [ + "null", + "integer" + ] + }, + "start_at": { + "type": [ + "null", + "date-time" + ] + }, + "talent_leads": { + "type": [ + "null", + "integer" + ] + }, + "text_url_clicks": { + "type": [ + "null", + "integer" + ] + }, + "total_engagements": { + "type": [ + "null", + "integer" + ] + }, + "video_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_starts": { + "type": [ + "null", + "integer" + ] + }, + "video_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_views": { + "type": [ + "null", + "integer" + ] + }, + "viral_card_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_card_impressions": { + "type": [ + "null", + "integer" + ] + }, + "viral_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_comment_likes": { + "type": [ + "null", + "integer" + ] + }, + "viral_comments": { + "type": [ + "null", + "integer" + ] + }, + "viral_company_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_download_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_external_website_conversions": { + "type": [ + "null", + "integer" + ] + }, + "viral_external_website_post_click_conversions": { + "type": [ + "null", + "integer" + ] + }, + "viral_external_website_post_view_conversions": { + "type": [ + "null", + "integer" + ] + }, + "viral_follows": { + "type": [ + "null", + "integer" + ] + }, + "viral_full_screen_plays": { + "type": [ + "null", + "integer" + ] + }, + "viral_impressions": { + "type": [ + "null", + "integer" + ] + }, + "viral_job_applications": { + "type": [ + "null", + "number" + ] + }, + "viral_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "viral_landing_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_likes": { + "type": [ + "null", + "integer" + ] + }, + "viral_one_click_lead_form_opens": { + "type": [ + "null", + "integer" + ] + }, + "viral_one_click_leads": { + "type": [ + "null", + "integer" + ] + }, + "viral_other_engagements": { + "type": [ + "null", + "integer" + ] + }, + "viral_post_click_job_applications": { + "type": [ + "null", + "number" + ] + }, + "viral_post_click_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "viral_post_click_registrations": { + "type": [ + "null", + "number" + ] + }, + "viral_post_view_job_applications": { + "type": [ + "null", + "number" + ] + }, + "viral_post_view_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "viral_post_view_registrations": { + "type": [ + "null", + "number" + ] + }, + "viral_reactions": { + "type": [ + "null", + "integer" + ] + }, + "viral_registrations": { + "type": [ + "null", + "number" + ] + }, + "viral_shares": { + "type": [ + "null", + "integer" + ] + }, + "viral_total_engagements": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_starts": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_views": { + "type": [ + "null", + "integer" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/ad_analytics_by_creative.json b/_data/taps/schemas/linkedin-ads/v3/json/ad_analytics_by_creative.json new file mode 100644 index 000000000..d1307c70f --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/ad_analytics_by_creative.json @@ -0,0 +1,754 @@ +{ + "additionalProperties": false, + "properties": { + "action_clicks": { + "type": [ + "null", + "integer" + ] + }, + "ad_unit_clicks": { + "type": [ + "null", + "integer" + ] + }, + "approximate_unique_impressions": { + "type": [ + "null", + "integer" + ] + }, + "average_daily_reach_metrics": { + "additionalProperties": false, + "properties": { + "approximate_cost_in_currency_per_thousand_members_reached": { + "type": [ + "null", + "number" + ] + }, + "approximate_frequency": { + "type": [ + "null", + "number" + ] + }, + "approximate_reach": { + "type": [ + "null", + "number" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "average_previous_seven_day_reach_metrics": { + "additionalProperties": false, + "properties": { + "approximate_cost_in_currency_per_thousand_members_reached": { + "type": [ + "null", + "number" + ] + }, + "approximate_frequency": { + "type": [ + "null", + "number" + ] + }, + "approximate_reach": { + "type": [ + "null", + "number" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "average_previous_thirty_day_reach_metrics": { + "additionalProperties": false, + "properties": { + "approximate_cost_in_currency_per_thousand_members_reached": { + "type": [ + "null", + "number" + ] + }, + "approximate_frequency": { + "type": [ + "null", + "number" + ] + }, + "approximate_reach": { + "type": [ + "null", + "number" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "card_clicks": { + "type": [ + "null", + "integer" + ] + }, + "card_impressions": { + "type": [ + "null", + "integer" + ] + }, + "clicks": { + "type": [ + "null", + "integer" + ] + }, + "comment_likes": { + "type": [ + "null", + "integer" + ] + }, + "comments": { + "type": [ + "null", + "integer" + ] + }, + "company_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "conversion_value_in_local_currency": { + "type": [ + "null", + "number" + ] + }, + "cost_in_local_currency": { + "type": [ + "null", + "number" + ] + }, + "cost_in_usd": { + "type": [ + "null", + "number" + ] + }, + "creative": { + "type": [ + "null", + "string" + ] + }, + "creative_id": { + "type": [ + "null", + "integer" + ] + }, + "date_range": { + "additionalProperties": false, + "properties": { + "end": { + "additionalProperties": false, + "properties": { + "day": { + "type": [ + "null", + "integer" + ] + }, + "month": { + "type": [ + "null", + "integer" + ] + }, + "year": { + "type": [ + "null", + "integer" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "start": { + "additionalProperties": false, + "properties": { + "day": { + "type": [ + "null", + "integer" + ] + }, + "month": { + "type": [ + "null", + "integer" + ] + }, + "year": { + "type": [ + "null", + "integer" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "document_completions": { + "type": [ + "null", + "integer" + ] + }, + "document_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "document_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "document_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "download_clicks": { + "type": [ + "null", + "integer" + ] + }, + "end_at": { + "type": [ + "null", + "date-time" + ] + }, + "external_website_conversions": { + "type": [ + "null", + "integer" + ] + }, + "external_website_post_click_conversions": { + "type": [ + "null", + "integer" + ] + }, + "external_website_post_view_conversions": { + "type": [ + "null", + "integer" + ] + }, + "follows": { + "type": [ + "null", + "integer" + ] + }, + "full_screen_plays": { + "type": [ + "null", + "integer" + ] + }, + "impressions": { + "type": [ + "null", + "integer" + ] + }, + "job_applications": { + "type": [ + "null", + "number" + ] + }, + "job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "landing_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "lead_generation_mail_contact_info_shares": { + "type": [ + "null", + "integer" + ] + }, + "lead_generation_mail_interested_clicks": { + "type": [ + "null", + "integer" + ] + }, + "likes": { + "type": [ + "null", + "integer" + ] + }, + "one_click_lead_form_opens": { + "type": [ + "null", + "integer" + ] + }, + "one_click_leads": { + "type": [ + "null", + "integer" + ] + }, + "opens": { + "type": [ + "null", + "integer" + ] + }, + "other_engagements": { + "type": [ + "null", + "integer" + ] + }, + "pivot": { + "type": [ + "null", + "string" + ] + }, + "pivot_value": { + "type": [ + "null", + "string" + ] + }, + "pivot_values": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "post_click_job_applications": { + "type": [ + "null", + "number" + ] + }, + "post_click_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "post_click_registrations": { + "type": [ + "null", + "number" + ] + }, + "post_view_job_applications": { + "type": [ + "null", + "number" + ] + }, + "post_view_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "post_view_registrations": { + "type": [ + "null", + "number" + ] + }, + "reactions": { + "type": [ + "null", + "integer" + ] + }, + "registrations": { + "type": [ + "null", + "number" + ] + }, + "sends": { + "type": [ + "null", + "integer" + ] + }, + "shares": { + "type": [ + "null", + "integer" + ] + }, + "start_at": { + "type": [ + "null", + "date-time" + ] + }, + "talent_leads": { + "type": [ + "null", + "integer" + ] + }, + "text_url_clicks": { + "type": [ + "null", + "integer" + ] + }, + "total_engagements": { + "type": [ + "null", + "integer" + ] + }, + "video_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_starts": { + "type": [ + "null", + "integer" + ] + }, + "video_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "video_views": { + "type": [ + "null", + "integer" + ] + }, + "viral_card_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_card_impressions": { + "type": [ + "null", + "integer" + ] + }, + "viral_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_comment_likes": { + "type": [ + "null", + "integer" + ] + }, + "viral_comments": { + "type": [ + "null", + "integer" + ] + }, + "viral_company_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_document_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_download_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_external_website_conversions": { + "type": [ + "null", + "integer" + ] + }, + "viral_external_website_post_click_conversions": { + "type": [ + "null", + "integer" + ] + }, + "viral_external_website_post_view_conversions": { + "type": [ + "null", + "integer" + ] + }, + "viral_follows": { + "type": [ + "null", + "integer" + ] + }, + "viral_full_screen_plays": { + "type": [ + "null", + "integer" + ] + }, + "viral_impressions": { + "type": [ + "null", + "integer" + ] + }, + "viral_job_applications": { + "type": [ + "null", + "number" + ] + }, + "viral_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "viral_landing_page_clicks": { + "type": [ + "null", + "integer" + ] + }, + "viral_likes": { + "type": [ + "null", + "integer" + ] + }, + "viral_one_click_lead_form_opens": { + "type": [ + "null", + "integer" + ] + }, + "viral_one_click_leads": { + "type": [ + "null", + "integer" + ] + }, + "viral_other_engagements": { + "type": [ + "null", + "integer" + ] + }, + "viral_post_click_job_applications": { + "type": [ + "null", + "number" + ] + }, + "viral_post_click_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "viral_post_click_registrations": { + "type": [ + "null", + "number" + ] + }, + "viral_post_view_job_applications": { + "type": [ + "null", + "number" + ] + }, + "viral_post_view_job_apply_clicks": { + "type": [ + "null", + "number" + ] + }, + "viral_post_view_registrations": { + "type": [ + "null", + "number" + ] + }, + "viral_reactions": { + "type": [ + "null", + "integer" + ] + }, + "viral_registrations": { + "type": [ + "null", + "integer" + ] + }, + "viral_shares": { + "type": [ + "null", + "integer" + ] + }, + "viral_total_engagements": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_first_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_midpoint_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_starts": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_third_quartile_completions": { + "type": [ + "null", + "integer" + ] + }, + "viral_video_views": { + "type": [ + "null", + "integer" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/campaign_groups.json b/_data/taps/schemas/linkedin-ads/v3/json/campaign_groups.json new file mode 100644 index 000000000..2c7f0819d --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/campaign_groups.json @@ -0,0 +1,169 @@ +{ + "additionalProperties": false, + "properties": { + "account": { + "type": [ + "null", + "string" + ] + }, + "account_id": { + "type": [ + "null", + "integer" + ] + }, + "allowed_campaign_types": { + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + }, + "backfilled": { + "type": [ + "null", + "boolean" + ] + }, + "change_audit_stamps": { + "additionalProperties": false, + "properties": { + "created": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "last_modified": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "created_time": { + "type": [ + "null", + "date-time" + ] + }, + "id": { + "type": [ + "null", + "integer" + ] + }, + "last_modified_time": { + "type": [ + "null", + "date-time" + ] + }, + "name": { + "type": [ + "null", + "string" + ] + }, + "run_schedule": { + "additionalProperties": false, + "properties": { + "end": { + "type": [ + "null", + "date-time" + ] + }, + "start": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "serving_statuses": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "status": { + "type": [ + "null", + "string" + ] + }, + "test": { + "type": [ + "null", + "boolean" + ] + }, + "total_budget": { + "additionalProperties": false, + "properties": { + "amount": { + "type": [ + "null", + "number" + ] + }, + "currency_code": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/campaigns.json b/_data/taps/schemas/linkedin-ads/v3/json/campaigns.json new file mode 100644 index 000000000..70b7c8dc8 --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/campaigns.json @@ -0,0 +1,590 @@ +{ + "additionalProperties": false, + "properties": { + "account": { + "type": [ + "null", + "string" + ] + }, + "account_id": { + "type": [ + "null", + "integer" + ] + }, + "associated_entity": { + "type": [ + "null", + "string" + ] + }, + "associated_entity_organization_id": { + "type": [ + "null", + "integer" + ] + }, + "associated_entity_person_id": { + "type": [ + "null", + "string" + ] + }, + "audience_expansion_enabled": { + "type": [ + "null", + "boolean" + ] + }, + "campaign_group": { + "type": [ + "null", + "string" + ] + }, + "campaign_group_id": { + "type": [ + "null", + "integer" + ] + }, + "change_audit_stamps": { + "additionalProperties": false, + "properties": { + "created": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "last_modified": { + "additionalProperties": false, + "properties": { + "time": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "cost_type": { + "type": [ + "null", + "string" + ] + }, + "created_time": { + "type": [ + "null", + "date-time" + ] + }, + "creative_selection": { + "type": [ + "null", + "string" + ] + }, + "daily_budget": { + "additionalProperties": false, + "properties": { + "amount": { + "type": [ + "null", + "number" + ] + }, + "currency_code": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "format": { + "type": [ + "null", + "string" + ] + }, + "id": { + "type": [ + "null", + "integer" + ] + }, + "last_modified_time": { + "type": [ + "null", + "date-time" + ] + }, + "locale": { + "additionalProperties": false, + "properties": { + "country": { + "type": [ + "null", + "string" + ] + }, + "language": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "name": { + "type": [ + "null", + "string" + ] + }, + "objective_type": { + "type": [ + "null", + "string" + ] + }, + "offsite_delivery_enabled": { + "type": [ + "null", + "boolean" + ] + }, + "offsite_preferences": { + "additionalProperties": false, + "properties": { + "iab_categories": { + "additionalProperties": false, + "properties": { + "exclude": { + "additionalProperties": false, + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + }, + "include": { + "additionalProperties": false, + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "publisher_restriction_files": { + "additionalProperties": false, + "properties": { + "exclude": { + "additionalProperties": false, + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "optimization_target_type": { + "type": [ + "null", + "string" + ] + }, + "pacing_strategy": { + "type": [ + "null", + "string" + ] + }, + "run_schedule": { + "additionalProperties": false, + "properties": { + "end": { + "type": [ + "null", + "date-time" + ] + }, + "start": { + "type": [ + "null", + "date-time" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "serving_statuses": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "status": { + "type": [ + "null", + "string" + ] + }, + "targeting": { + "additionalProperties": false, + "properties": { + "excluded_targeting_facets": { + "anyOf": [ + { + "items": { + "additionalProperties": false, + "properties": { + "type": { + "type": [ + "null", + "string" + ] + }, + "values": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "included_targeting_facets": { + "anyOf": [ + { + "items": { + "additionalProperties": false, + "properties": { + "type": { + "type": [ + "null", + "string" + ] + }, + "values": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "targeting_criteria": { + "additionalProperties": false, + "properties": { + "exclude": { + "properties": { + "or": { + "properties": { + "urn:li:ad_targeting_facet:followed_companies": { + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + }, + "urn:li:ad_targeting_facet:seniorities": { + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + }, + "urn:li:ad_targeting_facet:staff_count_ranges": { + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + }, + "urn:li:ad_targeting_facet:titles": { + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "include": { + "additionalProperties": false, + "properties": { + "and": { + "anyOf": [ + { + "items": { + "additionalProperties": false, + "properties": { + "type": { + "type": [ + "null", + "string" + ] + }, + "values": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "test": { + "type": [ + "null", + "boolean" + ] + }, + "total_budget": { + "additionalProperties": false, + "properties": { + "amount": { + "type": [ + "null", + "number" + ] + }, + "currency_code": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "type": { + "type": [ + "null", + "string" + ] + }, + "unit_cost": { + "additionalProperties": false, + "properties": { + "amount": { + "type": [ + "null", + "number" + ] + }, + "currency_code": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "version": { + "additionalProperties": false, + "properties": { + "version_tag": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "version_tag": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/creatives.json b/_data/taps/schemas/linkedin-ads/v3/json/creatives.json new file mode 100644 index 000000000..bdc32f8c7 --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/creatives.json @@ -0,0 +1,135 @@ +{ + "additionalProperties": false, + "properties": { + "account": { + "type": [ + "null", + "string" + ] + }, + "account_id": { + "type": [ + "null", + "integer" + ] + }, + "campaign": { + "type": [ + "null", + "string" + ] + }, + "campaign_id": { + "type": [ + "null", + "integer" + ] + }, + "content": { + "additionalProperties": false, + "properties": { + "reference": { + "type": [ + "null", + "string" + ] + }, + "text_ad": { + "additionalProperties": false, + "properties": { + "description": { + "type": [ + "null", + "string" + ] + }, + "headline": { + "type": [ + "null", + "string" + ] + }, + "landing_page": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "created_at": { + "type": [ + "null", + "date-time" + ] + }, + "created_by": { + "type": [ + "null", + "string" + ] + }, + "id": { + "type": [ + "null", + "string" + ] + }, + "intended_status": { + "type": [ + "null", + "string" + ] + }, + "is_serving": { + "type": [ + "null", + "boolean" + ] + }, + "is_test": { + "type": [ + "null", + "boolean" + ] + }, + "last_modified_at": { + "type": [ + "null", + "date-time" + ] + }, + "last_modified_by": { + "type": [ + "null", + "string" + ] + }, + "serving_hold_reasons": { + "items": { + "type": [ + "null", + "string" + ] + }, + "type": [ + "null", + "array" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/json/video_ads.json b/_data/taps/schemas/linkedin-ads/v3/json/video_ads.json new file mode 100644 index 000000000..8e445d32b --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/json/video_ads.json @@ -0,0 +1,96 @@ +{ + "additionalProperties": false, + "properties": { + "account": { + "type": [ + "null", + "string" + ] + }, + "account_id": { + "type": [ + "null", + "integer" + ] + }, + "ad_context": { + "additionalProperties": false, + "properties": { + "dsc_ad_account": { + "type": [ + "null", + "string" + ] + }, + "dsc_ad_type": { + "type": [ + "null", + "string" + ] + }, + "dsc_name": { + "type": [ + "null", + "string" + ] + }, + "dsc_status": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] + }, + "author": { + "type": [ + "null", + "string" + ] + }, + "created_at": { + "type": [ + "null", + "date-time" + ] + }, + "id": { + "type": [ + "null", + "string" + ] + }, + "last_modified_at": { + "type": [ + "null", + "date-time" + ] + }, + "name": { + "type": [ + "null", + "string" + ] + }, + "status": { + "type": [ + "null", + "string" + ] + }, + "type": { + "type": [ + "null", + "string" + ] + } + }, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/linkedin-ads/v3/linkedin-ads-v3-foreign-keys.yml b/_data/taps/schemas/linkedin-ads/v3/linkedin-ads-v3-foreign-keys.yml new file mode 100644 index 000000000..5de6810b9 --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/linkedin-ads-v3-foreign-keys.yml @@ -0,0 +1,188 @@ +tap: linkedin-ads +version: '3' +keys: + accounts_id: + - table: account_users + keys: + - account_id + - table: accounts + keys: + - id + - table: campaigns + keys: + - account_id + - table: campaign_groups + keys: + - account_id + - table: video_ads + keys: + - account_id + _: + - table: video_ads + keys: + - owner_organization_id + account_users_user_person_id: + - table: account_users + keys: + - user_person_id + campaign_groups_id: + - table: campaign_groups + keys: + - id + - table: campaigns + keys: + - campaign_group_id + campaigns_id: + - table: campaigns + keys: + - id + - table: creatives + keys: + - campaign_id + - table: ad_analytics_by_campaign + keys: + - campaign_id + creatives_id: + - table: creatives + keys: + - id + - table: ad_analytics_by_creative + keys: + - creative_id + video_ads_content_reference: + - table: video_ads + keys: + - content_reference +tables: +- table-name: account_users + join: + - table-name: accounts + keys: + - key: account_id + foreign-key: id + - table-name: campaigns + keys: + - key: account_id + foreign-key: account_id + - table-name: campaign_groups + keys: + - key: account_id + foreign-key: account_id + - table-name: video_ads + keys: + - key: account_id + foreign-key: account_id +- table-name: accounts + join: + - table-name: account_users + keys: + - key: id + foreign-key: account_id + - table-name: campaigns + keys: + - key: id + foreign-key: account_id + - table-name: campaign_groups + keys: + - key: id + foreign-key: account_id + - table-name: video_ads + keys: + - key: id + foreign-key: account_id +- table-name: campaigns + join: + - table-name: account_users + keys: + - key: account_id + foreign-key: account_id + - table-name: accounts + keys: + - key: account_id + foreign-key: id + - table-name: campaign_groups + keys: + - key: account_id + foreign-key: account_id + - key: campaign_group_id + foreign-key: id + - table-name: video_ads + keys: + - key: account_id + foreign-key: account_id + - table-name: creatives + keys: + - key: id + foreign-key: campaign_id + - table-name: ad_analytics_by_campaign + keys: + - key: id + foreign-key: campaign_id +- table-name: campaign_groups + join: + - table-name: account_users + keys: + - key: account_id + foreign-key: account_id + - table-name: accounts + keys: + - key: account_id + foreign-key: id + - table-name: campaigns + keys: + - key: account_id + foreign-key: account_id + - key: id + foreign-key: campaign_group_id + - table-name: video_ads + keys: + - key: account_id + foreign-key: account_id +- table-name: video_ads + join: + - table-name: account_users + keys: + - key: account_id + foreign-key: account_id + - table-name: accounts + keys: + - key: account_id + foreign-key: id + - table-name: campaigns + keys: + - key: account_id + foreign-key: account_id + - table-name: campaign_groups + keys: + - key: account_id + foreign-key: account_id +- table-name: creatives + join: + - table-name: campaigns + keys: + - key: campaign_id + foreign-key: id + - table-name: ad_analytics_by_campaign + keys: + - key: campaign_id + foreign-key: campaign_id + - table-name: ad_analytics_by_creative + keys: + - key: id + foreign-key: creative_id +- table-name: ad_analytics_by_campaign + join: + - table-name: campaigns + keys: + - key: campaign_id + foreign-key: id + - table-name: creatives + keys: + - key: campaign_id + foreign-key: campaign_id +- table-name: ad_analytics_by_creative + join: + - table-name: creatives + keys: + - key: creative_id + foreign-key: id diff --git a/_data/taps/schemas/linkedin-ads/v3/linkedin-ads-v3-tables.yml b/_data/taps/schemas/linkedin-ads/v3/linkedin-ads-v3-tables.yml new file mode 100644 index 000000000..dd7ec6958 --- /dev/null +++ b/_data/taps/schemas/linkedin-ads/v3/linkedin-ads-v3-tables.yml @@ -0,0 +1,112 @@ +tap: linkedin-ads +version: '3' +tap-repo-schemas: true +tables: +- name: accounts + description: 'The `{{ table.name }}` table contains info about your {{ integration.display_name + }} ad accounts. + + ' + links: + singer-schema: https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/accounts.json + api-method: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts?view=li-lms-2022-07&tabs=http#search-for-accounts + table-details: + replication-method: Key-based Incremental + primary-key: id + replication-key: last_modified_time +- name: account_users + description: 'The `{{ table.name }}` table contains info about the users who have + permissions to an ad account. + + ' + links: + singer-schema: https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/account_users.json + api-method: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-account-users?view=li-lms-2022-07&tabs=http#find-ad-account-users-by-accounts + table-details: + replication-method: Key-based Incremental + primary-keys: + - account_id + - user_person_id + replication-key: last_modified_time +- name: ad_analytics_by_campaign + description: 'The `{{ table.name }}` table contains analytics data for ads, segmented + by campaign. + + + **Note**: This table is replicated using an attribution window of {{ integration.attribution-window + }}. Refer to the [Replication](#replication) section for more info. + + ' + links: + singer-schema: https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/ad_analytics_by_campaign.json + api-method: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting?view=li-lms-2022-07&tabs=http#analytics-finder + table-details: + replication-method: Key-based Incremental + primary-keys: + - campaign_id + - start_at + replication-key: end_at +- name: ad_analytics_by_creative + description: 'The `{{ table.name }}` table contains info about ad analytics, segmented + by creative. + + + **Note**: This table is replicated using an attribution window of {{ integration.attribution-window + }}. Refer to the [Replication](#replication) section for more info. + + ' + links: + singer-schema: https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/ad_analytics_by_creative.json + api-method: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting?view=li-lms-2022-07&tabs=http#analytics-finder + table-details: + replication-method: Key-based Incremental + primary-keys: + - creative_id + - start_at + replication-key: end_at +- name: campaigns + description: 'The `{{ table.name }}` table contains info about the campaigns in + your {{ integration.display_name }} account. + + ' + links: + singer-schema: https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/campaigns.json + api-method: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaigns?view=li-lms-2022-07&tabs=http#search-for-campaigns + table-details: + replication-method: Key-based Incremental + primary-key: id + replication-key: last_modified_time +- name: campaign_groups + description: 'The `{{ table.name }}` table contains info about the campaign groups + in your {{ integration.display_name }} account. + + ' + links: + singer-schema: https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/campaign_groups.json + api-method: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?view=li-lms-2022-07&tabs=http#search-for-campaign-groups + table-details: + replication-method: Key-based Incremental + primary-key: id + replication-key: last_modified_time +- name: creatives + description: The Creatives API contains all the data and information for visually + rendering an ad. + links: + doc-link: https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-creatives?view=li-lms-2023-01&tabs=http#search-for-creatives + singer-schema: https://github.com/singer-io/tap-linkedin-ads/tree/master/tap_linkedin_ads/schemas/creatives.json + table-details: + replication-method: Key-based Incremental + primary-key: id + replication-key: last_modified_at +- name: video_ads + description: 'The `{{ table.name }}` table contains info about the video ads in + your {{ integration.display_name }} account. + + ' + links: + singer-schema: https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/video_ads.json + api-method: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/advertising-targeting/create-and-manage-video?view=li-lms-unversioned&tabs=http&viewFallbackFrom=li-lms-2022-07#finders + table-details: + replication-method: Key-based Incremental + primary-key: id + replication-key: last_modified_at diff --git a/_data/taps/versions/linkedin-ads.yml b/_data/taps/versions/linkedin-ads.yml index cd9b10e74..1e91de291 100644 --- a/_data/taps/versions/linkedin-ads.yml +++ b/_data/taps/versions/linkedin-ads.yml @@ -11,12 +11,14 @@ # LINKEDIN ADS VERSIONS # # -------------------------- # -latest-version: "2" +latest-version: "3" released-versions: + - number: "3" + date-released: "November 29, 2023" + - number: "2" date-released: "February 7, 2023" - # date-last-connection: - number: "1" #full-release: "April 2, 2020" diff --git a/_saas-integrations/linkedin-ads/v2/linkedin-ads-v2.md b/_saas-integrations/linkedin-ads/v2/linkedin-ads-v2.md index f049f4d1a..6627141c2 100644 --- a/_saas-integrations/linkedin-ads/v2/linkedin-ads-v2.md +++ b/_saas-integrations/linkedin-ads/v2/linkedin-ads-v2.md @@ -13,10 +13,10 @@ # -------------------------- # title: LinkedIn Ads (v2) -permalink: /integrations/saas/linkedin-ads +permalink: /integrations/saas/linkedin-ads/v2 keywords: linkedin ads, integration, schema, etl linkedin ads, linkedin ads etl, linkedin ads schema, linkedin, layout: singer -input: true +input: false key: "linkedin-ads-setup" diff --git a/_saas-integrations/linkedin-ads/v3/linkedin-ads-v3.md b/_saas-integrations/linkedin-ads/v3/linkedin-ads-v3.md new file mode 100644 index 000000000..9ef5dbd75 --- /dev/null +++ b/_saas-integrations/linkedin-ads/v3/linkedin-ads-v3.md @@ -0,0 +1,139 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page & Formatting # +# -------------------------- # + +title: LinkedIn Ads (v3) +permalink: /integrations/saas/linkedin-ads +keywords: linkedin ads, integration, schema, etl linkedin ads, linkedin ads etl, linkedin ads schema, linkedin, +layout: singer +input: true + +key: "linkedin-ads-setup" + +# -------------------------- # +# Tap Details # +# -------------------------- # + +name: "linkedin-ads" +display_name: "LinkedIn Ads" + +singer: true +tap-name: "LinkedIn Ads" +repo-url: https://github.com/singer-io/tap-linkedin-ads + +this-version: "3" + +# -------------------------- # +# Stitch Details # +# -------------------------- # + +certified: true +api-type: "platform.linkedin-ads" + +historical: "1 year" +frequency: "1 hour" +tier: "Standard" +status-url: "" + +anchor-scheduling: true +cron-scheduling: true + +extraction-logs: true +loading-reports: true + +table-selection: true +column-selection: true + + +# -------------------------- # +# API Details # +# -------------------------- # + +attribution-window: "7 days" + + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +requirements-list: + - item: "**Access to a {{ integration.display_name }} account**. This is necessary to login to the Campaign Manager account." + - item: "**Access to a {{ integration.display_name }} Campaign Manager account**. Verify that you have access to use the Ad accounts you want to replicate data from. This is necessary to connect to Stitch." + +setup-steps: + - title: "Retrieve your {{ integration.display_name }} account IDs" + anchor: "retrieve-account-ids" + content: | + 1. Login to your LinkedIn account. + 2. Click the **Work** menu, then **Advertise**: + + ![The LinkedIn Work and Advertise menus, highlighted]({{ site.baseurl }}/images/integrations/linkedin-ads-work-dropdown.png){:style="max-width: 400px"} + + 3. In the Accounts table, locate the IDs for the accounts you want to replicate data from: + + ![LinkedIn Ads account IDs highlighted in the Accounts table of the Campaign Manager page.]({{ site.baseurl }}/images/integrations/linkedin-ads-account-ids.png){:style="max-width: 500px"} + + - title: "Add {{ integration.display_name }} as a Stitch data source" + anchor: "add-stitch-data-source" + content: | + {% include integrations/shared-setup/connection-setup.html %} + 4. In the **Accounts** field, enter a comma-separated list of the account IDs of the campaign accounts you want to replicate data from. These will be the account IDs you retrieved in [Step 1](#retrieve-account-ids). For example: `503123456,503234567`, etc. + - title: "Define the historical replication start date" + anchor: "define-historical-sync" + content: | + {% include integrations/saas/setup/historical-sync.html %} + + - title: "Create a replication schedule" + anchor: "define-rep-frequency" + content: | + {% include integrations/shared-setup/replication-frequency.html %} + + - title: "Set objects to replicate" + anchor: "setting-data-to-replicate" + content: | + {% include integrations/shared-setup/data-selection/object-selection.html %} + + +# -------------------------- # +# Replication Info # +# -------------------------- # + +replication-sections: + - content: | + {% assign window = "Attribution Window" %} + {% assign table = "ad_analytics_by_campaign" %} + {% assign replication-key = "end_at" %} + {% assign start-date ="06/03/2017" %} + {% assign start-date-value = "June 3, 2017" %} + {% assign replication-key-historical = "2017-06-03 00:00:00" %} + {% assign replication-key-ongoing = "2017-09-24 00:00:00" %} + + {% include integrations/saas/attribution-windows.html %} + + Refer to the documentation for each of these tables in the next section for more info. + + ### Attribution window examples + + In the tabs below are examples of attribution windows behave during historical (initial) and ongoing replication jobs. + + {% include integrations/saas/attribution-window-examples.html %} + +# -------------------------- # +# Integration Tables # +# -------------------------- # + +# Looking for the table schemas & info? +# Each table has a its own .md file in /_integration-schemas/linkedin-ads/v1 +--- +{% assign integration = page %} +{% include misc/data-files.html %}