Skip to content

v6.0.0
Compare
Choose a tag to compare
@smaeda-ks smaeda-ks released this 20 Sep 03:31
· 23 commits to master since this release
v6.0.0
d7a99e3
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

This release is mainly focused on following the recent Ads API version 6 release.
Several important changes are made in version 6 so please see the full details as to what's changed: https://twittercommunity.com/t/ads-api-version-6/129060

You can check all the SDK changes we made in this new release from this PR: #210
We also updated the handy Postman collection (v6 support) to make your testing and development workflow even easier.
Run in Postman

New

Number of processing jobs

https://twittercommunity.com/t/ads-api-version-6/129060/1#heading--number-of-processing-jobs
In order to make it easier to manage asynchronous analytics workflows, the Ads API now returns two new response headers:

  • X-Concurrent-Job-Limit: The maximum number of jobs that may be in a processing state at any given time
  • X-Concurrent-Job-Limit-Remaining: The number of jobs that can be created given the number currently being processed

These values are returned when asynchronous analytics jobs are created using the POST stats/jobs/accounts/:account_id endpoint, and SDK users can access these headers through instance variables:

stats = TwitterAds::LineItem.create_async_job(account, ids, metric_groups)

puts stats.concurrent_job_limit
puts stats.concurrent_job_limit_remaining

Changed

Analytics.create_async_job()

  • Analytics.create_async_job() can now be called directly (with specifying entity parameter)
  • Analytics.create_async_job() now returns instance rather than hash
- job_id = TwitterAds::LineItem.create_async_job(account, ids, metric_groups)[id]
+ job_id = TwitterAds::LineItem.create_async_job(account, ids, metric_groups).id

as_user_id now required 61bfa97

https://twittercommunity.com/t/ads-api-version-6/129060/1#heading--as-user-id-now-required
Given the impact of this change, SDK now provides a new class method UserIdLookup.load() that can be used to lookup an user_id by a given Twitter screen name.

user_id = TwitterRestApi::UserIdLookup.load(account, screen_name: 'your_twitter_handle_name').id

Deprecated

Scoped Timeline

The GET accounts/:account_id/scoped_timeline endpoint is no longer available in v6. 9683ca8
https://twittercommunity.com/t/ads-api-version-6/129060/1#heading--scoped-timeline
* SDK will continue to support this endpoint until the v5 became sunset.

Removed

Audience Intelligence

https://twittercommunity.com/t/announcement-audience-intelligence-deprecation/127907

Old Tweet preview endpoints

Below endpoints are removed in this release:

  • GET accounts/:account_id/tweet/preview
  • GET accounts/:account_id/tweet/preview/:tweet_id
  • GET accounts/:account_id/draft_tweets/preview/:draft_tweet_id
  • GET accounts/:account_id/scheduled_tweets/preview/:scheduled_tweet_id
Assets 2
Loading