Pinterest Ads API Version Upgrade (v4)

As a part of the upgrade of Pinterest API to v4 that planned for Thursday 30-Dec-2021, there are several changes for existing common Pinterest reports:

Ads Delivery report

  • Conversation Report Time Renaming:
    Ad Event → Time of Ad Action,
    Conversion Event → Time of Conversion

  • Deprecated Fields:
    onsite_checkouts
    onsite_checkouts_cpa_billable
    onsite_checkouts_value

  • Deprecated Parameter "Data Source"

  • Filter Changes:
    Alll operators previously used have been replaced with ‘less_than’ and ‘greater_than’.

  • Added Fields:
    paid_impression
    cpc_in_micro_dollar
    ecpc_in_micro_dollar
    ctr
    ectr
    total_engagement
    ecpm_in_micro_dollar
    ctr_2
    cpm_in_micro_dollar
    total_engagement_app_install
    total_click_app_install
    total_view_app_install
    total_engagement_app_install_value_in_micro_dollar
    total_click_app_install_value_in_micro_dollar
    total_view_app_install_value_in_micro_dollar
    onsite_checkouts_1
    campaign_lifetime_spend_cap
    campaign_daily_spend_cap
    total_app_install_desktop_action_to_desktop_conversion
    total_app_install_desktop_action_to_mobile_conversion
    total_app_install_desktop_action_to_tablet_conversion
    total_app_install_mobile_action_to_desktop_conversion
    total_app_install_mobile_action_to_mobile_conversion
    total_app_install_mobile_action_to_tablet_conversion
    total_app_install_tablet_action_to_desktop_conversion
    total_app_install_tablet_action_to_mobile_conversion
    total_app_install_tablet_action_to_tablet_conversion
    total_checkout
    total_custom
    total_lead
    total_app_install
    total_checkout_value_in_micro_dollar
    total_app_install_value_in_micro_dollar
    total_checkout_quantity
    app_install_cost_per_action
    video_length
    inapp_app_install_cost_per_action
    inapp_app_install_roas
    total_inapp_app_install
    total_inapp_app_install_value_in_micro_dollar
    total_inapp_click_app_install
    total_inapp_click_app_install_value_in_micro_dollar
    total_inapp_engagement_app_install
    total_inapp_engagement_app_install_value_in_micro_dollar
    total_inapp_view_app_install
    total_inapp_view_app_install_value_in_micro_dollar
    idea_pin_product_tag_visit_1
    idea_pin_product_tag_visit_2

Ads Delivery Report (in Adgroups level):

  • Deprecated Fields:
    pin_promotion_ids
    entity_version
    optimization_goal_metadata.conversiontagv3goalmetadata

  • Added Fields:
    targeting_spec.AUDIENCE_EXCLUDE
    targeting_spec.AUDIENCE_INCLUDE
    targeting_spec.GEO
    targeting_spec.TARGETING_STRATEGY
    dca_assets
    optimization_goal_metadata.conversion_tag_v3_goal_metadata
    optimization_goal_metadata.frequency_goal_metadata
    optimization_goal_metadata.scrollup_goal_metadata
    feed_profile_id
    advertiser_id
    summary_status

Advertisers Report

  • Deprecated Fields:
    source_integration_platform_type
    actions
    has_valid_billing_profile
    is_agency
    is_agency_paying
    is_one_tap
    test_account
    vat_exempt_number
    vat_number

  • Added Fields:
    billing_profile_status

Batch Advertiser Report

  • Entity End Level Renaming:
    Keyword → Targeting Attribute
    Pin Promotion → Ad