From b8ab932554b85f4d85dd1b5db63418b4ff003a53 Mon Sep 17 00:00:00 2001 From: Jazmin Smith Date: Fri, 22 Jan 2021 10:46:33 -0500 Subject: [PATCH 01/21] Pinterest Ads/v1 --- _data/taps/versions/pinterest-ads.yml | 22 +++ .../sources/saas/pinterest-ads.md | 54 +++++++ .../pinterest-ads/v1/foreign-keys.md | 21 +++ .../pinterest-ads/v1/pinterest-ads-v1.md | 144 ++++++++++++++++++ scripts/tap-generate-docs/advertisers.md | 108 +++++++++++++ 5 files changed, 349 insertions(+) create mode 100644 _data/taps/versions/pinterest-ads.yml create mode 100644 _developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md create mode 100644 _integration-schemas/pinterest-ads/v1/foreign-keys.md create mode 100644 _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md create mode 100644 scripts/tap-generate-docs/advertisers.md diff --git a/_data/taps/versions/pinterest-ads.yml b/_data/taps/versions/pinterest-ads.yml new file mode 100644 index 000000000..ecd4c0b76 --- /dev/null +++ b/_data/taps/versions/pinterest-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 + + +# -------------------------- # +# [INTEGRATION] VERSIONS # +# -------------------------- # + +latest-version: "" + +released-versions: + - number: "" + status: "" ## beta, released, deprecated + date-released: "" + # date-last-connection: + deprecation-date: "" + sunset-date: "" \ No newline at end of file diff --git a/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md b/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md new file mode 100644 index 000000000..17b704747 --- /dev/null +++ b/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md @@ -0,0 +1,54 @@ +--- +# -------------------------- # +# 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 + + +# -------------------------- # +# CONTENT TYPE # +# -------------------------- # + +product-type: "connect" +content-type: "api-form" +form-type: "source" +key: "source-form-properties-[integration]-object" + + +# -------------------------- # +# OBJECT INFO # +# -------------------------- # + +title: "[INTEGRATION] Source Form Property" +api-type: "platform.[integration]" +display-name: "[INTEGRATION]" + +source-type: "saas" +docs-name: "" # This should be whatever integration.name is. Ex: LinkedIn Ads is linkedin-ads + +property-description: "" +## Used to create a description for the object that doesn't adhere to the standard in _developers/connect/api/documentation/api-form-properties.html +## See the Heap object for an example + + +# -------------------------- # +# OBJECT ATTRIBUTES # +# -------------------------- # + +uses-start-date: true + +# Only source-specific attributes need to be listed here. +# The following attributes are considered common, +# and therefore don't need to be listed: +# anchor_time, cron_expression, frequency_in_minutes, image_version, start_date + +# object-attributes: +# - name: "" +# type: "" +# required: true/false +# description: "" +# value: "" +--- \ No newline at end of file diff --git a/_integration-schemas/pinterest-ads/v1/foreign-keys.md b/_integration-schemas/pinterest-ads/v1/foreign-keys.md new file mode 100644 index 000000000..f9ab616c6 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/foreign-keys.md @@ -0,0 +1,21 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas-foreign-keys/ +## FOR INSTRUCTIONS & REFERENCE INFO + +tap-reference: "integration" + +version: "" + +foreign-keys: + - id: "" + table: "" + attribute: "" + all-foreign-keys: + - table: "" + join-on: "" +--- \ No newline at end of file diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md new file mode 100644 index 000000000..55ba99136 --- /dev/null +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -0,0 +1,144 @@ +--- +# -------------------------- # +# 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: SAAS-INTEGRATION (vVERSION) +permalink: /integrations/saas/saas-integration ## Add if there are multiple versions: /vVERSION +keywords: saas-integration, integration, schema, etl saas-integration, saas-integration etl, saas-integration schema +layout: singer +# input: false + +key: "saas-integration-setup" + + +# -------------------------- # +# Tap Details # +# -------------------------- # + +name: "saas-integration" +display_name: "SAAS-INTEGRATION" + +singer: true +status-url: "" + +tap-name: "" ## Ex: Intercom, not intercom +repo-url: https://github.com/singer-io/tap-saas-integration + +this-version: "" + +api: | + [](){:target="new"} + + +# -------------------------- # +# Stitch Details # +# -------------------------- # + +certified: true + +historical: "1 year" +frequency: "1 hour" +tier: "Standard/Enterprise" + +api-type: "" + +anchor-scheduling: true +cron-scheduling: true + +extraction-logs: true +loading-reports: true + +table-selection: true/false +column-selection: true/false + +# attribution-window: "# days" +# attribution-is-configurable: + +# setup-name: "" + + +# -------------------------- # +# Feature Summary # +# -------------------------- # + +feature-summary: | + Stitch's {{ integration.display_name }} integration replicates data using the {{ integration.api | flatify | strip }}. Refer to the [Schema](#schema) section for a list of objects available for replication. + + +# -------------------------- # +# Incompatibilities # +# -------------------------- # + +## uncomment section below if integration is compatible with any Stitch destinations +## if incompatible with multiple destinations, create a section for each destination + +## incompatible: + ## [redshift]: "always,sometimes,never" + ## reason: "copy" + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +requirements-list: + - item: "" + - item: "" + +requirements-info: + +setup-steps: + - title: "" + anchor: "" + content: | + [Add content] + + - title: "Add {{ integration.display_name }} as a Stitch data source" + anchor: "add-stitch-data-source" + content: | + {% include integrations/shared-setup/connection-setup.html %} +# starting with 4., add instructions for additional fields in UI. EX: +# 4. In the [FIELD_NAME] field, [instructions] + + - 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 %} + +## remove this if the integration doesn't support at least table selection + - title: "Set objects to replicate" + anchor: "setting-data-to-replicate" + content: | + {% include integrations/shared-setup/data-selection/object-selection.html %} + + +# -------------------------- # +# Integration Tables # +# -------------------------- # + +# Looking for the table schemas & info? +# Each table has a its own .md file in /_integration-schemas/saas-integration + + +# Remove this if you don't need it: +# schema-sections: +# - title: "" +# anchor: "" +# content: | +--- +{% assign integration = page %} +{% include misc/data-files.html %} \ No newline at end of file diff --git a/scripts/tap-generate-docs/advertisers.md b/scripts/tap-generate-docs/advertisers.md new file mode 100644 index 000000000..ff15010c5 --- /dev/null +++ b/scripts/tap-generate-docs/advertisers.md @@ -0,0 +1,108 @@ +--- +tap: "pinterest-ads" +version: "0.x" +key: "" +name: "advertisers" +doc-link: "" +singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/advertisers.json" +description: "" +replication-method: "" +api-method: + name: "" + doc-link: "" +attributes: + - name: "accepted_terms" + type: "null" + description: "" + - name: "actions" + type: "null" + description: "" + - name: "billing_type" + type: "integer" + description: "" + - name: "business_address" + type: "object" + description: "" + subattributes: + - name: "address_line_1" + type: "string" + description: "" + - name: "address_line_2" + type: "string" + description: "" + - name: "city" + type: "string" + description: "" + - name: "country" + type: "string" + description: "" + - name: "phone_number" + type: "string" + description: "" + - name: "postal_code" + type: "string" + description: "" + - name: "state" + type: "string" + description: "" + - name: "campaign_ids" + type: "null" + description: "" + - name: "country" + type: "string" + description: "" + - name: "created_time" + type: "integer" + description: "" + - name: "currency" + type: "string" + description: "" + - name: "has_valid_billing_profile" + type: "boolean" + description: "" + - name: "id" + type: "string" + description: "" + - name: "is_agency" + type: "boolean" + description: "" + - name: "is_agency_paying" + type: "boolean" + description: "" + - name: "is_one_tap" + type: "boolean" + description: "" + - name: "name" + type: "string" + description: "" + - name: "owner_user_id" + type: "string" + description: "" + - name: "represented_advertiser_country" + type: "string" + description: "" + - name: "roles" + type: "null" + description: "" + - name: "source_integration_platform_type" + type: "string" + description: "" + - name: "status" + type: "string" + description: "" + - name: "test_account" + type: "boolean" + description: "" + - name: "type" + type: "string" + description: "" + - name: "updated_time" + type: "integer" + description: "" + - name: "vat_exempt_number" + type: "string" + description: "" + - name: "vat_number" + type: "string" + description: "" +--- From 4fce8486ce0e99975227801bc8db555ef6b4441a Mon Sep 17 00:00:00 2001 From: Jazmin Smith Date: Thu, 28 Jan 2021 13:29:14 -0500 Subject: [PATCH 02/21] Pinterest Ads/v1 --- .../pinterest-ads/v1/ad_group_report.md | 767 +++++++++++++++++ .../pinterest-ads/v1/advertiser_report.md | 747 +++++++++++++++++ .../pinterest-ads/v1}/advertisers.md | 62 +- .../pinterest-ads/v1/campaign_report.md | 756 +++++++++++++++++ .../pinterest-ads/v1/foreign-keys.md | 38 +- .../pinterest-ads/v1/pin_promotion_report.md | 776 ++++++++++++++++++ .../pinterest-ads/v1/report_fields.md | 26 + 7 files changed, 3148 insertions(+), 24 deletions(-) create mode 100644 _integration-schemas/pinterest-ads/v1/ad_group_report.md create mode 100644 _integration-schemas/pinterest-ads/v1/advertiser_report.md rename {scripts/tap-generate-docs => _integration-schemas/pinterest-ads/v1}/advertisers.md (66%) create mode 100644 _integration-schemas/pinterest-ads/v1/campaign_report.md create mode 100644 _integration-schemas/pinterest-ads/v1/pin_promotion_report.md create mode 100644 _integration-schemas/pinterest-ads/v1/report_fields.md diff --git a/_integration-schemas/pinterest-ads/v1/ad_group_report.md b/_integration-schemas/pinterest-ads/v1/ad_group_report.md new file mode 100644 index 000000000..8a73f1f98 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/ad_group_report.md @@ -0,0 +1,767 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "" + +name: "ad_group_report" +doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/ad-groups" +singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/ad_group_report.json" +description: | + The `{{ table.name }}` table contains reporting information about ad groups in your {{ integration.display_name }} account. + +replication-method: "Key-based Incremental" + +api-method: + name: "Get ad group" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/ad-groups" + +attributes: + - name: "AD_GROUP_ID" + type: "integer" + primary-key: true + description: "The ad group ID." + #foreign-key-id: "adgroup-id" + + - name: "DATE" + type: "date-time" + primary-key: true + description: "The date the report was created." + replication-key: true + + - name: "AD_GROUP_CAMPAIGN_ID" + type: "string" + description: "The ad group's campaign id." + foreign-key-id: "campaign-id" + + - name: "AD_GROUP_CAMPAIGN_MANAGED_STATUS" + type: "string" + description: "" + - name: "AD_GROUP_CAMPAIGN_NAME" + type: "string" + description: "" + - name: "AD_GROUP_CAMPAIGN_STATUS" + type: "string" + description: "" + + - name: "AD_GROUP_NAME" + type: "string" + description: "" + - name: "AD_GROUP_STATUS" + type: "string" + description: "" + - name: "APP_INSTALL_COST_PER_ACTION" + type: "string" + description: "" + - name: "CLICKTHROUGH_1" + type: "integer" + description: "" + - name: "CLICKTHROUGH_2" + type: "integer" + description: "" + - name: "CLOSEUP_1" + type: "integer" + description: "" + - name: "CLOSEUP_2" + type: "integer" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_DOLLAR" + type: "number" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_P95_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPV_IN_MICRO_DOLLAR" + type: "number" + description: "" + + - name: "DESTINATION_VIEWS_1" + type: "integer" + description: "" + - name: "DESTINATION_VIEW_RATE" + type: "number" + description: "" + - name: "ENGAGEMENT_1" + type: "integer" + description: "" + - name: "ENGAGEMENT_2" + type: "integer" + description: "" + - name: "IMPRESSION_1" + type: "integer" + description: "" + - name: "IMPRESSION_2" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_CPA_BILLABLE" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_VALUE" + type: "integer" + description: "" + - name: "REPIN_1" + type: "integer" + description: "" + - name: "REPIN_2" + type: "integer" + description: "" + - name: "SPEND_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_LEAD" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CONVERSIONS" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_LEAD" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_1" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_2" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_1" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_2" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_1" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_2" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_2" + type: "integer" + description: "" +--- diff --git a/_integration-schemas/pinterest-ads/v1/advertiser_report.md b/_integration-schemas/pinterest-ads/v1/advertiser_report.md new file mode 100644 index 000000000..730c805e3 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/advertiser_report.md @@ -0,0 +1,747 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "" + +name: "advertiser_report" +doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" +singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/advertiser_report.json" +description: | + The `{{ table.name }}` table cointains advertiser reporting information in your {{ integration.display_name }} account. + +replication-method: "Key-based Incremental" + +api-method: + name: "Get advertisers" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" + +attributes: + - name: "ADVERTISER_ID" + type: "integer" + primary-key: true + description: "The advertiser ID." + foreign-key-id: "advertiser-id" + + - name: "DATE" + type: "date-time" + primary-key: true + description: "The date the report was created." + replication-key: true + + + - name: "APP_INSTALL_COST_PER_ACTION" + type: "string" + description: "" + - name: "CLICKTHROUGH_1" + type: "integer" + description: "" + - name: "CLICKTHROUGH_2" + type: "integer" + description: "" + - name: "CLOSEUP_1" + type: "integer" + description: "" + - name: "CLOSEUP_2" + type: "integer" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_DOLLAR" + type: "number" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_P95_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPV_IN_MICRO_DOLLAR" + type: "number" + description: "" + + - name: "DESTINATION_VIEWS_1" + type: "integer" + description: "" + - name: "DESTINATION_VIEW_RATE" + type: "number" + description: "" + - name: "ENGAGEMENT_1" + type: "integer" + description: "" + - name: "ENGAGEMENT_2" + type: "integer" + description: "" + - name: "IMPRESSION_1" + type: "integer" + description: "" + - name: "IMPRESSION_2" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_CPA_BILLABLE" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_VALUE" + type: "integer" + description: "" + - name: "REPIN_1" + type: "integer" + description: "" + - name: "REPIN_2" + type: "integer" + description: "" + - name: "SPEND_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_LEAD" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CONVERSIONS" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_LEAD" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_1" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_2" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_1" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_2" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_1" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_2" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_2" + type: "integer" + description: "" +--- diff --git a/scripts/tap-generate-docs/advertisers.md b/_integration-schemas/pinterest-ads/v1/advertisers.md similarity index 66% rename from scripts/tap-generate-docs/advertisers.md rename to _integration-schemas/pinterest-ads/v1/advertisers.md index ff15010c5..aacb873e2 100644 --- a/scripts/tap-generate-docs/advertisers.md +++ b/_integration-schemas/pinterest-ads/v1/advertisers.md @@ -1,22 +1,45 @@ --- tap: "pinterest-ads" -version: "0.x" +version: "1" key: "" + name: "advertisers" -doc-link: "" +doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/advertisers.json" -description: "" -replication-method: "" +description: | + The `{{ table.name }}` table contains information about the advertisers in your {{ integration.display_name }} account. + +replication-method: "Key-based Incremental" + api-method: - name: "" - doc-link: "" + name: "Get advertisers" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" + attributes: + - name: "owner_user_id" + type: "string" + primary-key: true + description: "The ad owner's user ID." + #foreign-key-id: "owner-id" + + - name: "updated_time" + type: "integer" + description: "The time the advertiser's information was last updated." + - name: "accepted_terms" - type: "null" + type: "array" description: "" + subattributes: + - name: "value" + type: "integer" + description: "" - name: "actions" - type: "null" + type: "array" description: "" + subattributes: + - name: "value" + type: "string" + description: "" - name: "billing_type" type: "integer" description: "" @@ -46,8 +69,13 @@ attributes: type: "string" description: "" - name: "campaign_ids" - type: "null" - description: "" + type: "array" + description: "A list of the advertisers' campaign IDs." + foreign-key-id: "campaign-id" + subattributes: + - name: "value" + type: "string" + description: "" - name: "country" type: "string" description: "" @@ -75,15 +103,17 @@ attributes: - name: "name" type: "string" description: "" - - name: "owner_user_id" - type: "string" - description: "" + - name: "represented_advertiser_country" type: "string" description: "" - name: "roles" - type: "null" + type: "array" description: "" + subattributes: + - name: "value" + type: "string" + description: "" - name: "source_integration_platform_type" type: "string" description: "" @@ -96,9 +126,7 @@ attributes: - name: "type" type: "string" description: "" - - name: "updated_time" - type: "integer" - description: "" + - name: "vat_exempt_number" type: "string" description: "" diff --git a/_integration-schemas/pinterest-ads/v1/campaign_report.md b/_integration-schemas/pinterest-ads/v1/campaign_report.md new file mode 100644 index 000000000..b32c2642b --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/campaign_report.md @@ -0,0 +1,756 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "" + +name: "campaign_report" +doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/campaigns" +singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/campaign_report.json" +description: | + The `{{ table.name }}` table contains campaign reporting information in your {{ integration.display_name }} account. + +replication-method: "Key-based Incremental" + +api-method: + name: "Get campaigns" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/campaigns" + +attributes: + - name: "CAMPAIGN_ID" + type: "integer" + primary-key: true + description: "The campaign ID." + foreign-key-id: "campaign_id" + + - name: "DATE" + type: "date-time" + primary-key: true + description: "The date the report was created." + replication-key: true + + - name: "APP_INSTALL_COST_PER_ACTION" + type: "string" + description: "" + + - name: "CAMPAIGN_MANAGED_STATUS" + type: "string" + description: "" + - name: "CAMPAIGN_NAME" + type: "string" + description: "" + - name: "CAMPAIGN_STATUS" + type: "string" + description: "" + - name: "CLICKTHROUGH_1" + type: "integer" + description: "" + - name: "CLICKTHROUGH_2" + type: "integer" + description: "" + - name: "CLOSEUP_1" + type: "integer" + description: "" + - name: "CLOSEUP_2" + type: "integer" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_DOLLAR" + type: "number" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_P95_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPV_IN_MICRO_DOLLAR" + type: "number" + description: "" + + - name: "DESTINATION_VIEWS_1" + type: "integer" + description: "" + - name: "DESTINATION_VIEW_RATE" + type: "number" + description: "" + - name: "ENGAGEMENT_1" + type: "integer" + description: "" + - name: "ENGAGEMENT_2" + type: "integer" + description: "" + - name: "IMPRESSION_1" + type: "integer" + description: "" + - name: "IMPRESSION_2" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_CPA_BILLABLE" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_VALUE" + type: "integer" + description: "" + - name: "REPIN_1" + type: "integer" + description: "" + - name: "REPIN_2" + type: "integer" + description: "" + - name: "SPEND_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_LEAD" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CONVERSIONS" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_LEAD" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_1" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_2" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_1" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_2" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_1" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_2" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_2" + type: "integer" + description: "" +--- diff --git a/_integration-schemas/pinterest-ads/v1/foreign-keys.md b/_integration-schemas/pinterest-ads/v1/foreign-keys.md index f9ab616c6..c93f9c1f2 100644 --- a/_integration-schemas/pinterest-ads/v1/foreign-keys.md +++ b/_integration-schemas/pinterest-ads/v1/foreign-keys.md @@ -7,15 +7,39 @@ ## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas-foreign-keys/ ## FOR INSTRUCTIONS & REFERENCE INFO -tap-reference: "integration" +tap-reference: "pinterest-ads" -version: "" +version: "1" foreign-keys: - - id: "" - table: "" - attribute: "" + - id: "advertiser-id" + table: "advertisers" + attribute: "advertiser_id" all-foreign-keys: - - table: "" - join-on: "" + - table: "advertisers" + join-on: "advertiser_id" + - table: "advertiser_report" + join-on: "advertiser_id" + + - id: "campaign-id" + table: "campaign_report" + attribute: "campaign_id" + all-foreign-keys: + - table: "campaign_report" + join-on: "campaign_id" + - table: "ad_group_report" + join-on: "ad_group_campaign_id" + - table: "pin_promotion_report" + join-on: "pin_promotion_campaign_id" + - table: "advertisers" + join-on: "campaign_ids" + + - id: "adgroup-id" + table: "ad_group_report" + attribute: "ad_group_id" + all-foreign-keys: + - table: "ad_group_report" + join-on: "ad_group_id" + - table: "pin_promotion_report" + join-on: "pin_promotion_ad_group_id" --- \ No newline at end of file diff --git a/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md b/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md new file mode 100644 index 000000000..521ddd192 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md @@ -0,0 +1,776 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "" + +name: "pin_promotion_report" +doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#operation/ads_v3_get_pin_promotion_handler_GET" +singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/pin_promotion_report.json" +description: | + The `{{ table.name }}` table contains pin promotion reporting information in your {{ integration.display_name }} account. + +replication-method: "Key-based Incremental" + +api-method: + name: "Get pin promotions" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#operation/ads_v3_get_pin_promotion_handler_GET" + +attributes: + - name: "PIN_PROMOTION_ID" + type: "integer" + primary-key: true + description: "The pin promotion ID." + #foreign-key-id: "pin-promotion-id" + + - name: "DATE" + type: "date-time" + primary-key: true + description: "The date the report was created." + replication-key: true + + - name: "APP_INSTALL_COST_PER_ACTION" + type: "string" + description: "" + - name: "CLICKTHROUGH_1" + type: "integer" + description: "" + - name: "CLICKTHROUGH_2" + type: "integer" + description: "" + - name: "CLOSEUP_1" + type: "integer" + description: "" + - name: "CLOSEUP_2" + type: "integer" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_DOLLAR" + type: "number" + description: "" + - name: "COST_PER_DESTINATION_VIEW_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPCV_P95_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "CPV_IN_MICRO_DOLLAR" + type: "number" + description: "" + + - name: "DESTINATION_VIEWS_1" + type: "integer" + description: "" + - name: "DESTINATION_VIEW_RATE" + type: "number" + description: "" + - name: "ENGAGEMENT_1" + type: "integer" + description: "" + - name: "ENGAGEMENT_2" + type: "integer" + description: "" + - name: "IMPRESSION_1" + type: "integer" + description: "" + - name: "IMPRESSION_2" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_CPA_BILLABLE" + type: "integer" + description: "" + - name: "ONSITE_CHECKOUTS_VALUE" + type: "integer" + description: "" + - name: "PIN_PROMOTIONAD_GROUP_STATUS" + type: "string" + description: "" + - name: "PIN_PROMOTIONCAMPAIGN_ID" + type: "integer" + description: "The pin promotion campaign ID." + foreign-key-id: "campaign-id" + - name: "PIN_PROMOTION_AD_GROUP_ID" + type: "integer" + description: "The pin promotion ad group ID." + foreign-key-id: "adgroup-id" + - name: "PIN_PROMOTION_AD_GROUP_NAME" + type: "string" + description: "" + - name: "PIN_PROMOTION_CAMPAIGN_MANAGED_STATUS" + type: "string" + description: "" + - name: "PIN_PROMOTION_CAMPAIGN_NAME" + type: "string" + description: "" + - name: "PIN_PROMOTION_CAMPAIGN_STATUS" + type: "string" + description: "" + + - name: "PIN_PROMOTION_NAME" + type: "string" + description: "" + - name: "PIN_PROMOTION_STATUS" + type: "string" + description: "" + - name: "REPIN_1" + type: "integer" + description: "" + - name: "REPIN_2" + type: "integer" + description: "" + - name: "SPEND_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ADD_TO_CART_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CHECKOUT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_CLICK_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_LEAD" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CLICK_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CONVERSIONS" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_CUSTOM_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_ENGAGEMENT_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_LEAD_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_PAGE_VISIT_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SEARCH_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_SIGNUP_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_UNKNOWN_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_ADD_TO_CART_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL" + type: "integer" + description: "" + - name: "TOTAL_VIEW_APP_INSTALL_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CATEGORY_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CHECKOUT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_CUSTOM" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_CUSTOM_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_LEAD" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_LEAD_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_PAGE_VISIT_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SEARCH" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SEARCH_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_SIGNUP" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_SIGNUP_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_UNKNOWN" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_UNKNOWN_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_VIEW_CATEGORY_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_QUANTITY" + type: "integer" + description: "" + - name: "TOTAL_VIEW_WATCH_VIDEO_VALUE_IN_MICRO_DOLLAR" + type: "number" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_DESKTOP_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_MOBILE_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_DESKTOP_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_MOBILE_CONVERSION" + type: "integer" + description: "" + - name: "TOTAL_WATCH_VIDEO_TABLET_ACTION_TO_TABLET_CONVERSION" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_1" + type: "integer" + description: "" + - name: "VIDEO_AVG_WATCHTIME_IN_SECOND_2" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_1" + type: "integer" + description: "" + - name: "VIDEO_MRC_VIEWS_2" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P0_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_1" + type: "integer" + description: "" + - name: "VIDEO_P100_COMPLETE_2" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P25_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P50_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P75_COMBINED_2" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_1" + type: "integer" + description: "" + - name: "VIDEO_P95_COMBINED_2" + type: "integer" + description: "" +--- diff --git a/_integration-schemas/pinterest-ads/v1/report_fields.md b/_integration-schemas/pinterest-ads/v1/report_fields.md new file mode 100644 index 000000000..bcee80c9f --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/report_fields.md @@ -0,0 +1,26 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "" + +name: "report_fields" +doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/reports" +singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/report_fields.json" +description: | + The `{{ table.name }}` table contains information about the report fields definitions. + +replication-method: "Full Table" + +api-method: + name: "Get async advertiser delivery metrics report" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/reports" + +attributes: + - name: "definition" + type: "string" + description: "The definition of the field." + - name: "name" + type: "string" + primary-key: true + description: "The field name." +--- From 9a13e475cdead25495e7398e1d241f52de110461 Mon Sep 17 00:00:00 2001 From: Jazmin Smith Date: Thu, 4 Feb 2021 10:44:57 -0500 Subject: [PATCH 03/21] remaining files waiting on icon when it goes into beta --- _data/taps/versions/pinterest-ads.yml | 8 +-- .../sources/saas/pinterest-ads.md | 55 ++++++++++++++---- .../pinterest-ads/v1/pinterest-ads-v1.md | 58 ++++++++++--------- 3 files changed, 80 insertions(+), 41 deletions(-) diff --git a/_data/taps/versions/pinterest-ads.yml b/_data/taps/versions/pinterest-ads.yml index ecd4c0b76..1bc6e4bab 100644 --- a/_data/taps/versions/pinterest-ads.yml +++ b/_data/taps/versions/pinterest-ads.yml @@ -8,14 +8,14 @@ # -------------------------- # -# [INTEGRATION] VERSIONS # +# PINTEREST ADS VERSIONS # # -------------------------- # -latest-version: "" +latest-version: "1" released-versions: - - number: "" - status: "" ## beta, released, deprecated + - number: "1" + status: "beta" ## beta, released, deprecated date-released: "" # date-last-connection: deprecation-date: "" diff --git a/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md b/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md index 17b704747..8bbc86b1f 100644 --- a/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md +++ b/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md @@ -15,16 +15,16 @@ product-type: "connect" content-type: "api-form" form-type: "source" -key: "source-form-properties-[integration]-object" +key: "source-form-properties-pinterest-ads-object" # -------------------------- # # OBJECT INFO # # -------------------------- # -title: "[INTEGRATION] Source Form Property" -api-type: "platform.[integration]" -display-name: "[INTEGRATION]" +title: "Pinterest Ads Source Form Property" +api-type: "platform.pinterest-ads" +display-name: "Pinterest Ads" source-type: "saas" docs-name: "" # This should be whatever integration.name is. Ex: LinkedIn Ads is linkedin-ads @@ -35,7 +35,7 @@ property-description: "" # -------------------------- # -# OBJECT ATTRIBUTES # +# FORM PROPERTIES # # -------------------------- # uses-start-date: true @@ -45,10 +45,43 @@ uses-start-date: true # and therefore don't need to be listed: # anchor_time, cron_expression, frequency_in_minutes, image_version, start_date -# object-attributes: -# - name: "" -# type: "" -# required: true/false -# description: "" -# value: "" +object-attributes: + - name: "advertisers" + type: "string" + required: true + description: | + A comma-delimited list of the advertiser ID's in your {{ form-property.display-name }} you want to replicate data from." + value: ", " + + - name: "attribution_window" + type: "string" + required: false + description: | + Defines the number, in days, Stitch should use as an attribution window. To ensure your {{ form-property.display-name }} and Stitch settings align, we recommend using the same attribution window in Stitch that you use in {{ form-property.display-name }}. This option is only available to suppport users. Please only change if you understand the impact. + value: "30" + + - name: "date_window_size" + type: "string" + required: false + description: | + Defines the number, in days, for a date looping window. Date looping will return records whose `from_date` and `to_date` fall between the number of days in the defined window size. This option is only available to suppport users. Please only change if you understand the impact. + value: "30" + + +# -------------------------- # +# OAUTH PROPERTIES # +# -------------------------- # + +oauth-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#section/User-Authorization/Start-the-OAuth-flow-(explicit-server-side)" + +oauth-description: "" + +oauth-attributes: + - name: "access_token" + type: "string" + required: true + credential: true + description: | + The {{ form-property.display-name }} token to use in future requests to the {{ form-property.display-name }} API, created after a successful OAuth handshake. + value: "" --- \ No newline at end of file diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index 55ba99136..96adeac86 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -12,32 +12,32 @@ # Page & Formatting # # -------------------------- # -title: SAAS-INTEGRATION (vVERSION) -permalink: /integrations/saas/saas-integration ## Add if there are multiple versions: /vVERSION -keywords: saas-integration, integration, schema, etl saas-integration, saas-integration etl, saas-integration schema +title: Pinterest Ads (vVERSION) +permalink: /integrations/saas/pinterest-ads ## Add if there are multiple versions: /vVERSION +keywords: pinterest-ads, integration, schema, etl pinterest-ads, pinterest-ads etl, pinterest-ads schema layout: singer # input: false -key: "saas-integration-setup" +key: "pinterest-ads-setup" # -------------------------- # # Tap Details # # -------------------------- # -name: "saas-integration" -display_name: "SAAS-INTEGRATION" +name: "pinterest-ads" +display_name: "Pinterest Ads" singer: true status-url: "" -tap-name: "" ## Ex: Intercom, not intercom -repo-url: https://github.com/singer-io/tap-saas-integration +tap-name: "Pinterest Ads" ## Ex: Intercom, not intercom +repo-url: https://github.com/singer-io/tap-pinterest-ads -this-version: "" +this-version: "1" api: | - [](){:target="new"} + [Pinterest Ads API V3](https://developers.pinterest.com/docs/redoc/adsreporting/){:target="new"} # -------------------------- # @@ -48,9 +48,9 @@ certified: true historical: "1 year" frequency: "1 hour" -tier: "Standard/Enterprise" +tier: "Standard" -api-type: "" +api-type: "platform.pinterest-ads" anchor-scheduling: true cron-scheduling: true @@ -58,8 +58,8 @@ cron-scheduling: true extraction-logs: true loading-reports: true -table-selection: true/false -column-selection: true/false +table-selection: true +column-selection: true # attribution-window: "# days" # attribution-is-configurable: @@ -91,35 +91,41 @@ feature-summary: | # -------------------------- # requirements-list: - - item: "" - - item: "" - -requirements-info: + - item: | + A {{ integration.display_name }} OAuth App. If you don't have one, refer to {{ integration.display_name }}'s docs [here](https://developers.pinterest.com/docs/redoc/adsreporting/#section/User-Authorization/Start-the-OAuth-flow-(explicit-server-side)) for instructions on how to create one. setup-steps: - - title: "" - anchor: "" + - title: "Identify your advertisers" + anchor: "identify-advertisers" content: | - [Add content] + 1. Login to your {{ integration.display_name }} account. + 2. Navigate to the overhead menu bar and click **`Ads` > `Overview`**. + 3. In the column on the left-hand side of the page, navigate to the **Ad Status** section and click **All**. + 4. You should see all of your advertisers. Copy the advertiser names you'd like to replicate in Stitch and paste those values someplace safe to use for the next step. - title: "Add {{ integration.display_name }} as a Stitch data source" anchor: "add-stitch-data-source" content: | {% include integrations/shared-setup/connection-setup.html %} -# starting with 4., add instructions for additional fields in UI. EX: -# 4. In the [FIELD_NAME] field, [instructions] + 4. In the **Advertisers** field, paste the advertisers you copied in [step 1](#identify-advertisers), separated by commas. - title: "Define the historical replication start date" anchor: "define-historical-sync" content: | - {% include integrations/saas/setup/historical-sync.html %} + {% include integrations/saas/setup/historical-sync.html %} - title: "Create a replication schedule" anchor: "define-rep-frequency" content: | {% include integrations/shared-setup/replication-frequency.html %} -## remove this if the integration doesn't support at least table selection + - title: "Authorize Stitch to access {{ integration.display_name }}" + anchor: "grant-stitch-authorization" + content: | + 1. Next, you'll be redirected to {{ integration.display_name }}. + 2. Log into your {{ integration.display_name }} account and complete the authorization process. When finished, you'll be redirected back to Stitch. + 3. Click {{ app.buttons.finish-int-setup }}. + - title: "Set objects to replicate" anchor: "setting-data-to-replicate" content: | @@ -131,7 +137,7 @@ setup-steps: # -------------------------- # # Looking for the table schemas & info? -# Each table has a its own .md file in /_integration-schemas/saas-integration +# Each table has a its own .md file in /_integration-schemas/pinterest-ads # Remove this if you don't need it: From 08ccb3c1a05b013d0d14795ce0cb30a78484b4b6 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:18:31 -0500 Subject: [PATCH 04/21] Update advertisers.md --- _integration-schemas/pinterest-ads/v1/advertisers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_integration-schemas/pinterest-ads/v1/advertisers.md b/_integration-schemas/pinterest-ads/v1/advertisers.md index aacb873e2..713059547 100644 --- a/_integration-schemas/pinterest-ads/v1/advertisers.md +++ b/_integration-schemas/pinterest-ads/v1/advertisers.md @@ -1,7 +1,7 @@ --- tap: "pinterest-ads" version: "1" -key: "" +key: "advertiser" name: "advertisers" doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" From b5ad5c59c1dd8a6b9a608936c5bb7074959f8aa5 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:23:07 -0500 Subject: [PATCH 05/21] Update campaign_report.md --- _integration-schemas/pinterest-ads/v1/campaign_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_integration-schemas/pinterest-ads/v1/campaign_report.md b/_integration-schemas/pinterest-ads/v1/campaign_report.md index b32c2642b..ac013ee1f 100644 --- a/_integration-schemas/pinterest-ads/v1/campaign_report.md +++ b/_integration-schemas/pinterest-ads/v1/campaign_report.md @@ -1,7 +1,7 @@ --- tap: "pinterest-ads" version: "1" -key: "" +key: "campaign-report" name: "campaign_report" doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/campaigns" From 6e7f2aa27e1d04e63396697de2e681103c89c722 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:24:38 -0500 Subject: [PATCH 06/21] Update ad_group_report.md --- _integration-schemas/pinterest-ads/v1/ad_group_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_integration-schemas/pinterest-ads/v1/ad_group_report.md b/_integration-schemas/pinterest-ads/v1/ad_group_report.md index 8a73f1f98..ba48ba460 100644 --- a/_integration-schemas/pinterest-ads/v1/ad_group_report.md +++ b/_integration-schemas/pinterest-ads/v1/ad_group_report.md @@ -1,7 +1,7 @@ --- tap: "pinterest-ads" version: "1" -key: "" +key: "ad-group-report" name: "ad_group_report" doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/ad-groups" From 518e66655602117b6d0d97cfb22baec066809741 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:25:37 -0500 Subject: [PATCH 07/21] Update advertiser_report.md --- _integration-schemas/pinterest-ads/v1/advertiser_report.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/_integration-schemas/pinterest-ads/v1/advertiser_report.md b/_integration-schemas/pinterest-ads/v1/advertiser_report.md index 730c805e3..c198c9c46 100644 --- a/_integration-schemas/pinterest-ads/v1/advertiser_report.md +++ b/_integration-schemas/pinterest-ads/v1/advertiser_report.md @@ -1,7 +1,7 @@ --- tap: "pinterest-ads" version: "1" -key: "" +key: "advertiser-report" name: "advertiser_report" doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" @@ -12,8 +12,8 @@ description: | replication-method: "Key-based Incremental" api-method: - name: "Get advertisers" - doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" + name: "Get advertisers" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/advertisers" attributes: - name: "ADVERTISER_ID" @@ -27,7 +27,6 @@ attributes: primary-key: true description: "The date the report was created." replication-key: true - - name: "APP_INSTALL_COST_PER_ACTION" type: "string" From 65d84b6a5ae786a19eeaa11360ee7814da67479d Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:29:13 -0500 Subject: [PATCH 08/21] Update pin_promotion_report.md --- .../pinterest-ads/v1/pin_promotion_report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md b/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md index 521ddd192..b0363e016 100644 --- a/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md +++ b/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md @@ -1,7 +1,7 @@ --- tap: "pinterest-ads" version: "1" -key: "" +key: "pin-promotion-report" name: "pin_promotion_report" doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#operation/ads_v3_get_pin_promotion_handler_GET" @@ -12,8 +12,8 @@ description: | replication-method: "Key-based Incremental" api-method: - name: "Get pin promotions" - doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#operation/ads_v3_get_pin_promotion_handler_GET" + name: "Get pin promotions" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#operation/ads_v3_get_pin_promotion_handler_GET" attributes: - name: "PIN_PROMOTION_ID" From c8be585844cbe74dae300089b750e46877bb0fdd Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:30:00 -0500 Subject: [PATCH 09/21] Update report_fields.md --- _integration-schemas/pinterest-ads/v1/report_fields.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/_integration-schemas/pinterest-ads/v1/report_fields.md b/_integration-schemas/pinterest-ads/v1/report_fields.md index bcee80c9f..bf50051a8 100644 --- a/_integration-schemas/pinterest-ads/v1/report_fields.md +++ b/_integration-schemas/pinterest-ads/v1/report_fields.md @@ -1,24 +1,25 @@ --- tap: "pinterest-ads" version: "1" -key: "" +key: "report-field" name: "report_fields" doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/reports" singer-schema: "https://github.com/singer-io/tap-pinterest-ads/blob/master/tap_pinterest_ads/schemas/report_fields.json" description: | - The `{{ table.name }}` table contains information about the report fields definitions. + The `{{ table.name }}` table contains information about report field definitions. replication-method: "Full Table" api-method: - name: "Get async advertiser delivery metrics report" - doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/reports" + name: "Get async advertiser delivery metrics report" + doc-link: "https://developers.pinterest.com/docs/redoc/adsreporting/#tag/reports" attributes: - name: "definition" type: "string" description: "The definition of the field." + - name: "name" type: "string" primary-key: true From 3b8743e9cb029f48a34096e2f5a8dad2fc25cbc0 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:48:06 -0500 Subject: [PATCH 10/21] Update _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md --- _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index 96adeac86..8c0de04b6 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -101,7 +101,7 @@ setup-steps: 1. Login to your {{ integration.display_name }} account. 2. Navigate to the overhead menu bar and click **`Ads` > `Overview`**. 3. In the column on the left-hand side of the page, navigate to the **Ad Status** section and click **All**. - 4. You should see all of your advertisers. Copy the advertiser names you'd like to replicate in Stitch and paste those values someplace safe to use for the next step. + 4. Your advertisers should display. Copy the names of the advertisers you'd like to replicate in Stitch and paste those values someplace safe to use for the next step. - title: "Add {{ integration.display_name }} as a Stitch data source" anchor: "add-stitch-data-source" @@ -147,4 +147,4 @@ setup-steps: # content: | --- {% assign integration = page %} -{% include misc/data-files.html %} \ No newline at end of file +{% include misc/data-files.html %} From 0eda6b79b833a8fa27eb3789efd53b4eab0ee174 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Thu, 4 Feb 2021 11:48:17 -0500 Subject: [PATCH 11/21] Update _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md --- _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index 8c0de04b6..6581092f0 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -108,6 +108,8 @@ setup-steps: content: | {% include integrations/shared-setup/connection-setup.html %} 4. In the **Advertisers** field, paste the advertisers you copied in [step 1](#identify-advertisers), separated by commas. + + For example: `advertiser_1, advertiser_2` - title: "Define the historical replication start date" anchor: "define-historical-sync" From a4ec57e71bce235b1865d14435b41d2d317b2d8c Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Mon, 8 Feb 2021 14:00:24 -0500 Subject: [PATCH 12/21] Update _developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md Co-authored-by: Erin Cochran --- .../api/objects/form-properties/sources/saas/pinterest-ads.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md b/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md index 8bbc86b1f..9703389a0 100644 --- a/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md +++ b/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md @@ -50,7 +50,7 @@ object-attributes: type: "string" required: true description: | - A comma-delimited list of the advertiser ID's in your {{ form-property.display-name }} you want to replicate data from." + A comma-delimited list of the advertiser IDs in your {{ form-property.display-name }} account you want to replicate data from. value: ", " - name: "attribution_window" @@ -84,4 +84,4 @@ oauth-attributes: description: | The {{ form-property.display-name }} token to use in future requests to the {{ form-property.display-name }} API, created after a successful OAuth handshake. value: "" ---- \ No newline at end of file +--- From 005272a09118178b199c8c7254e286ae5b4ad20f Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Mon, 8 Feb 2021 14:00:33 -0500 Subject: [PATCH 13/21] Update _integration-schemas/pinterest-ads/v1/advertisers.md Co-authored-by: Erin Cochran --- _integration-schemas/pinterest-ads/v1/advertisers.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/_integration-schemas/pinterest-ads/v1/advertisers.md b/_integration-schemas/pinterest-ads/v1/advertisers.md index 713059547..01affc4ce 100644 --- a/_integration-schemas/pinterest-ads/v1/advertisers.md +++ b/_integration-schemas/pinterest-ads/v1/advertisers.md @@ -24,7 +24,9 @@ attributes: - name: "updated_time" type: "integer" - description: "The time the advertiser's information was last updated." + primary-key: true + replication-key: true + description: "The time the advertiser's information was last updated." - name: "accepted_terms" type: "array" From efa0c55f33a2642822a3c21c693229bad26a7a16 Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:47:23 -0500 Subject: [PATCH 14/21] Update _integration-schemas/pinterest-ads/v1/campaign_report.md Co-authored-by: Erin Cochran --- _integration-schemas/pinterest-ads/v1/campaign_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_integration-schemas/pinterest-ads/v1/campaign_report.md b/_integration-schemas/pinterest-ads/v1/campaign_report.md index ac013ee1f..d87595a1f 100644 --- a/_integration-schemas/pinterest-ads/v1/campaign_report.md +++ b/_integration-schemas/pinterest-ads/v1/campaign_report.md @@ -20,7 +20,7 @@ attributes: type: "integer" primary-key: true description: "The campaign ID." - foreign-key-id: "campaign_id" + foreign-key-id: "campaign-id" - name: "DATE" type: "date-time" From 371072a7ef5b5a7ab2a595c2d6290ed9a02897e9 Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:53:45 -0500 Subject: [PATCH 15/21] Update _integration-schemas/pinterest-ads/v1/foreign-keys.md Co-authored-by: Erin Cochran --- _integration-schemas/pinterest-ads/v1/foreign-keys.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/_integration-schemas/pinterest-ads/v1/foreign-keys.md b/_integration-schemas/pinterest-ads/v1/foreign-keys.md index c93f9c1f2..a6775377c 100644 --- a/_integration-schemas/pinterest-ads/v1/foreign-keys.md +++ b/_integration-schemas/pinterest-ads/v1/foreign-keys.md @@ -32,7 +32,8 @@ foreign-keys: - table: "pin_promotion_report" join-on: "pin_promotion_campaign_id" - table: "advertisers" - join-on: "campaign_ids" + subattribute: "campaign_ids" + join-on: "value" - id: "adgroup-id" table: "ad_group_report" @@ -42,4 +43,4 @@ foreign-keys: join-on: "ad_group_id" - table: "pin_promotion_report" join-on: "pin_promotion_ad_group_id" ---- \ No newline at end of file +--- From 5a98cf301bfd1be55d02b488fc323b27788cba07 Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:54:00 -0500 Subject: [PATCH 16/21] Update _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md Co-authored-by: Erin Cochran --- _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index 6581092f0..c11be29cf 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -37,7 +37,7 @@ repo-url: https://github.com/singer-io/tap-pinterest-ads this-version: "1" api: | - [Pinterest Ads API V3](https://developers.pinterest.com/docs/redoc/adsreporting/){:target="new"} + [{{ integration.display_name }} Ads API V3](https://developers.pinterest.com/docs/redoc/adsreporting/){:target="new"} # -------------------------- # From 6a9c5d3ba7eeb08ec64cc093b0957997943d88f0 Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:54:20 -0500 Subject: [PATCH 17/21] Update _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md Co-authored-by: Erin Cochran --- _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index c11be29cf..b9cefc441 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -12,7 +12,7 @@ # Page & Formatting # # -------------------------- # -title: Pinterest Ads (vVERSION) +title: Pinterest Ads (v1) permalink: /integrations/saas/pinterest-ads ## Add if there are multiple versions: /vVERSION keywords: pinterest-ads, integration, schema, etl pinterest-ads, pinterest-ads etl, pinterest-ads schema layout: singer From fefebbfef78155e52fd98f632d62e87119c82a78 Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:54:36 -0500 Subject: [PATCH 18/21] Update _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md Co-authored-by: Erin Cochran --- _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index b9cefc441..7835de58b 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -92,7 +92,7 @@ feature-summary: | requirements-list: - item: | - A {{ integration.display_name }} OAuth App. If you don't have one, refer to {{ integration.display_name }}'s docs [here](https://developers.pinterest.com/docs/redoc/adsreporting/#section/User-Authorization/Start-the-OAuth-flow-(explicit-server-side)) for instructions on how to create one. + A {{ integration.display_name }} OAuth App. If you don't have one, refer to {{ integration.display_name }}'s [documentation](https://developers.pinterest.com/docs/redoc/adsreporting/#section/User-Authorization){:target="new"} for instructions on how to create one. setup-steps: - title: "Identify your advertisers" From b48f375147dff17b8b41d5619025b49a53c84abf Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:54:50 -0500 Subject: [PATCH 19/21] Update _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md Co-authored-by: Erin Cochran --- _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index 7835de58b..4b9452035 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -120,6 +120,8 @@ setup-steps: anchor: "define-rep-frequency" content: | {% include integrations/shared-setup/replication-frequency.html %} + + When finished, click **Authorize**. - title: "Authorize Stitch to access {{ integration.display_name }}" anchor: "grant-stitch-authorization" From ad73b2ebca806d2866f886ba26fa8eed00b8724a Mon Sep 17 00:00:00 2001 From: jazsmi <54365670+jazsmi@users.noreply.github.com> Date: Tue, 9 Feb 2021 18:51:50 -0500 Subject: [PATCH 20/21] Update _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md Co-authored-by: Erin Cochran --- _saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md index 4b9452035..41a6252bb 100644 --- a/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -99,7 +99,7 @@ setup-steps: anchor: "identify-advertisers" content: | 1. Login to your {{ integration.display_name }} account. - 2. Navigate to the overhead menu bar and click **`Ads` > `Overview`**. + 2. Navigate to the overhead menu bar and click **Ads > Overview**. 3. In the column on the left-hand side of the page, navigate to the **Ad Status** section and click **All**. 4. Your advertisers should display. Copy the names of the advertisers you'd like to replicate in Stitch and paste those values someplace safe to use for the next step. From bfc2ce6431576fc04fcdd0ccf7d200c4e7825593 Mon Sep 17 00:00:00 2001 From: Jazmin Smith Date: Tue, 9 Feb 2021 18:52:45 -0500 Subject: [PATCH 21/21] Update advertisers.md --- _integration-schemas/pinterest-ads/v1/advertisers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_integration-schemas/pinterest-ads/v1/advertisers.md b/_integration-schemas/pinterest-ads/v1/advertisers.md index 01affc4ce..965ee75b2 100644 --- a/_integration-schemas/pinterest-ads/v1/advertisers.md +++ b/_integration-schemas/pinterest-ads/v1/advertisers.md @@ -73,11 +73,11 @@ attributes: - name: "campaign_ids" type: "array" description: "A list of the advertisers' campaign IDs." - foreign-key-id: "campaign-id" subattributes: - name: "value" type: "string" - description: "" + description: "The campaign ID." + foreign-key-id: "campaign-id" - name: "country" type: "string" description: ""