v5.14.0

What's Changed

• v5.14.0 release by @suihanki in #20
• New tags advanced_auction, audience_sharing
• Removed deprecated product_groups tag/endpoints
• "Get ad analytics" now supports a list of Pin ids for filtering
• Numerous documentation/link updates to support our new docs UI on https://developers.pinterest.com/docs
• New endpoints
  • List received audiences for a business
  • List accounts with access to an audience owned by an ad account
  • Update audience sharing between ad accounts
  • Update audience sharing from an ad account to businesses
  • List accounts with access to an audience owned by a business
  • Update audience sharing from a business to ad accounts
  • Update audience sharing between businesses
  • Create a new asset group
  • Update asset groups
  • Create lead forms
  • Update lead forms
  • Create a request to export leads collected from a lead ad
  • Get the lead export from the lead export create call
  • Get item bid options (POST)
  • Operate on item level bid options
  • Create catalog

Full Changelog: v5.13.0...v5.14.0

v5.13.0

New Endpoints

General Overview:
Multiple endpoints across categories such as ad accounts, businesses, catalogs, and integrations were added.

Ad Accounts:
POST:
/ad_accounts/{ad_account_id}/ad_groups/audience_sizing
/ad_accounts/{ad_account_id}/ads_credit/redeem
/ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}/test
/ad_accounts/{ad_account_id}/leads/subscriptions
/ad_accounts/{ad_account_id}/mmm_reports
/ad_accounts/{ad_account_id}/ssio/insertion_orders
GET:
/ad_accounts/{ad_account_id}/ads_credit/discounts
/ad_accounts/{ad_account_id}/billing_profiles
/ad_accounts/{ad_account_id}/leads/subscriptions
/ad_accounts/{ad_account_id}/mmm_reports
/ad_accounts/{ad_account_id}/ssio/accounts
/ad_accounts/{ad_account_id}/ssio/insertion_orders/status
/ad_accounts/{ad_account_id}/ssio/insertion_orders/{pin_order_id}/status
/ad_accounts/{ad_account_id}/ssio/order_lines
/ad_accounts/{ad_account_id}/targeting_templates
PATCH:
/ad_accounts/{ad_account_id}/ssio/insertion_orders
/ad_accounts/{ad_account_id}/targeting_templates
DELETE:
/ad_accounts/{ad_account_id}/leads/subscriptions/{subscription_id}

Businesses:
POST:
/businesses/{business_id}/invites/assets/access
/businesses/{business_id}/requests/assets/access
/businesses/{business_id}/invites
GET:
/businesses/{business_id}/assets/{asset_id}/members
/businesses/{business_id}/assets/{asset_id}/partners
/businesses/{business_id}/members
/businesses/{business_id}/assets
/businesses/{business_id}/members/{member_id}/assets
/businesses/{business_id}/invites
/businesses/{business_id}/partners/{partner_id}/assets
/businesses/{business_id}/partners
PATCH:
/businesses/invites
/businesses/{business_id}/members
/businesses/{business_id}/members/assets/access
/businesses/{business_id}/partners/assets
DELETE:
/businesses/{business_id}/members
/businesses/{business_id}/invites
/businesses/{business_id}/partners/assets
/businesses/{business_id}/partners
/businesses/{business_id}/members/assets/access

Catalogs:
POST:
/catalogs/feeds/{feed_id}/ingest
/catalogs/product_groups/multiple
/catalogs/reports
/catalogs/items
GET:
/catalogs
/catalogs/reports
/catalogs/reports/stats
DELETE:
/catalogs/product_groups/multiple

Integrations and Others:
POST:
/integrations/logs
GET:
/resources/lead_form_questions
/search/partner/pins
/pins/analytics

=====================

Deleted Endpoint

GET: /ad_accounts/{ad_account_id}/insights/audiences/{scope}/{type}/{category_id}

=====================

Whats changed:

ad_accounts:
GET: /ad_accounts/{ad_account_id}/ad_groups/analytics. Columns parameter refined.
GET: /ad_accounts/{ad_account_id}/ad_groups/targeting_analytics. Columns and targeting_types parameters refined.
POST: /ad_accounts/{ad_account_id}/ad_previews. Response schema slightly adjusted but remains backward compatible.
GET: /ad_accounts/{ad_account_id}/ads/analytics. Columns parameter refined.
GET: /ad_accounts/{ad_account_id}/ads/targeting_analytics. Columns and targeting_types parameters refined.
GET: /ad_accounts/{ad_account_id}/analytics. Columns parameter refined.
GET: /ad_accounts/{ad_account_id}/campaigns/analytics. Columns parameter refined.
GET: /ad_accounts/{ad_account_id}/campaigns/targeting_analytics. Columns and targeting_types parameters refined.
GET: /ad_accounts/{ad_account_id}/product_groups/analytics. Columns parameter refined.
GET: /ad_accounts/{ad_account_id}/targeting_analytics. Columns and targeting_types parameters refined.

boards:
GET: /boards. Privacy parameter updated.
GET: /boards/{board_id}/sections. Return type maintains schema compatibility with minor changes.
POST: /boards/{board_id}/sections. Request and return handling modified—schema compatibility broken and maintained respectively.
PATCH: /boards/{board_id}/sections/{section_id}. Schema changes broken compatibility in request and maintained in return.

catalogs:
GET: /catalogs/feeds added catalog_id parameter

search:

GET: /search/boards. Added page_size parameter to enhance pagination control.
GET: /search/pins. Return type specification updated to provide a stable integration interface with maintained compatibility, focusing on performance metrics.

v.5.12.0

New endpoints

• ad_accounts
  • Get advertiser Marketing Mix Modeling report - GET /ad_accounts/{ad_account_id}/mmm_reports
  • Create a request for a Marketing Mix Modeling report - POST /ad_accounts/{ad_account_id}/mmm_reports
• ads_groups
  • Get audience sizing - GET /ad_accounts/{ad_account_id}/ad_groups/audience_sizing
• catalogs
  • List item issues for a given processing result - GET /catalogs/processing_results/{processing_result_id}/item_issues
• lead_forms
  • Create lead form test data - POST /ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}/test
• integrations
  • Receives batched logs from integration applications - POST /integrations/logs
• resources
  • Get lead form questions - GET /resources/lead_form_questions
• search
  • GET /search/partner/pins
• user_account
  • List following interests - GET /users/{username}/interests/follow (previously under the interests tag)

Sandbox

