Pinterest Ads

App · 24 actions

Manage Pinterest advertising campaigns, ad groups, ads, conversion tags and performance reports.

Actions

ActionWhat it does
Create ad accountCreate an ad account.
Create ad groupsCreate one or more ad groups.
Create adsCreate one or more ads.
Create campaignsCreate one or more campaigns.
Create conversion tagCreate a conversion tag, also called a Pinterest tag, with the option to turn on enhanced match.
Get adGet one ad by its ID.
Get ad accountGet one ad account.
Get ad account analyticsGet performance analytics for an ad account over a date range.
Get ad analyticsGet performance analytics for ads in an ad account over a date range.
Get ad groupGet one ad group by its ID.
Get ad group analyticsGet performance analytics for ad groups in an ad account over a date range.
Get campaignGet one campaign by its ID.
Get campaign analyticsGet performance analytics for campaigns in an ad account over a date range.
Get conversion tagGet one conversion tag.
Get page visit conversion tagsList an ad account's page visit conversion tag events.
Get targeting analytics for an ad accountGet performance analytics for an ad account broken down by targeting type, over a date range.
List ad accountsList the ad accounts you have access to, optionally including ones shared with you.
List ad groupsList ad groups in an ad account, optionally only for some campaigns or ad groups.
List adsList ads in an ad account, optionally only for some campaigns, ad groups or ads.
List campaignsList the campaigns in an ad account, with optional filters.
List conversion tagsList an ad account's conversion tags.
Update ad groupsUpdate one or more ad groups.
Update adsUpdate one or more ads.
Update campaignsUpdate one or more campaigns.

Create ad account

Create an ad account. Each ad account has its own country, currency and time zone.

Inputs

Countrycountrytext
Country ID from ISO 3166-1 alpha-2.One of: AD (Andorra), AE (United Arab Emirates), AF (Afghanistan), AG (Antigua & Barbuda), AI (Anguilla), AL (Albania), AM (Armenia), AO (Angola), AQ (Antarctica), AR (Argentina), and 238 more.
Currencycurrencytext
Currency Codes from ISO 4217One of: UNK, USD, GBP, CAD, EUR, AUD, NZD, SEK, ILS, CHF, and 17 more.
Namenametext
Ad account name.
Owner user idowner_user_idtext
Advertiser's owning user ID.
Time zonetime_zonetext
The time zone of the ad account, in IANA format (e.g., "America/Los_Angeles"). Adding your local time zone lets you view your campaigns and ad reporting in your preferred time zone. Future reports will be available in both your local time zone and default UTC time zone. Historical data takes 1-2 months to backfill. Your billing and order lines will remain in UTC.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "country": "AD",
    "created_time": 1,
    "currency": "UNK",
    "id": "example",
    "name": "example",
    "owner": {
      "id": "example",
      "username": "example"
    },
    "permissions": [],
    "time_zone": "example",
    "updated_time": 1
  }
}

Create ad groups

Create one or more ad groups. All ads in an ad group share its budget, bid, run dates, targeting and placement.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Request bodyrequest_bodylistRequired
Request body.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "items": []
  }
}

Create ads

Create one or more ads. Each ad needs an ad group, a creative type and the Pin it promotes.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Request bodyrequest_bodylistRequired
Request body.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "items": []
  }
}

Create campaigns

Create one or more campaigns.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Request bodyrequest_bodylistRequired
Request body for batch campaign create.

Outputs

dataobject
Response model for batch campaign write operations.
Example output
{
  "data": {
    "items": []
  }
}

Create conversion tag

