Skip to content

v5.28.0

Latest
Latest

Choose a tag to compare

View all tags
@sbarahonapin sbarahonapin released this 15 Jul 21:01
· 3 commits to main since this release
v5.28.0
2503147
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.23.0 → 5.28.0)

Client-Impacting Breaking Changes Only

Ad Accounts

POST /ad_accounts/{ad_account_id}/reports

  • ⚠️ added the new required request property end_date
  • ⚠️ added the new required request property granularity
  • ⚠️ added the new required request property start_date

POST /ad_accounts/{ad_account_id}/mmm_reports

  • ⚠️ removed the enum value AD_GROUP_TARGETING of the request property level
  • ⚠️ removed the enum value CAMPAIGN_TARGETING of the request property level
  • ⚠️ removed the enum value DAY of the request property granularity
  • ⚠️ removed the enum value WEEK of the request property granularity
  • ⚠️ removed the optional property code from the response with the 200 status
  • ⚠️ removed the optional property data from the response with the 200 status

GET /ad_accounts/{ad_account_id}/mmm_reports

  • ⚠️ removed the optional property code from the response with the 200 status
  • ⚠️ removed the optional property data from the response with the 200 status

POST /ad_accounts/{ad_account_id}/reports/brand_category_sku

  • ⚠️ removed the enum value ADVERTISER of the request property level
  • ⚠️ removed the enum value AD_GROUP of the request property level
  • ⚠️ removed the enum value CAMPAIGN of the request property level
  • ⚠️ removed the enum value MONTH of the request property granularity
  • ⚠️ removed the enum value TOTAL of the request property granularity
  • ⚠️ removed the enum value WEEK of the request property granularity
  • ⚠️ removed the enum value BRAND_ATTRIBUTION of the request property conversion_product_attribution_type
  • ⚠️ removed the enum value DEFAULT of the request property conversion_product_attribution_type
  • ⚠️ the report_status response's property type/format changed from string/to/`` for status 200

GET /ad_accounts/{ad_account_id}/templates

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Ad Groups

POST /ad_accounts/{ad_account_id}/ad_groups

  • ⚠️ added the new required request property /items/billable_event
  • ⚠️ added the new required request property /items/campaign_id
  • ⚠️ added the new required request property /items/name

PATCH /ad_accounts/{ad_account_id}/ad_groups

  • ⚠️ added the new required request property /items/id

GET /ad_accounts/{ad_account_id}/ad_groups

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

POST /ad_accounts/{ad_account_id}/bid_floor

  • ⚠️ removed the enum value CLICKTHROUGH of the request property bid_floor_specs/items/billable_event
  • ⚠️ removed the enum value IMPRESSION of the request property bid_floor_specs/items/billable_event
  • ⚠️ removed the enum value VIDEO_V_50_MRC of the request property bid_floor_specs/items/billable_event
  • ⚠️ removed the enum value AWARENESS of the request property bid_floor_specs/items/objective_type
  • ⚠️ removed the enum value CATALOG_SALES of the request property bid_floor_specs/items/objective_type
  • ⚠️ removed the enum value CONSIDERATION of the request property bid_floor_specs/items/objective_type
  • ⚠️ removed the enum value VIDEO_COMPLETION of the request property bid_floor_specs/items/objective_type
  • ⚠️ removed the enum value WEB_CONVERSION of the request property bid_floor_specs/items/objective_type
  • ⚠️ removed the enum value CAROUSEL of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value COLLAGE of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value COLLECTION of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value IDEA of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value MAX_VIDEO of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value QUIZ of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value REGULAR of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value SHOPPING of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value SHOP_THE_PIN of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value SHOWCASE of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed the enum value VIDEO of the request property bid_floor_specs/items/creative_type
  • ⚠️ removed all individual currency enum values (USD, EUR, GBP, etc.) of the request property bid_floor_specs/items/currency
  • ⚠️ removed the request property targeting_spec/AGE_BUCKET
  • ⚠️ removed the request property targeting_spec/APPTYPE
  • ⚠️ removed the request property targeting_spec/AUDIENCE_EXCLUDE
  • ⚠️ removed the request property targeting_spec/AUDIENCE_INCLUDE
  • ⚠️ removed the request property targeting_spec/GENDER
  • ⚠️ removed the request property targeting_spec/GEO
  • ⚠️ removed the request property targeting_spec/INTEREST
  • ⚠️ removed the request property targeting_spec/LOCALE
  • ⚠️ removed the request property targeting_spec/LOCATION
  • ⚠️ removed the request property targeting_spec/MAXIMUM_AGE
  • ⚠️ removed the request property targeting_spec/MINIMUM_AGE
  • ⚠️ removed the request property targeting_spec/SHOPPING_RETARGETING
  • ⚠️ removed the request property targeting_spec/TARGETING_STRATEGY

Ads

POST /ad_accounts/{ad_account_id}/ads

  • ⚠️ added the new required request property /items/ad_group_id
  • ⚠️ added the new required request property /items/creative_type
  • ⚠️ added the new required request property /items/pin_id

PATCH /ad_accounts/{ad_account_id}/ads

  • ⚠️ added the new required request property /items/id

GET /ad_accounts/{ad_account_id}/ads

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Advanced Auction

POST /advanced_auction/items/get

  • ⚠️ added the new required request property items/items/country
  • ⚠️ added the new required request property items/items/item_id
  • ⚠️ added the new required request property items/items/language
  • ⚠️ the catalog_id request property type/format changed from string/to/``
  • ⚠️ the items/items/ request property type/format changed from / to object/``
  • ⚠️ the catalog_id response's property type/format changed from string/to/`` for status 200
  • ⚠️ the items/items/ response's property type/format changed from / to object/`` for status 200

