LinkedIn Ads/v1 (#363)

* First pass at schemas * schema and integration setup stuff * more setup stuff * Update _integration-schemas/linkedin-ads/v1/accounts.md * Update _integration-schemas/linkedin-ads/v1/accounts.md * Update _integration-schemas/linkedin-ads/v1/ad_analytics_by_campaign.md * Update _integration-schemas/linkedin-ads/v1/ad_analytics_by_campaign.md * Update _integration-schemas/linkedin-ads/v1/video_ads.md * Update _integration-schemas/linkedin-ads/v1/linkedin-ads-foreign-keys.md * Update _saas-integrations/linkedin-ads/v1/linkedin-ads-v1.md * Update _saas-integrations/linkedin-ads/v1/linkedin-ads-v1.md * Update _saas-integrations/linkedin-ads/v1/linkedin-ads-v1.md * Update _saas-integrations/linkedin-ads/v1/linkedin-ads-v1.md * Update _saas-integrations/linkedin-ads/v1/linkedin-ads-v1.md * Update _integration-schemas/linkedin-ads/v1/campaign_groups.md * Update ad_analytics_by_campaign.md * Update accounts.md * Update accounts.md * Update _integration-schemas/linkedin-ads/v1/campaign_groups.md * Update _integration-schemas/linkedin-ads/v1/campaign_groups.md * Update _integration-schemas/linkedin-ads/v1/video_ads.md * Update _integration-schemas/linkedin-ads/v1/video_ads.md * Finish setup instructions * Flesh out the schemas a bit more * Rename foreign keys file; add a few more keys * linked-in ads minor updates * release date + version formatting changes * Add properties * Uncomment version * Update version for schema files Co-authored-by: jazsmi <[email protected]>
stitchdata · Feb 21, 2020 · d276a1c · d276a1c
1 parent ff20b39
commit d276a1c
Show file tree

Hide file tree

Showing 15 changed files with 1,628 additions and 0 deletions.
diff --git a/_data/taps/versions/linkedin-ads.yml b/_data/taps/versions/linkedin-ads.yml
@@ -0,0 +1,22 @@
+# -------------------------- #
+#     USING THIS TEMPLATE    #
+# -------------------------- #
+
+## NEED HELP USING THIS TEMPLATE? SEE:
+## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/integration-versions/
+## FOR INSTRUCTIONS & REFERENCE INFO
+
+
+# -------------------------- #
+#   LINKEDIN ADS VERSIONS    #
+# -------------------------- #
+
+latest-version: "1"
+
+released-versions:
+  - number: "1"
+    status: "beta" ## beta, released, deprecated
+    date-released: "February 19, 2020"
+    # date-last-connection:
+    deprecation-date: ""
+    sunset-date: ""
diff --git a/...r-files/connect/api/objects/form-properties/sources/saas/linkedin-ads-object.md b/...r-files/connect/api/objects/form-properties/sources/saas/linkedin-ads-object.md
@@ -0,0 +1,47 @@
+---
+# -------------------------- #
+#     USING THIS TEMPLATE    #
+# -------------------------- #
+
+## NEED HELP USING THIS TEMPLATE? SEE:
+## https://docs-about-stitch-docs.netlify.com/reference/connect-templates/destination-form-property/
+## FOR INSTRUCTIONS & REFERENCE INFO
+
+## PLEASE REMOVE COMMENTS WHEN FINISHED
+
+
+# -------------------------- #
+#        CONTENT TYPE        #
+# -------------------------- #
+
+content-type: "api-form"
+form-type: "source"
+key: "source-form-properties-linkedin-ads-object"
+
+
+# -------------------------- #
+#        OBJECT INFO         #
+# -------------------------- #
+
+title: "LinkedIn Ads Source Form Property"
+api-type: "platform.linkedin-ads"
+display-name: "LinkedIn Ads"
+
+source-type: "saas"
+docs-name: "linkedin-ads"
+
+description: ""
+
+# -------------------------- #
+#      OBJECT ATTRIBUTES     #
+# -------------------------- #
+
+uses-start-date: true
+
+object-attributes:
+  - name: "accounts"
+    type: "string"
+    required: true
+    description: "A comma-separated list of accounts to replicate."
+    value: "123456789"
+---
diff --git a/_integration-schemas/linkedin-ads/v1/account_users.md b/_integration-schemas/linkedin-ads/v1/account_users.md
@@ -0,0 +1,77 @@
+---
+tap: "linkedin-ads"
+version: "1"
+key: "account-user"
+
+name: "account_users"
+doc-link: ""
+singer-schema: "https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/account_users.json"
+description: |
+  The `{{ table.name }}` table contains info about the users who have permissions to an ad account.
+
+replication-method: "Key-based Incremental"
+
+api-method:
+  name: "Find Ad Account Users by Accounts"
+  doc-link: "https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-account-users#find-ad-account-users-by-accounts"
+
+attributes:
+  - name: "account_id"
+    type: "integer"
+    primary-key: true
+    description: "The ID of the account associated with the user."
+    foreign-key-id: "account-id"
+
+  - name: "user_person_id"
+    type: "string"
+    primary-key: true
+    description: "The user's person ID."
+    foreign-key-id: "user-id" 
+
+  - name: "last_modified_time"
+    type: "date-time"
+    replication-key: true
+    description: "The time the user was last modified."
+
+  - name: "account"
+    type: "string"
+    description: "The advertising account's URN." 
+
+  - name: "change_audit_stamps"
+    type: "object"
+    description: ""
+    subattributes:
+      - name: "created"
+        type: "object"
+        description: ""
+        subattributes:
+          - name: "time"
+            type: "date-time"
+            description: ""
+      - name: "last_modified"
+        type: "object"
+        description: ""
+        subattributes:
+          - name: "time"
+            type: "date-time"
+            description: ""
+
+  - name: "created_time"
+    type: "date-time"
+    description: "The time the user was las modified."
+
+  - name: "role"
+    type: "string"
+    description: |
+      The user's role in the account. Possible values are:
+
+      - `VIEWER`
+      - `CREATIVE_MANAGER`
+      - `CAMPAIGN_MANAGER`
+      - `ACCOUNT_MANAGER`
+      - `ACCOUNT_BILLING_ADMIN`
+  
+  - name: "user"
+    type: "string"
+    description: "The associated user's URN."
+---
diff --git a/_integration-schemas/linkedin-ads/v1/accounts.md b/_integration-schemas/linkedin-ads/v1/accounts.md
@@ -0,0 +1,139 @@
+---
+tap: "linkedin-ads"
+version: "1"
+key: "account"
+
+name: "accounts"
+doc-link: ""
+singer-schema: "https://github.com/singer-io/tap-linkedin-ads/blob/master/tap_linkedin_ads/schemas/accounts.json"
+description: |
+  The `{{ table.name }}` table contains info about your {{ integration.display_name }} ad accounts.
+
+replication-method: "Key-based Incremental"
+
+api-method:
+  name: "Search for Accounts"
+  doc-link: "https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-accounts#search-for-accounts"
+
+attributes:
+  - name: "id"
+    type: "integer"
+    primary-key: true
+    description: "The internal account ID."
+    foreign-key-id: "account-id"
+
+  - name: "last_modified_time"
+    type: "date-time"
+    replication-key: true
+    description: "The time the account was last modified."
+
+  - name: "change_audit_stamps"
+    type: "object"
+    description: ""
+    subattributes:
+      - name: "created"
+        type: "object"
+        description: ""
+        subattributes:
+          - name: "time"
+            type: "date-time"
+            description: ""
+      - name: "last_modified"
+        type: "object"
+        description: ""
+        subattributes:
+          - name: "time"
+            type: "date-time"
+            description: ""
+
+  - name: "created_time"
+    type: "date-time"
+    description: "The time the account was created."
+
+  - name: "currency"
+    type: "string"
+    description: "The ISO 4217 currency code."
+
+  - name: "name"
+    type: "string"
+    description: "The account label."
+
+  - name: "notified_on_campaign_optimization"
+    type: "boolean"
+    description: "Indicates if the campaign contact has been notified about an opportunity."
+
+  - name: "notified_on_creative_approval"
+    type: "boolean"
+    description: "Indicates if the creative contact has been notified of approval."
+
+  - name: "notified_on_creative_rejection"
+    type: "boolean"
+    description: "Indicates if the creative contact has been rejected."
+
+  - name: "notified_on_end_of_campaign"
+    type: "boolean"
+    description: "Indicates if the campaign contact has been notified about the end of a campaign."
+
+  - name: "reference"
+    type: "string"
+    description: "The entity on whose behalf the account advertises."
+
+  - name: "reference_organization_id"
+    type: "integer"
+    description: ""
+    #foreign-key-id: "reference-organization-id"
+
+  - name: "reference_person_id"
+    type: "string"
+    description: ""
+    #foreign-key-id: "reference-person-id"
+
+  - name: "serving_statuses"
+    type: "array"
+    description: "Details about the account's system serving statuses."
+    subattributes:
+      - name: "value"
+        type: "string"
+        description: |
+          The account's system serving status. If an account is eligible for serving, the value will be `RUNNABLE`.
+          
+          Other possible values that indicate why the account isn't servable:
+
+          - `STOPPED`
+          - `BILLING_HOLD`
+          - `ACCOUNT_TOTAL_BUDGET_HOLD`
+          - `ACCOUNT_END_DATE_HOLD`
+          - `RESTRICTED_HOLD`
+          - `INTERNAL_HOLD`
+  
+  - name: "status"
+    type: "string"
+    description: "The account's active status."
+
+  - name: "total_budget"
+    type: "object"
+    description: "Details about the account's budget."
+    subattributes:
+      - name: "amount"
+        type: "number"
+        description: ""
+      - name: "currency_code"
+        type: "string"
+        description: ""
+
+  - name: "total_budget_ends_at"
+    type: "date-time"
+    description: ""
+
+  - name: "type"
+    type: "string"
+    description: "The account type - business or enterprise."
+
+  - name: "version"
+    type: "object"
+    description: ""
+    subattributes:
+      - name: "version_tag"
+        type: "string"
+        description: ""
+---