{"id":18318767,"url":"https://github.com/xdevplatform/twitter-ruby-ads-sdk","last_synced_at":"2026-04-20T00:09:00.617Z","repository":{"id":36076576,"uuid":"40376391","full_name":"xdevplatform/twitter-ruby-ads-sdk","owner":"xdevplatform","description":"A Twitter supported and maintained Ads API SDK for Ruby.","archived":false,"fork":false,"pushed_at":"2024-03-09T00:18:04.000Z","size":1474,"stargazers_count":66,"open_issues_count":16,"forks_count":70,"subscribers_count":34,"default_branch":"master","last_synced_at":"2025-02-22T22:51:20.471Z","etag":null,"topics":["ruby","sdk","twitter","twitter-ads","twitter-api"],"latest_commit_sha":null,"homepage":"https://twitterdev.github.io/twitter-ruby-ads-sdk/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xdevplatform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-08-07T19:03:02.000Z","updated_at":"2024-11-04T17:28:37.000Z","dependencies_parsed_at":"2024-04-20T22:07:35.005Z","dependency_job_id":"ef8fe3eb-890a-4cf1-8ca7-d071dd642b7a","html_url":"https://github.com/xdevplatform/twitter-ruby-ads-sdk","commit_stats":null,"previous_names":["xdevplatform/twitter-ruby-ads-sdk"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2Ftwitter-ruby-ads-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2Ftwitter-ruby-ads-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2Ftwitter-ruby-ads-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdevplatform%2Ftwitter-ruby-ads-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xdevplatform","download_url":"https://codeload.github.com/xdevplatform/twitter-ruby-ads-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247406076,"owners_count":20933803,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ruby","sdk","twitter","twitter-ads","twitter-api"],"created_at":"2024-11-05T18:11:30.575Z","updated_at":"2025-10-07T03:40:10.335Z","avatar_url":"https://github.com/xdevplatform.png","language":"Ruby","readme":"Getting Started [![Build Status](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk.svg?branch=master)](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk)[![Gem Version](https://badge.fury.io/rb/twitter-ads.svg)](http://badge.fury.io/rb/twitter-ads)\n------\n\n##### Installation\n```bash\n# installing the latest signed release\ngem install twitter-ads\n```\n\n##### Quick Start\n```ruby\nrequire 'twitter-ads'\n\n# initialize the client\nclient = TwitterAds::Client.new(\n  CONSUMER_KEY,\n  CONSUMER_SECRET,\n  ACCESS_TOKEN,\n  ACCESS_TOKEN_SECRET\n)\n\n# load the advertiser account instance\naccount = client.accounts('c3won9gy')\n\n# load and update a specific campaign\ncampaign = account.campaigns('4m0gjms')\ncampaign.entity_status = EntityStatus::PAUSED\ncampaign.save\n\n# iterate through campaigns\naccount.campaigns.each do |camp|\n  # do stuff\nend\n```\n\n##### Command Line Helper\n```bash\n# The twitter-ads command launches an interactive session for testing purposes\n# with a client instance automatically loaded from your .twurlrc file.\n\n~ ❯ twitter-ads\ntwitter-ads vX.X.X \u003e\u003e CLIENT\n=\u003e #\u003cTwitterAds::Client:0x70101526238580 consumer_key=\"Fy90KQy57152sn5Mv7axji9409\"\u003e\ntwitter-ads vX.X.X \u003e\u003e CLIENT.accounts.first\n=\u003e #\u003cTwitterAds::Account:0x70101527905720 id=\"4lvtcum\"\u003e\n```\nFor more help please see our [Examples and Guides](https://github.com/twitterdev/twitter-ruby-ads-sdk/tree/master/examples) or check the online [Reference Documentation](http://twitterdev.github.io/twitter-ruby-ads-sdk/reference/index.html).\n\n## Compatibility \u0026 Versioning\n\nThis project is designed to work with Ruby 2.4.0 or greater. While it may work on other version of Ruby, below are the platform and runtime versions we officially support and regularly test against.\n\nPlatform | Versions\n-------- | --------\nMRI | 2.4.x, 2.5.x, 2.6.x, 2.7, 3.0\nRubinius | 2.4.x, 2.5.x\n\nAll releases adhere to strict [semantic versioning](http://semver.org). For Example, major.minor.patch-pre (aka. stick.carrot.oops-peek).\n\n## Development\nIf you'd like to contribute to the project or try an unreleased development version of this project locally, you can do so quite easily by following the examples below.\n```bash\n# clone the repository\ngit clone git@github.com:twitterdev/twitter-ruby-ads-sdk.git\ncd twitter-ruby-ads-sdk\n\n# install dependencies\nbundle install\n\nrake docs # building documentation\nrake spec # run all tests\n\n# installing a local unsigned release\ngem build twitter-ads.gemspec \u0026 gem install twitter-ads-X.X.X.gem\n```\nWe love community contributions! If you're planning to send us a pull request, please make sure read our [Contributing Guidelines](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/CONTRIBUTING.md) first.\n\n## Feedback and Bug Reports\nFound an issue? Please open up a [GitHub issue](https://github.com/twitterdev/twitter-ruby-ads-sdk/issues) or even better yet [send us](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/CONTRIBUTING.md) a pull request.\u003cbr/\u003e\nHave a question? Want to discuss a new feature? Come chat with us in the [Twitter Community Forums](https://twittercommunity.com/c/advertiser-api).\n\n## Error Handling\n\nLike the [Response](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/lib/twitter-ads/http/response.rb) and [Request](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/lib/twitter-ads/http/request.rb) classes, the Ads API SDK fully models all [error objects](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/lib/twitter-ads/error.rb) for easy error handling.\n\n\u003cimg src=\"http://i.imgur.com/opbv7Nh.png\" alt=\"Error Hierarchy\"\u003e\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (C) 2021 Twitter, Inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdevplatform%2Ftwitter-ruby-ads-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxdevplatform%2Ftwitter-ruby-ads-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdevplatform%2Ftwitter-ruby-ads-sdk/lists"}