POST /advanced_auction/items/submit

  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitDeleteRecord]/country
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitDeleteRecord]/item_id
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitDeleteRecord]/language
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitDeleteRecord]/operation
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitUpsertRecord]/bid_options
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitUpsertRecord]/country
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitUpsertRecord]/item_id
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitUpsertRecord]/language
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitUpsertRecord]/operation
  • ⚠️ added the new required request property items/items/oneOf[.../AdvancedAuctionItemsSubmitUpsertRecord]/update_mask
  • ⚠️ the catalog_id request property type/format changed from string/to/``
  • ⚠️ the delete/upsert record items request property type/format changed from / to object/``
  • ⚠️ removed the required property items/items/operation from the response with the 200 status
  • ⚠️ removed the required property items/items/operation from the response with the 206 status
  • ⚠️ the catalog_id response's property type/format changed from string/to/`` for status 200
  • ⚠️ the catalog_id response's property type/format changed from string/to/`` for status 206
  • ⚠️ the delete/upsert record items response's property type/format changed from / to object/`` for status 200 and 206

Audience Sharing

PATCH /ad_accounts/{ad_account_id}/audiences/ad_accounts/shared
PATCH /businesses/{business_id}/audiences/ad_accounts/shared

  • ⚠️ added the new required request property audience_id
  • ⚠️ added the new required request property operation_type
  • ⚠️ added the new required request property recipient_account_ids

PATCH /ad_accounts/{ad_account_id}/audiences/businesses/shared
PATCH /businesses/{business_id}/audiences/businesses/shared

  • ⚠️ added the new required request property audience_id
  • ⚠️ added the new required request property operation_type
  • ⚠️ added the new required request property recipient_business_ids

GET /ad_accounts/{ad_account_id}/audiences/shared/accounts
GET /businesses/{business_id}/audiences/shared/accounts

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /businesses/{business_id}/audiences

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Audiences

GET /ad_accounts/{ad_account_id}/audiences

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Billing

GET /ad_accounts/{ad_account_id}/ads_credit/discounts
GET /ad_accounts/{ad_account_id}/billing_profiles

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /ad_accounts/{ad_account_id}/billing_invoices

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /ad_accounts/{ad_account_id}/ssio/insertion_orders/status
GET /ad_accounts/{ad_account_id}/ssio/order_lines

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Boards

GET /boards/{board_id}/pins

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /boards/{board_id}/sections

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /boards/{board_id}/sections/{section_id}/pins

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Bulk

POST /ad_accounts/{ad_account_id}/bulk/upsert

  • ⚠️ added the new required request property update/campaigns/items/allOf[subschema #3 -> subschema #1]/bid_options/update_mask
  • ⚠️ added the new required request property update/labels/items/parent_id
  • ⚠️ the request property update/labels/items/status became required
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/bid_in_micro_currency became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/catalog_product_group_id became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/catalog_product_group_name became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/customizable_cta_type became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/definition became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/included became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/is_mdl became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/parent_id became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/relative_definition became not nullable
  • ⚠️ the request property create/product_groups/items/product_group_promotion/items/tracking_url became not nullable
  • ⚠️ the request property create/labels/items/labels/items/label_type became not nullable
  • ⚠️ removed the request property update/labels/items/value

Business Access Assets

GET /businesses/{business_id}/assets
GET /businesses/{business_id}/assets/{asset_id}/members
GET /businesses/{business_id}/assets/{asset_id}/partners

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /businesses/{business_id}/members/{member_id}/assets

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /businesses/{business_id}/partners/{partner_id}/assets

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Business Access Invite

PATCH /businesses/invites

  • ⚠️ the items/items/invite response's property type/format changed from object/to/`` for status 200
  • ⚠️ removed the optional property items/items/invite/id from the response with the 200 status
  • ⚠️ removed the optional property items/items/invite/invite_data from the response with the 200 status
  • ⚠️ removed the optional property items/items/invite/is_received_invite from the response with the 200 status
  • ⚠️ removed the optional property items/items/invite/user from the response with the 200 status

GET /businesses/{business_id}/invites

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

POST /businesses/{business_id}/invites

  • ⚠️ removed the enum value BIZ_ADMIN of the request property business_role
  • ⚠️ removed the enum value EMPLOYEE of the request property business_role
  • ⚠️ removed the enum value PARTNER of the request property business_role
  • ⚠️ the business_role request property type/format changed from string/to/``

Business Access Relationships

GET /businesses/employers

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /businesses/{business_id}/members

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

GET /businesses/{business_id}/partners

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Campaigns

POST /ad_accounts/{ad_account_id}/campaigns

  • ⚠️ added the new required request property /items/name
  • ⚠️ added the new required request property /items/objective_type
  • ⚠️ the items/items/data response's property type/format changed from object/to/`` for status 200

PATCH /ad_accounts/{ad_account_id}/campaigns

  • ⚠️ added the new required request property /items/id

GET /ad_accounts/{ad_account_id}/campaigns

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

Catalog Feeds

GET /catalogs/feeds

  • ⚠️ the response's body type/format changed from / to object/`` for status 200

POST /catalogs/feeds

  • ⚠️ the request property preferred_processing_schedule/timezone became not nullable (all feed type variants)
  • ⚠️ all IANA timezone enum values were removed from preferred_processing_schedule/timezone (all feed type variants); replaced with #/components/schemas/CatalogsFeedProcessingScheduleTimezone allOf reference

Excluded From This Summary (Non-Breaking)

  • Newly documented 401/403/404/429 error responses
  • New optional request or response fields
  • New enum values added to existing fields
  • Fields becoming read-only
  • Schema component reshuffling without functional impact
  • Pattern relaxations (e.g., removed ^\d+$ constraints)
  • Default value removals on optional parameters
Assets 2
Loading