Skip to content

Releases: facebook/facebook-php-business-sdk

Marketing API 2.10 Release

18 Jul 21:46
Compare
Choose a tag to compare

v2.9.2

23 Jun 19:26
Compare
Choose a tag to compare
Summary: new release

Test Plan: ./vendor/bin/phpunit -c test/phpunit-travis.xml

2.8.1

06 Oct 19:02
Compare
Choose a tag to compare

New Features

  • Instant Articles is now a separate ads placement, so that advertisers can enable or disable showing ads in Instant Articles. This new placement options is under /ACCOUNT_ID/adsets and /AD_SET_ID. See Targeting Specs. If you use this placement you must also select feed as a position and for device_platforms select mobile since Instant Articles is for mobile only.
  • Facebook Offers is redesigned and is easier for people to save and redeem your offer from any device. If they don't use your offer, they'll get notifications about it before it expires. To use the API to create offers:
    • Use /nativeoffers as an endpoint. The endpoint /offers is associated with the old product and has been deprecated.
    • Use offer_id in the promoted_object for an ad set.
    • To learn more see Offer Ads and Page Native Offers.

Breaking Changes

** Please Review These Changes

Ads Management

  • As of 2.8, Website Custom Audiences now only allow at most 200 comparisons in the rule. The number of comparisons are the number of comparison operators in the rule.
  • The place_page_set_id field under Ad creative is now optional for versions v2.7 and v2.6
    and has been deprecated in v2.8. See Ad Creative.
  • offer_data under link_data for an ad object has been deprecated.
  • The ad account group endpoints AdAccountGroup have been deprecated. To manage Ad Accounts, you should use Business Manager or Business Manager API with business_management extended permission.
  • The edge AD_ACCOUNT/audiences has been deprecated.
  • The ad_object_by_url field for /search in Ad Targeting Search has been deprecated.
  • The fields actor_id, actor_image_hash, actor_image_url, and actor_name have been deprecated from ad creative GET.

Ads Insights

  • We deprecated the redundant fields and parameters in /insights endpoint.
    In earlier releases it supported the params: fields,summary, default_summary, filtering and sort. However/insights should always exactly return what you queried in the POST requests.
  • In earlier releases we will display all valid fields for /insights if you provided an invalid field as a parameter. We now send an the error message which points to a list of valid fields.
  • In the past we inconsistently returned /insights fields in a variety of types: some fields were string such as impressions, some were numericstring, and some were float. We now return all numeric fields, including float as numericstring. All floating point numbers will maintain six precision points.
  • The insights metric post_like in the actions field is now named post_reaction, see Ads Action Stats. This is more consistent with naming in user interfaces.

Business Manager

The owner_business field has been deprecated and no longer exists for objects connected to a business, including Ad accounts, Ad Campaign, Product Catalog, and Instagram User.

2.7.1

14 Jul 21:40
Compare
Choose a tag to compare

This is a new major release, which diverges in behavior from the previous one.
Please review these changes:

  • Edges from an object now return a Cursor: To equalize the behavior of edges, now all edges from an object return a Cursor. In the past there were exceptions to this rule, e.g.: AdAccount::getReachEstimate used to return a ReachEstimate.
  • New Daily Budget Limits: We changed the logic around ads delivery which impacts the interpretation of the daily ad budget limits. Starting from v2.7, you may be charged up to 125% of your daily budget. For example, if your daily budget is $10, you may be charged up to $12.50. However, your weekly spend will NOT exceed 7 times the daily amount, or $70 in this example. We will prorate this for partial weeks. More details Ad Set Budget.
  • Lifetime Budgets and New Daily Budgets: Also, starting with v2.7, you can no longer edit ad sets created with the new daily budget controls to use lifetime budgets. Similarly you can no longer edit lifetime budgets to use the new daily budget controls.
  • Ad Placements Update: We have improvements to our design of placement, so that advertisers can more easily identify and select placement options that will serve them best. Instead of having platform as the only dimension, advertisers can select placements across different dimensions, such as device type including desktop or mobile, publisher such as facebook, instagram, or audience_network, and placements of each publisher. Only Facebook has multiple placements currently. The field page_types will still be included in read results, but cannot be used to create or update placements in v2.7. More details in Targeting Spec.
  • Insights Placement Updates: As a related change, on the /insights endpoints, we’ll introduce two new breakdowns options: publisher_platform and platform_position. Along with the existing impression_device breakdown, you can get performance metrics with these placement dimensions. See Insights Breakdowns for more details.
  • Ad Creative Update: With 2.7 object_story_id will be null for an ad creative created with an object_story_spec. The effective_object_story_id will always be the object_story_id regardless of object_story_spec. More details in Ad Creative.
  • Insights Integer Field: For Insights API, integer values were too big and overflowed with int32. We changed all int32 field values into numeric strings to keep consistent with other Marketing API fields with currency values. For v2.7 onward, numeric values in int32 will be quoted in responses. For v2.5 for backwards compatibility, numeric values in int32 will be shown as a number. More details in Ads Insights.

2.6.0

12 Apr 22:08
Compare
Choose a tag to compare

This is a new major release, which diverges in behavior from the previous one.
Please review these changes:

  • Deprecated the connectionobjects API
  • Deprecated max_product_count for DPA creatives. In order to opt-out of Carousel format, specify force_single_link=true.
  • Deprecated product_ad_behavior field at the Ad Set level
  • For /insights objects the fields parameter no longer accepts breakdowns. Now you should specified this in 'breakdowns' parameter in query. This includes: age, country, gender, frequency_value,hourly_stats_aggregated_by_advertiser_time_zone, hourly_stats_aggregated_by_audience_time_zone, impression_device, place_page_id, placement, product_id, and region
  • Reduced scope of AuthorizationException, it should only throw now for errors that have to do with Authorization. Some errors that previously were AuthorizationException may become RequestException
  • RequestException now has a single ResponseInterface param in constructor

2.5.2

09 Apr 18:33
Compare
Choose a tag to compare

Misc + bugfixes

2.5.1

06 Nov 17:21
Compare
Choose a tag to compare
  • Add support for dynamically create local ads
  • Add support for Minimum Budgets
  • Add support for Custom Audience Pixel Stats
  • Various bugfix

2.5.0

08 Oct 10:45
Compare
Choose a tag to compare
  • Comply with Facebook Graph API v2.5.
    • Notably the object renaming is the big change: 225ed62
  • Reading remote fields that are not statically declared won't cause an exception to be thrown
  • Add support for VideoThumbnails object
  • Various bugfix

2.4.2

04 Sep 13:31
Compare
Choose a tag to compare
  • Add support for Leadgen Ads

2.4.1

12 Aug 16:39
Compare
Choose a tag to compare

Misc + bugfixes