• catalogs
  • GET List catalogs
  • GET Get catalogs items
  • POST Operate on item batch
  • GET Get catalogs item batch status`
  • GET List product groups
  • POST Create product group
  • GET Get product group
  • DELETE Delete product group
  • PATCH Update product group
  • GET Get product counts for a Product Group
  • GET List products for a Product Group
  • POST List filtered products
• keywords
  • GET List trending keywords

Params changes

• audiences
  • GET List audiences - Added order param
• bulk
  • GET Get the status of a bulk request - Added include_details param
• boards
  • GET List boards - Added privacy query param
  • GET List Pins on board - Added pin_metrics query param
• catalogs
  • GET Get catalogs items - Removed catalogs_id and catalogs_hotels query params and added catalogs_items_filters
  • GET List product groups - Add catalog_id query param
  • POST Create product group, PATCH Update product group - Add support to Request object for creating/updating a Hotel vertical product group
• pins
  • GET List Pins, GET Get Pin - Added pin_metrics query param
• search
  • GET Search user's boards - Added page_size query param
• user_account
  • GET Get user account analytics - Added content_type query param
  • GET List followers, GET List following, GET List following boards, GET Get user websites - Added page_size query param

Others

• Tags changes
  • We moved a number of endpoints from the ad_accounts tag to billing and lead_ads [NEW TAG]
  • We removed interests tag
• New fields and status codes added to the response for multiple endpoints
• General documentation improvements

v5.11.0

• Add support to Hotel vertical on Catalogs API:
  • Add new endpoint to list existing catalogs
  • Add support to Hotel vertical on feed endpoints (e.g., Create feed))
  • Add support to Hotel vertical on batch endpoints (eg., Operate on item batch)
  • Add support to multiple Hotel catalogs on existing endpoints (e.g, Create feed, Operate on item batch)
• Removed endpoint: Get category sub-interest (DEPRECATED):
  • /ad_accounts/{ad_account_id}/insights/audiences/{scope}/{type}/{category_id}
• New SSIO endpoints in BETA:
  • New Get Salesforce account details including bill-to information endpoint
  • New Create insertion order through SSIO endpoint
  • New Edit insertion order through SSIO endpoint
  • New Get insertion order status by pin order id endpoint
  • New Get insertion order status by ad account id endpoint
  • New Get Salesforce order lines by ad account id endpoint

v5.10.0

• New List trending keywords endpoint
• DEPRECATED Get catalog product groups endpoint
• Get Pin analytics endpoint
  • New metric types supported (USER_FOLLOW, TOTAL_COMMENTS, TOTAL_REACTIONS)
• Operate on item batch endpoint
  • New DELETE batch operation
• Create Pin endpoint
  • Support cover image as base64
• Support new creative type COLLECTION; deprecate SHOP_THE_PIN
• New params added to:
  • Create Pin endpoint
  • Update Pin endpoint
  • Get user account top pins analytics endpoint
  • Get user account top video pins analytics endpoint
• New fields added to the response for multiple endpoints.

v5.9.0

• New async report by template ID endpoints
  New “List templates” endpoint (https://developers.pinterest.com/docs/api/v5/#operation/templates/list)
  New “Create async request for an analytics report using a template” endpoint (https://developers.pinterest.com/docs/api/v5/#operation/analytics/create_template_report)
• New lead forms endpoint in BETA
  New “Get lead forms” endpoint (https://developers.pinterest.com/docs/api/v5/#tag/lead_forms)
• Updates/fixes/enhancements to organic endpoints
  Increased rate limits for organic
  Business Access support added (via ad_account_id param) on multiple endpoints
  Search updates (authorization scopes update, query params reviewed)
  List pins updates (new field: creative_type)
  User account updates (new fields: counts, business name, etc)
  Added code samples (including SDK examples) for multiple endpoints
• 90 day date range limits on sync ads reports endpoints
• Sandbox
  Added support for sync ads metrics endpoints
• Standard OAuth scopes support for conversion events endpoint (now all apps can use this endpoint with a standard OAuth token with the “ads:write” scope)

V5.8.0

• New "Create custom audience" endpoint (POST /ad_accounts/{ad_account_id}/audiences/custom)
• New "Get audience insights scope and type" endpoint (GET /ad_accounts/{ad_account_id}/insights/audiences)
• New "Get category sub-interest" endpoint (GET /ad_accounts/{ad_account_id}/insights/audiences/{scope}/{type}/{category_id})
• New "Get catalog product groups" endpoint (GET /ad_accounts/{ad_account_id}/product_groups/catalogs)
• New "Delete ads data for ad account in API Sandbox" endpoint (DELETE /ad_accounts/{ad_account_id}/sandbox)
• New "Search user's boards" endpoint (GET /search/boards)
• New "Search user's Pins" endpoint (GET /search/pins)
• New "List linked businesses" endpoint (GET /user_account/businesses)
• New "List followers" endpoint (GET /user_account/followers)
• New "List following" endpoint (GET /user_account/following)
• New "Follow user" endpoint (POST /user_account/following/{username})
• New "List following boards" endpoint (GET /user_account/following/boards)
• New "Verify website" endpoint (POST /user_account/websites)
• New "Get user verification code for website claiming" (GET /user_account/websites/verification)
• New "List Pins" endpoint (GET /pins)
• New "List following interests" endpoint (GET /users/{username}/interests/follow)

v5.6.0

New endpoints for developers to manage ads-related entities in bulk and fetch ads-related entities targeting analytics on behalf of advertisers.

v5.5.0

• New endpoints for developers to do targeting including audiences, customer lists and keywords on behalf of advertisers. Learn more in Targeting.

v5.4.1

We've added this endpoint to allow developers to list products that meet the criteria of a filter provided in the request. Because these filters may be complex, and could easily exceed the character limit for GET requests, it is implemented as a POST request that has been designed to be idempotent.