Create a conversion tag, also called a Pinterest tag, with the option to turn on enhanced match.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Aem db enabledaem_db_enabledtrue/false
Whether Automatic Enhanced Match birthdate is enabled. See Enhanced match for more information.Default: false.
Aem enabledaem_enabledtrue/false
Whether Automatic Enhanced Match email is enabled. See Enhanced match for more information.Default: false.
Aem external id enabledaem_external_id_enabledtrue/false
Whether Automatic Enhanced Match location is enabled. See Enhanced match for more information.Default: false.
Aem fnln enabledaem_fnln_enabledtrue/false
Whether Automatic Enhanced Match name is enabled. See Enhanced match for more information.Default: false.
Aem ge enabledaem_ge_enabledtrue/false
Whether Automatic Enhanced Match gender is enabled. See Enhanced match for more information.Default: false.
Aem loc enabledaem_loc_enabledtrue/false
Whether Automatic Enhanced Match location is enabled. See Enhanced match for more information.Default: false.
Aem ph enabledaem_ph_enabledtrue/false
Whether Automatic Enhanced Match phone is enabled. See Enhanced match for more information.Default: false.
Md frequencymd_frequencynumber
Metadata ingestion frequency.Default: 1.
NamenametextRequired
Conversion tag name.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "ad_account_id": "example",
    "code_snippet": "example",
    "configs": {
      "aem_db_enabled": false,
      "aem_enabled": false,
      "aem_external_id_enabled": false,
      "aem_fnln_enabled": false,
      "aem_ge_enabled": false,
      "aem_loc_enabled": false,
      "aem_ph_enabled": false,
      "md_frequency": 1.0,
      "no_code_capi_domains": []
    },
    "enhanced_match_status": "UNKNOWN",
    "id": "example",
    "last_fired_time_ms": 1.0,
    "name": "example",
    "status": "ACTIVE",
    "version": "example"
  }
}

Get ad

Get one ad by its ID. If its Pin was rejected, the result includes the reasons.

Inputs

Ad idad_idtextRequired
Ad id.
Ad accountad_account_idtextRequired
Ad account id.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "ad_account_id": "example",
    "ad_group_id": "example",
    "android_deep_link": "example",
    "campaign_id": "example",
    "carousel_android_deep_links": [],
    "carousel_destination_urls": [],
    "carousel_ios_deep_links": [],
    "carting_platform_type": 1,
    "carting_products": [],
    "click_tracking_url": "example",
    "collection_items_destination_url_template": "example",
    "collections_header_type": "SHOP_THIS_COLLECTION",
    "created_time": 1,
    "creative_type": "REGULAR",
    "customizable_cta_type": "GET_OFFER",
    "destination_url": "example",
    "disclosure_type": "NO_DISCLOSURE",
    "disclosure_url": "example",
    "grid_click_type": "CLOSEUP",
    "id": "example",
    "ios_deep_link": "example",
    "is_carting": false,
    "is_collage_accepted_terms": false,
    "is_collage_single_destination": false,
    "is_pin_deleted": false,
    "is_removable": false,
    "lead_form_id": "example",
    "name": "example",
    "pin_id": "example",
    "quiz_pin_data": {
      "questions": [],
      "results": [],
      "tie_breaker_custom_result": {
        "android_deep_link": "example",
        "destination_url": "example",
        "ios_deep_link": "example",
        "organic_pin_id": "example",
        "result_id": 1.0
      },
      "tie_breaker_type": "RANDOM"
    },
    "rejected_reasons": [],
    "rejection_labels": [],
    "review_status": "OTHER",
    "status": "ACTIVE",
    "summary_status": "APPROVED",
    "tracking_urls": {
      "audience_verification": [],
      "buyable_button": [],
      "click": [],
      "engagement": [],
      "impression": []
    },
    "type": "example",
    "updated_time": 1,
    "view_tracking_url": "example"
  }
}

Get ad account

Get one ad account.

Inputs

Ad accountad_account_idtextRequired
Ad account id.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "country": "AD",
    "created_time": 1,
    "currency": "UNK",
    "id": "example",
    "name": "example",
    "owner": {
      "id": "example",
      "username": "example"
    },
    "permissions": [],
    "time_zone": "example",
    "updated_time": 1
  }
}

Get ad account analytics

Get performance analytics for an ad account over a date range.

Inputs

Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
ColumnscolumnslistRequired
Columns.One or more of: SPEND_IN_MICRO_DOLLAR (Spend in micro dollar), PAID_IMPRESSION (Paid impression), SPEND_IN_DOLLAR (Spend in dollar), CPC_IN_MICRO_DOLLAR (Cpc in micro dollar), ECPC_IN_MICRO_DOLLAR (Ecpc in micro dollar), ECPC_IN_DOLLAR (Ecpc in dollar), CTR, ECTR, OUTBOUND_CTR_1 (Outbound ctr 1), CAMPAIGN_NAME (Campaign name), and 175 more.
GranularitygranularitytextRequired
Specifies the time interval at which analytics data is broken down. Determines how metrics are grouped within the requested date range. **Note:** The HOUR enum no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums are unchanged.One of: TOTAL, DAY, HOUR, WEEK, MONTH.
Click window daysclick_window_daysnumber
Click window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
Engagement window daysengagement_window_daysnumber
Engagement window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
View window daysview_window_daysnumber
View window days.One of: 0, 1, 7, 14, 30, 60. Default: 1.
Conversion report timeconversion_report_timetext
Conversion report time.One of: TIME_OF_AD_ACTION (Time of ad action), TIME_OF_CONVERSION (Time of conversion). Default: TIME_OF_AD_ACTION.
Reporting timezonereporting_timezonetext
Specify the timezone to be applied for the reporting.One of: PINTEREST_TIME_ZONE (Pinterest time zone), AD_ACCOUNT_TIME_ZONE (Ad account time zone).
Ad accountad_account_idtextRequired
Ad account id.

