LinkedIn Ads hierarchy documenation

fivetran · Aug 17, 2021 · b3af8db · b3af8db
1 parent 2e2918f
commit b3af8db
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ Include in your `packages.yml`
 ```yaml
 packages:
   - package: fivetran/ad_reporting
-    version: [">=0.3.0", "<0.4.0"]
+    version: [">=0.4.0", "<0.5.0"]
 ```
 
 ## Configuration

diff --git a/models/ad_reporting.yml b/models/ad_reporting.yml
@@ -3,22 +3,27 @@ version: 2
 models:
 
   - name: ad_reporting
-    description: Each record in this table represents the daily performance of ads.
+    description: >
+      Each record in this table represents the daily performance of ads.
+
+      LinkedIn Ads has a slightly different hierarchy than the other marketing platforms. As identified within [Microsoft's Campaign Groups](https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaign-groups?tabs=http)
+      documentation, the hierarchy consists of multiple campaigns for a single campaign group. As this hierarchy is the inverse of the standard hierarchy seen within the
+      other platforms, the `campaign` and `campaign_group` are switched for LinkedIn Ads within the ad_reporting table for consistency across platforms.
     columns:
       - name: campaign_name
-        description: A label for the campaign.
+        description: A label for the campaign. For LinkedIn Ads this field is the `campaign_group_name` field.
 
       - name: ad_group_name
-        description: A label for the ad group, if present in the source data. Mapped from fields including `campaign_group_name`.
+        description: A label for the ad group, if present in the source data. Mapped from fields including `campaign_group_name`. For LinkedIn Ads this field is the `campaign_name` field.
 
       - name: account_name
         description: A label for the account.
 
       - name: campaign_id
-        description: The ID representing the campaign.
+        description: The ID representing the campaign. For LinkedIn Ads this field is the `campaign_group_id` field.
 
       - name: ad_group_id
-        description: The ID representing the ad group, if present in the source data. Mapped from fields including `campaign_group_id`.
+        description: The ID representing the ad group, if present in the source data. Mapped from fields including `campaign_group_id`. For LinkedIn Ads this field is the `campaign_id` field.
 
       - name: account_id
         description: The ID representing the account.