Skip to content

v5.20.0

Choose a tag to compare

View all tags
@sbarahonapin sbarahonapin released this 11 Dec 21:01
· 9 commits to main since this release
v5.20.0
1b47c64
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

API Changelog (5.18.0 → 5.20.0)

Ads & Ad Groups

GET /ad_accounts/{ad_account_id}/ads
PATCH /ad_accounts/{ad_account_id}/ads
POST /ad_accounts/{ad_account_id}/ads
GET /ad_accounts/{ad_account_id}/ads/{ad_id}

  • ⚠️ Added new creative_type enum values: 'COLLAGE', 'MAX_WIDTH_REGULAR_COLLECTION', 'MAX_WIDTH_VIDEO_COLLECTION'.

GET /ad_accounts/{ad_account_id}/ad_groups/targeting_analytics
GET /ad_accounts/{ad_account_id}/ads/targeting_analytics

  • ⚠️ Removed 'HOUSEHOLD' and 'INDIVIDUAL' enum values from attribution_types.
  • ⚠️ Changed attribution_types type from 'string' to 'array'.

POST /ad_accounts/{ad_account_id}/ad_previews

  • ⚠️ customizable_cta_type for AdPreviewShopping now non-nullable with schema changes.
  • ⚠️ Removed enum values: 'BOOK_NOW', 'GET_DEAL', 'ON_SALE', 'SHOP_NOW', 'undefined'.
  • Added 'REGULAR' enum value to creative_type.

GET /ad_accounts/{ad_account_id}/advertiser_defined_events

  • Endpoint added.

Audiences

POST /ad_accounts/{ad_account_id}/audiences/custom

  • ⚠️ API path removed without deprecation.

Bid Floor

POST /ad_accounts/{ad_account_id}/bid_floor

  • Added new creative_type enum values: 'COLLAGE', 'MAX_WIDTH_REGULAR_COLLECTION', 'MAX_WIDTH_VIDEO_COLLECTION'.

Bulk Operations

POST /ad_accounts/{ad_account_id}/bulk/download

  • Added 'SCHEDULE' enum value to entity_types.

POST /ad_accounts/{ad_account_id}/bulk/upsert

  • ⚠️ Changed pattern for create/labels/items/parent_id from '^\d+$' to '^[C]?\d+$'.
  • Added optional properties: create/catalog_product_groups, update/catalog_product_groups.
  • Multiple properties became nullable: create/labels/items/labels/items/label_type, update/labels/items/status.
  • Added 'BUY_ONLINE_PICKUP_IN_STORE' enum value to customizable_cta_type.
  • Added new creative_type enum values across ads, campaigns, and product groups: 'COLLAGE', 'MAX_WIDTH_REGULAR_COLLECTION', 'MAX_WIDTH_VIDEO_COLLECTION'.

Campaigns

GET /ad_accounts/{ad_account_id}/campaigns
GET /ad_accounts/{ad_account_id}/campaigns/analytics
POST /ad_accounts/{ad_account_id}/campaigns
PATCH /ad_accounts/{ad_account_id}/campaigns
GET /ad_accounts/{ad_account_id}/campaigns/{campaign_id}

  • Added new objective_type enum values: 'AD_RECALL_LIFT', 'BRAND_AWARENESS', 'VIDEO_VIEWS_10S', 'VIDEO_VIEWS_15S'.

Catalogs & Products

POST /catalogs/items
POST /catalogs/items/batch
GET /catalogs/product_groups/{product_group_id}/products
POST /catalogs/products/get_by_product_group_filters

  • ⚠️ Response properties removed: note.
  • ⚠️ Added new creative_type enum values: 'COLLAGE', 'MAX_WIDTH_REGULAR_COLLECTION', 'MAX_WIDTH_VIDEO_COLLECTION'.
  • Added BoardOwner schema to board_owner property.

GET /catalogs/product_groups
POST /catalogs/product_groups
PATCH /catalogs/product_groups
GET /catalogs/product_groups/{product_group_id}
DELETE /catalogs/product_groups/{product_group_id}

  • Added 'BUY_ONLINE_PICKUP_IN_STORE' enum value to customizable_cta_type.

Keywords

GET /ad_accounts/{ad_account_id}/keywords
PATCH /ad_accounts/{ad_account_id}/keywords
POST /ad_accounts/{ad_account_id}/keywords
GET /ad_accounts/{ad_account_id}/keywords/metrics

  • ⚠️ Removed 'UNSPECIFIED' enum value from match_type parameter.
  • Added 'TARGETING_INTERESTS' enum value to match_type.

Pins

POST /pins
GET /pins/{pin_id}
PATCH /pins/{pin_id}
POST /pins/{pin_id}/save

  • ⚠️ Removed 'note' property from requests and responses.
  • ⚠️ Added new creative_type enum values: 'COLLAGE', 'MAX_WIDTH_REGULAR_COLLECTION', 'MAX_WIDTH_VIDEO_COLLECTION'.
  • Added BoardOwner schema to board_owner property.

Boards

GET /boards/{board_id}/pins
GET /boards/{board_id}/sections/{section_id}/pins
GET /search/boards
GET /user_account/following/boards

  • ⚠️ Response schema refactored: removed individual properties (name, board_pins_modified_at, collaborator_count, created_at, description, follower_count, id, is_ads_only, media, owner, pin_count) in favor of BoardBase schema.
  • ⚠️ privacy property type changed, now uses BoardPrivacy schema instead of enum strings.
  • Removed enum values: 'PROTECTED', 'PUBLIC', 'SECRET' from privacy (consolidated into schema).

Search

GET /search/pins

  • ⚠️ Removed 'note' property from response.
  • ⚠️ Added new creative_type enum values: 'COLLAGE', 'MAX_WIDTH_REGULAR_COLLECTION', 'MAX_WIDTH_VIDEO_COLLECTION'.
  • Added BoardOwner schema to board_owner property.

Trends

GET /trends/keywords/{region}/top/{trend_type}

  • Added optional property: trends/items/predicted_time_series.

Note:
The creative_type enum expansion ('COLLAGE', 'MAX_WIDTH_REGULAR_COLLECTION', 'MAX_WIDTH_VIDEO_COLLECTION') affects numerous endpoints across ads, pins, catalogs, and search functionality.

Assets 2
Loading