Outputs

datalist
Pinterest Ads response data.
Example output
{
  "data": []
}

Get ad analytics

Get performance analytics for ads in an ad account over a date range.

Inputs

Pin idspin_idslist
Pin ids.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Ad idsad_idslist
Ad ids.
ColumnscolumnslistRequired
Columns.One or more of: SPEND_IN_MICRO_DOLLAR (Spend in micro dollar), PAID_IMPRESSION (Paid impression), SPEND_IN_DOLLAR (Spend in dollar), CPC_IN_MICRO_DOLLAR (Cpc in micro dollar), ECPC_IN_MICRO_DOLLAR (Ecpc in micro dollar), ECPC_IN_DOLLAR (Ecpc in dollar), CTR, ECTR, OUTBOUND_CTR_1 (Outbound ctr 1), CAMPAIGN_NAME (Campaign name), and 175 more.
GranularitygranularitytextRequired
Specifies the time interval at which analytics data is broken down. Determines how metrics are grouped within the requested date range. **Note:** The HOUR enum no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums are unchanged.One of: TOTAL, DAY, HOUR, WEEK, MONTH.
Click window daysclick_window_daysnumber
Click window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
Engagement window daysengagement_window_daysnumber
Engagement window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
View window daysview_window_daysnumber
View window days.One of: 0, 1, 7, 14, 30, 60. Default: 1.
Conversion report timeconversion_report_timetext
Conversion report time.One of: TIME_OF_AD_ACTION (Time of ad action), TIME_OF_CONVERSION (Time of conversion). Default: TIME_OF_AD_ACTION.
Campaign idscampaign_idslist
Campaign ids.
Reporting timezonereporting_timezonetext
Specify the timezone to be applied for the reporting.One of: PINTEREST_TIME_ZONE (Pinterest time zone), AD_ACCOUNT_TIME_ZONE (Ad account time zone).
Ad accountad_account_idtextRequired
Ad account id.

Outputs

datalist
Pinterest Ads response data.
Example output
{
  "data": []
}

Get ad group

Get one ad group by its ID.

Inputs

Ad group idad_group_idtextRequired
Ad group id.
Ad accountad_account_idtextRequired
Ad account id.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "ad_account_id": "example",
    "auto_targeting_enabled": false,
    "bid_in_micro_currency": 1,
    "bid_multiplier": 1.0,
    "bid_strategy_type": "AUTOMATIC_BID",
    "billable_event": "CLICKTHROUGH",
    "budget_in_micro_currency": 1,
    "budget_type": "DAILY",
    "campaign_id": "example",
    "conversion_learning_mode_type": "NOT_ACTIVE",
    "created_time": 1,
    "customer_segment_id": "example",
    "dca_assets": {},
    "end_time": 1,
    "ext_features": {
      "enabled": []
    },
    "feed_profile_id": "example",
    "id": "example",
    "is_creative_optimization": false,
    "is_local_inventory": false,
    "lifetime_frequency_cap": 1,
    "local_inventory_radius_in_miles": 1.0,
    "name": "example",
    "optimization_goal_metadata": {
      "conversion_tag_v3_goal_metadata": {
        "attribution_windows": {
          "click_window_days": 1,
          "engagement_window_days": 1,
          "view_window_days": 1
        },
        "conversion_event": "PAGE_VISIT",
        "conversion_tag_id": "example",
        "cpa_goal_value_in_micro_currency": "example",
        "is_roas_optimized": false,
        "reporting_event": "example"
      },
      "frequency_goal_metadata": {
        "frequency": 1,
        "timerange": "THIRTY_DAY"
      },
      "scrollup_goal_metadata": {
        "scrollup_goal_value_in_micro_currency": "example"
      }
    },
    "pacing_delivery_type": "STANDARD",
    "performance_plus_campaign_settings": {
      "boost_prospecting_ad_group_bid": false,
      "pinner_list_exclusions": []
    },
    "placement_group": "ALL",
    "placement_traffic_type": "ALL",
    "promotion_application_level": "NONE",
    "promotion_id": "example",
    "promotion_ids": [],
    "start_time": 1,
    "status": "ACTIVE",
    "summary_status": "RUNNING",
    "targeting_spec": {
      "AGE_BUCKET": [],
      "APPTYPE": [],
      "AUDIENCE_EXCLUDE": [],
      "AUDIENCE_INCLUDE": [],
      "GENDER": [],
      "GEO": [],
      "GEO_EXCLUDE": [],
      "INTEREST": [],
      "LOCALE": [],
      "LOCATION": [],
      "LOCATION_EXCLUDE": [],
      "MAXIMUM_AGE": "example",
      "MINIMUM_AGE": "example",
      "SHOPPING_RETARGETING": [],
      "TARGETING_STRATEGY": []
    },
    "targeting_template_ids": [],
    "tracking_urls": {
      "audience_verification": [],
      "buyable_button": [],
      "click": [],
      "engagement": [],
      "impression": []
    },
    "type": "example",
    "updated_time": 1
  }
}

