diff --git a/_data/taps/versions/pinterest-ads.yml b/_data/taps/versions/pinterest-ads.yml new file mode 100644 index 000000000..1bc6e4bab --- /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 + + +# -------------------------- # +# PINTEREST ADS VERSIONS # +# -------------------------- # + +latest-version: "1" + +released-versions: + - number: "1" + status: "beta" ## 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..9703389a0 --- /dev/null +++ b/_developer-files/connect/api/objects/form-properties/sources/saas/pinterest-ads.md @@ -0,0 +1,87 @@ +--- +# -------------------------- # +# 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-pinterest-ads-object" + + +# -------------------------- # +# OBJECT INFO # +# -------------------------- # + +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 + +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 + + +# -------------------------- # +# FORM PROPERTIES # +# -------------------------- # + +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: "advertisers" + type: "string" + required: true + description: | + 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" + 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: "" +--- 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..ba48ba460 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/ad_group_report.md @@ -0,0 +1,767 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "ad-group-report" + +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..c198c9c46 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/advertiser_report.md @@ -0,0 +1,746 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "advertiser-report" + +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/_integration-schemas/pinterest-ads/v1/advertisers.md b/_integration-schemas/pinterest-ads/v1/advertisers.md new file mode 100644 index 000000000..965ee75b2 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/advertisers.md @@ -0,0 +1,138 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "advertiser" + +name: "advertisers" +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: | + The `{{ table.name }}` table contains information about the advertisers 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: "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" + primary-key: true + replication-key: true + description: "The time the advertiser's information was last updated." + + - name: "accepted_terms" + type: "array" + description: "" + subattributes: + - name: "value" + type: "integer" + description: "" + - name: "actions" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + 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: "array" + description: "A list of the advertisers' campaign IDs." + subattributes: + - name: "value" + type: "string" + description: "The campaign ID." + foreign-key-id: "campaign-id" + - 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: "represented_advertiser_country" + type: "string" + description: "" + - name: "roles" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + 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: "vat_exempt_number" + type: "string" + description: "" + - name: "vat_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..d87595a1f --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/campaign_report.md @@ -0,0 +1,756 @@ +--- +tap: "pinterest-ads" +version: "1" +key: "campaign-report" + +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 new file mode 100644 index 000000000..a6775377c --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/foreign-keys.md @@ -0,0 +1,46 @@ +--- +# -------------------------- # +# 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: "pinterest-ads" + +version: "1" + +foreign-keys: + - id: "advertiser-id" + table: "advertisers" + attribute: "advertiser_id" + all-foreign-keys: + - 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" + subattribute: "campaign_ids" + join-on: "value" + + - 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" +--- 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..b0363e016 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/pin_promotion_report.md @@ -0,0 +1,776 @@ +--- +tap: "pinterest-ads" +version: "1" +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" +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..bf50051a8 --- /dev/null +++ b/_integration-schemas/pinterest-ads/v1/report_fields.md @@ -0,0 +1,27 @@ +--- +tap: "pinterest-ads" +version: "1" +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 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" + +attributes: + - name: "definition" + type: "string" + description: "The definition of the field." + + - name: "name" + type: "string" + primary-key: true + description: "The field name." +--- 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..41a6252bb --- /dev/null +++ b/_saas-integrations/pinterest-ads/v1/pinterest-ads-v1.md @@ -0,0 +1,154 @@ +--- +# -------------------------- # +# 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: 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 +# input: false + +key: "pinterest-ads-setup" + + +# -------------------------- # +# Tap Details # +# -------------------------- # + +name: "pinterest-ads" +display_name: "Pinterest Ads" + +singer: true +status-url: "" + +tap-name: "Pinterest Ads" ## Ex: Intercom, not intercom +repo-url: https://github.com/singer-io/tap-pinterest-ads + +this-version: "1" + +api: | + [{{ integration.display_name }} Ads API V3](https://developers.pinterest.com/docs/redoc/adsreporting/){:target="new"} + + +# -------------------------- # +# Stitch Details # +# -------------------------- # + +certified: true + +historical: "1 year" +frequency: "1 hour" +tier: "Standard" + +api-type: "platform.pinterest-ads" + +anchor-scheduling: true +cron-scheduling: true + +extraction-logs: true +loading-reports: true + +table-selection: true +column-selection: true + +# 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: | + 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" + anchor: "identify-advertisers" + 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. 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" + 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" + 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 %} + + When finished, click **Authorize**. + + - 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: | + {% 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/pinterest-ads + + +# Remove this if you don't need it: +# schema-sections: +# - title: "" +# anchor: "" +# content: | +--- +{% assign integration = page %} +{% include misc/data-files.html %}