Get ad group analytics

Get performance analytics for ad groups in an ad account over a date range.

Inputs

Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Ad group idsad_group_idslistRequired
Ad group ids.
ColumnscolumnslistRequired
Columns.One or more of: SPEND_IN_MICRO_DOLLAR (Spend in micro dollar), PAID_IMPRESSION (Paid impression), SPEND_IN_DOLLAR (Spend in dollar), CPC_IN_MICRO_DOLLAR (Cpc in micro dollar), ECPC_IN_MICRO_DOLLAR (Ecpc in micro dollar), ECPC_IN_DOLLAR (Ecpc in dollar), CTR, ECTR, OUTBOUND_CTR_1 (Outbound ctr 1), CAMPAIGN_NAME (Campaign name), and 175 more.
GranularitygranularitytextRequired
Specifies the time interval at which analytics data is broken down. Determines how metrics are grouped within the requested date range. **Note:** The HOUR enum no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums are unchanged.One of: TOTAL, DAY, HOUR, WEEK, MONTH.
Click window daysclick_window_daysnumber
Click window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
Engagement window daysengagement_window_daysnumber
Engagement window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
View window daysview_window_daysnumber
View window days.One of: 0, 1, 7, 14, 30, 60. Default: 1.
Conversion report timeconversion_report_timetext
Conversion report time.One of: TIME_OF_AD_ACTION (Time of ad action), TIME_OF_CONVERSION (Time of conversion). Default: TIME_OF_AD_ACTION.
Aggregate report rowsaggregate_report_rowstrue/false
Aggregate report rows.Default: false.
Reporting timezonereporting_timezonetext
Specify the timezone to be applied for the reporting.One of: PINTEREST_TIME_ZONE (Pinterest time zone), AD_ACCOUNT_TIME_ZONE (Ad account time zone).
Ad accountad_account_idtextRequired
Ad account id.

Outputs

datalist
Pinterest Ads response data.
Example output
{
  "data": []
}

Get campaign

Get one campaign by its ID.

Inputs

Campaign idcampaign_idtextRequired
Campaign id.
Ad accountad_account_idtextRequired
Ad account id.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "ad_account_id": "example",
    "bid_options": {
      "age_bucket_multipliers": {
        "AGE_BUCKET": "18-24"
      },
      "app_type_multipliers": {
        "APP_TYPE": "android_mobile"
      },
      "audience_multipliers": {
        "AUDIENCE_ID": "example"
      },
      "freq_bid_multiplier_time_window": "WEEK",
      "frequency_multipliers": {
        "IMPRESSION_COUNT": "example"
      },
      "gender_multipliers": {
        "GENDER": "unknown"
      },
      "placement_multipliers": {
        "PLACEMENT": "SEARCH"
      }
    },
    "created_time": 1,
    "daily_spend_cap": 1,
    "default_ad_group_budget_in_micro_currency": 1,
    "end_time": 1,
    "id": "example",
    "intended_promotion_type": "LEGACY",
    "is_automated_campaign": false,
    "is_campaign_budget_optimization": false,
    "is_carting": false,
    "is_flexible_daily_budgets": false,
    "is_ltv_optimized": false,
    "is_performance_plus": false,
    "is_top_of_search": false,
    "lifetime_spend_cap": 1,
    "name": "example",
    "objective_type": "AWARENESS",
    "order_line_id": "example",
    "performance_plus_campaign_settings": {
      "boost_prospecting_ad_group_bid": false,
      "pinner_list_exclusions": []
    },
    "start_time": 1,
    "status": "ACTIVE",
    "summary_status": "RUNNING",
    "tracking_urls": {
      "audience_verification": [],
      "buyable_button": [],
      "click": [],
      "engagement": [],
      "impression": []
    },
    "type": "example",
    "updated_time": 1
  }
}

Get campaign analytics

Get performance analytics for campaigns in an ad account over a date range.

Inputs

Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Campaign idscampaign_idslistRequired
Campaign ids.
ColumnscolumnslistRequired
Columns.One or more of: SPEND_IN_MICRO_DOLLAR (Spend in micro dollar), PAID_IMPRESSION (Paid impression), SPEND_IN_DOLLAR (Spend in dollar), CPC_IN_MICRO_DOLLAR (Cpc in micro dollar), ECPC_IN_MICRO_DOLLAR (Ecpc in micro dollar), ECPC_IN_DOLLAR (Ecpc in dollar), CTR, ECTR, OUTBOUND_CTR_1 (Outbound ctr 1), CAMPAIGN_NAME (Campaign name), and 175 more.
GranularitygranularitytextRequired
Specifies the time interval at which analytics data is broken down. Determines how metrics are grouped within the requested date range. **Note:** The HOUR enum no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums are unchanged.One of: TOTAL, DAY, HOUR, WEEK, MONTH.
Click window daysclick_window_daysnumber
Click window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
Engagement window daysengagement_window_daysnumber
Engagement window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
View window daysview_window_daysnumber
View window days.One of: 0, 1, 7, 14, 30, 60. Default: 1.
Conversion report timeconversion_report_timetext
Conversion report time.One of: TIME_OF_AD_ACTION (Time of ad action), TIME_OF_CONVERSION (Time of conversion). Default: TIME_OF_AD_ACTION.
Aggregate report rowsaggregate_report_rowstrue/false
Aggregate report rows.Default: false.
Reporting timezonereporting_timezonetext
Specify the timezone to be applied for the reporting.One of: PINTEREST_TIME_ZONE (Pinterest time zone), AD_ACCOUNT_TIME_ZONE (Ad account time zone).
Ad accountad_account_idtextRequired
Ad account id.

Outputs

datalist
Pinterest Ads response data.
Example output
{
  "data": []
}

Get conversion tag

Get one conversion tag.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Conversion tag idconversion_tag_idtextRequired
Conversion tag id.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "ad_account_id": "example",
    "code_snippet": "example",
    "configs": {
      "aem_db_enabled": false,
      "aem_enabled": false,
      "aem_external_id_enabled": false,
      "aem_fnln_enabled": false,
      "aem_ge_enabled": false,
      "aem_loc_enabled": false,
      "aem_ph_enabled": false,
      "md_frequency": 1.0,
      "no_code_capi_domains": []
    },
    "enhanced_match_status": "UNKNOWN",
    "id": "example",
    "last_fired_time_ms": 1.0,
    "name": "example",
    "status": "ACTIVE",
    "version": "example"
  }
}

Get page visit conversion tags

List an ad account's page visit conversion tag events.

Inputs

Bookmarkbookmarktext
Bookmark.
Page sizepage_sizenumber
Page size.From 1 to 250. Default: 25.
Orderordertext
Order.One of: ASCENDING, DESCENDING. Default: ASCENDING.
Ad accountad_account_idtextRequired
Ad account id.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "bookmark": "example",
    "items": []
  }
}

Get targeting analytics for an ad account

Get performance analytics for an ad account broken down by targeting type, over a date range.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Targeting typestargeting_typeslistRequired
Targeting types.One or more of: KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST (Targeted interest), PINNER_INTEREST (Pinner interest), AUDIENCE_INCLUDE (Audience include), GEO, and 3 more.
ColumnscolumnslistRequired
Columns.One or more of: SPEND_IN_MICRO_DOLLAR (Spend in micro dollar), PAID_IMPRESSION (Paid impression), SPEND_IN_DOLLAR (Spend in dollar), CPC_IN_MICRO_DOLLAR (Cpc in micro dollar), ECPC_IN_MICRO_DOLLAR (Ecpc in micro dollar), ECPC_IN_DOLLAR (Ecpc in dollar), CTR, ECTR, OUTBOUND_CTR_1 (Outbound ctr 1), CAMPAIGN_NAME (Campaign name), and 175 more.
GranularitygranularitytextRequired
Specifies the time interval at which analytics data is broken down. Determines how metrics are grouped within the requested date range. **Note:** The HOUR enum no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums are unchanged.One of: TOTAL, DAY, HOUR, WEEK, MONTH.
Click window daysclick_window_daysnumber
Click window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
Engagement window daysengagement_window_daysnumber
Engagement window days.One of: 0, 1, 7, 14, 30, 60. Default: 30.
View window daysview_window_daysnumber
View window days.One of: 0, 1, 7, 14, 30, 60. Default: 1.
Conversion report timeconversion_report_timetext
Conversion report time.One of: TIME_OF_AD_ACTION (Time of ad action), TIME_OF_CONVERSION (Time of conversion). Default: TIME_OF_AD_ACTION.
Attribution typesattribution_typeslist
Attribution types.One or more of: INDIVIDUAL, HOUSEHOLD.
Reporting timezonereporting_timezonetext
Specify the timezone to be applied for the reporting.One of: PINTEREST_TIME_ZONE (Pinterest time zone), AD_ACCOUNT_TIME_ZONE (Ad account time zone).

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "data": []
  }
}

List ad accounts

List the ad accounts you have access to, optionally including ones shared with you.

Inputs

Include shared accountsinclude_shared_accountstrue/false
Include shared accounts.Default: true.
Bookmarkbookmarktext
Bookmark.
Page sizepage_sizenumber
Page size.From 1 to 250. Default: 25.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "bookmark": "example",
    "items": []
  }
}

List ad groups

List ad groups in an ad account, optionally only for some campaigns or ad groups.

Inputs

Bookmarkbookmarktext
Bookmark.
Page sizepage_sizenumber
Page size.From 1 to 250. Default: 25.
Orderordertext
Order.One of: ASCENDING, DESCENDING. Default: ASCENDING.
Ad accountad_account_idtextRequired
Ad account id.
Campaign idscampaign_idslist
Campaign ids.
Ad group idsad_group_idslist
Ad group ids.
Entity statusesentity_statuseslist
Entity statuses.One or more of: ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT (Deleted draft). Default: ["ACTIVE", "PAUSED"].
Translate interests to namestranslate_interests_to_namestrue/false
Translate interests to names.Default: false.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "bookmark": "example",
    "items": []
  }
}

List ads

List ads in an ad account, optionally only for some campaigns, ad groups or ads.

Inputs

Bookmarkbookmarktext
Bookmark.
Page sizepage_sizenumber
Page size.From 1 to 250. Default: 25.
Orderordertext
Order.One of: ASCENDING, DESCENDING. Default: ASCENDING.
Ad accountad_account_idtextRequired
Ad account id.
Campaign idscampaign_idslist
Campaign ids.
Ad group idsad_group_idslist
Ad group ids.
Ad idsad_idslist
Ad ids.
Entity statusesentity_statuseslist
Entity statuses.One or more of: ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT (Deleted draft). Default: ["ACTIVE", "PAUSED"].

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "bookmark": "example",
    "items": []
  }
}

List campaigns

List the campaigns in an ad account, with optional filters.

Inputs

Bookmarkbookmarktext
Bookmark.
Page sizepage_sizenumber
Page size.From 1 to 250. Default: 25.
Orderordertext
Order.One of: ASCENDING, DESCENDING. Default: ASCENDING.
Ad accountad_account_idtextRequired
Ad account id.
Campaign idscampaign_idslist
Campaign ids.
Entity statusesentity_statuseslist
Entity statuses.One or more of: ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT (Deleted draft). Default: ["ACTIVE", "PAUSED"].

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "bookmark": "example",
    "items": []
  }
}

List conversion tags

List an ad account's conversion tags.

Inputs

Filter deletedfilter_deletedtrue/false
Filter deleted.Default: false.
Ad accountad_account_idtextRequired
Ad account id.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "items": []
  }
}

Update ad groups

Update one or more ad groups.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Request bodyrequest_bodylistRequired
Request body.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "items": []
  }
}

Update ads

Update one or more ads.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Request bodyrequest_bodylistRequired
Request body.

Outputs

dataobject
Pinterest Ads response data.
Example output
{
  "data": {
    "items": []
  }
}

Update campaigns

Update one or more campaigns.

Inputs

Ad accountad_account_idtextRequired
Ad account id.
Request bodyrequest_bodylistRequired
Request body for batch campaign update.

Outputs

dataobject
Response model for batch campaign write operations.
Example output
{
  "data": {
    "items": []
  }
}

On this page