EAAS/NFV>> twitter-ads.cr>> 返回
项目作者： maiha

项目描述 ：
Twitter Ads API SDK for Crystal
高级语言： Crystal
项目地址: git://github.com/maiha/twitter-ads.cr.git
创建时间： 2019-08-02T14:19:37Z
项目社区：https://github.com/maiha/twitter-ads.cr
开源协议：MIT License
下载


twitter-ads.cr Build Status

Twitter Ads API SDK for Crystal.

  • crystal: 0.33.0

Usage

  1. require "twitter-ads"
  3. # client = TwitterAds::Client.from_twurlrc("~/.twurlrc")
  4. client = TwitterAds::Client.new(
  5.   CONSUMER_KEY,
  6.   CONSUMER_SECRET,
  7.   ACCESS_TOKEN,
  8.   ACCESS_TOKEN_SECRET
  9. )
  10. client.api_version = "10" # Set this when you need a specific version
  11. # client.api_suffix = ".json" # Set this when you need a specific suffix
  13. accounts = client.accounts(count: 200)
  14. accounts.req.to_s              # => "GET /8/accounts?count=200"
  15. accounts.rate_limit            # => "1998/2000"
  16. accounts.rate_limit.available? # => true
  17. accounts.size                  # => 16
  18. accounts.next_cursor?          # => nil
  20. accounts.each do |a|
  21.   a.id                         # => "18ce54d4x5t"
  22.   a.name                       # => "API McTestface"
  24.   campaigns = client.campaigns(a.id)
  25.   campaigns.each do |c|
  26.     c.name                     # => "batch campaigns"

API

  1. TwitterAds::Client
  2.   def accounts() : Api::Accounts
  3.   def account_media(account_id : String) : Api::AccountMedia
  4.   def authenticated_user_access(account_id : String) : AuthenticatedUserAccess
  5.   def campaigns(account_id : String) : Api::Campaigns
  6.   def cards(account_id : String) : Api::Cards
  7.   def cards_all(account_id : String, card_uris : Array(String)) : Api::CardsAll
  8.   def cards_image_app_download(account_id : String) : Api::CardsImageAppDownload
  9.   def cards_image_conversation(account_id : String) : Api::CardsImageConversation
  10.   def cards_image_direct_message(account_id : String) : Api::CardsImageDirectMessage
  11.   def cards_poll(account_id : String) : Api::CardsPoll
  12.   def cards_video_app_download(account_id : String) : Api::CardsVideoAppDownload
  13.   def cards_video_conversation(account_id : String) : Api::CardsVideoConversation
  14.   def cards_video_direct_message(account_id : String) : Api::CardsVideoDirectMessage
  15.   def cards_video_website(account_id : String) : Api::CardsVideoWebsite
  16.   def cards_website(account_id : String) : Api::CardsWebsite
  17.   def custom_audiences(account_id : String) : Api::CustomAudiences
  18.   def draft_tweets(account_id : String) : Api::DraftTweets
  19.   def funding_instruments(account_id : String) : Api::FundingInstruments
  20.   def line_items(account_id : String) : Api::LineItems
  21.   def line_item_placements() : Api::LineItemPlacements
  22.   def media_creatives(account_id : String) : Api::MediaCreatives
  23.   def media_library(account_id : String) : Api::MediaLibrary
  24.   def preroll_call_to_actions(account_id : String) : Api::PrerollCallToActions
  25.   def promoted_accounts(account_id : String) : Api::PromotedAccounts
  26.   def promoted_tweets(account_id : String) : Api::PromotedTweets
  27.   def scheduled_promoted_tweets(account_id : String) : Api::ScheduledPromotedTweets
  28.   def scheduled_tweets(account_id : String) : Api::ScheduledTweets
  29.   def targeting_criteria(account_id : String, line_item_ids : Array(String)) : Api::TargetingCriteria
  30.   def targeting_criteria_app_store_categories(q : String? = nil, store : String? = nil) : Api::TargetingCriteriaAppStoreCategories
  31.   def targeting_criteria_conversations(conversation_type : String? = nil) : Api::TargetingCriteriaConversations
  32.   def targeting_criteria_devices(q : String? = nil) : Api::TargetingCriteriaDevices
  33.   def targeting_criteria_events(event_types : String? = nil, country_codes : String? = nil, ids : String = nil, start_time : String? = nil, end_time = String? = nil) : Api::TargetingCriteriaEvents
  34.   def targeting_criteria_interests(q : String? = nil) : Api::TargetingCriteriaInterests
  35.   def targeting_criteria_languages(q : String? = nil) : Api::TargetingCriteriaLanguages
  36.   def targeting_criteria_locations(country_code = nil, location_type = nil, q = nil) : Api::TargetingCriteriaLocations
  37.   def targeting_criteria_network_operators(country_code : String? = nil, q : String? = nil) : Api::TargetingCriteriaNetworkOperators
  38.   def targeting_criteria_platform_versions(q : String? = nil) : Api::TargetingCriteriaPlatformVersions
  39.   def targeting_criteria_platforms(lang : String? = nil, q : String? = nil) : Api::TargetingCriteriaPlatforms
  40.   def targeting_criteria_tv_markets : Api::TargetingCriteriaTvMarkets
  41.   def targeting_criteria_tv_shows(tv_market_locale : String, q : String? = nil) : Api::TargetingCriteriaTvShows
  42.   def tweet_previews(account_id : String, tweet_type : String, tweet_ids : Array(Int64)) : Api::TweetPreviews
  43.   def tweets(account_id : String, tweet_type : String, trim_user : Bool = false) : Api::Tweets
  45. # Twitter API
  46. TwitterAds::Client
  47.   def statuses_lookup(id : String | Array(String)) : Api::StatusesLookup
  49. TwitterAds::Response
  50.   def rate_limit : RateLimit
  52. TwitterAds::RateLimit
  53.   def available? : Bool
  54.   def limit : Int32
  55.   def remaining : Int32
  56.   def reset : Int32

with_deleted, with_draft, count, cursor argments are also available in all methods if possible.

See src/twitter-ads/api/ for more details.

OAuth2

  1. client = TwitterAds::Client.new("CK", "CS", "AT", "AS", "BT")  # add "Bearer token" for 5th arg.
  2. client.oauth2_standard = true  # use OAuth2 for api.twitter.com
  3. client.oauth2_ads      = true  # use OAuth2 for ads-api.twitter.com

Models

./src/twitter-ads/models

Samples

Actual usages are in ./samples/

Protobuf

schema (version 2)

generated crystal codes

Protobuf-related files are not read by default.
To use it, you need to install protobuf.cr and require above codes.

  1. require "protobuf"
  2. require "twitter-ads/proto"

Installation

Add this to your application’s shard.yml:

  1. dependencies:
  2.   twitter-ads:
  3.     github: maiha/twitter-ads.cr
  4.     version: 12.3.0

Development

  1. $ crystal spec

NOTE

  • The cards API uses the external UNIX command jq.
  • media_library: media_id returns String (document says Type: long)
  • targeting-criteria: targeting_value sometimes returns 0 (Integer).

Roadmap

  • Analytics
    • Asynchronous Analytics
    • Reach and Average Frequency
    • Synchronous Analytics
    • Auction Insights
    • Active Entities
  • Audiences
    • Insights
    • Keyword Insights
    • Tailored Audience Permissions
    • Tailored Audiences
    • Audience Intelligence
    • Tailored Audiences Users
  • Campaign Management
    • Accounts
    • Authenticated User Access
    • Bidding Rules
    • Campaigns
    • Content Categories
    • Features
    • Funding Instruments
    • IAB Categories
    • Line Items
    • Line Item Placements
    • Media Creatives
    • Promoted Accounts
    • Promoted Tweets
    • Promotable Users
    • Reach Estimate
    • Scheduled Promoted Tweets
    • Targeting Criteria
    • Targeting Options
      • App Store Categories
      • Conversation
      • Devices
      • Events
      • Interests
      • Languages
      • Locations
      • Network Operators
      • Platform Versions
      • Platforms
      • TV Markets
      • TV Shows
    • Targeting Suggestions
    • Tax Settings
    • User Settings
  • Creatives
    • Account Media
    • Image App Download Cards
    • Image Conversation Cards
    • Scheduled Tweets
    • Video App Download Cards
    • Video Conversation Cards
    • Video Website Cards
    • Website Cards
    • Preroll Call To Actions
    • Tweets
    • Image Direct Message Cards
    • Video Direct Message Cards
    • Media Library
    • Cards Fetch
    • Poll Cards
    • Draft Tweets
    • Tweet Previews
    • Tweets
  • Measurement
    • App Event Provider Configurations
    • App Event Tags
    • Web Event Tags
    • App Lists
    • Conversion Attribution
    • Conversion Event
  • Twitter API
    • GET statuses/lookup

Breaking changes

v11

  • [CHANGED] user_id in authenticated_user_access changed from int64 to string
  • [CHANGED] id in draft_tweets changed from int64 to string
  • [CHANGED] advertiser_user_id in line_item changed from int64 to string
  • [DEPRECATED] cards_image_app_download
  • [DEPRECATED] cards_image_direct_message
  • [DEPRECATED] cards_video_app_download
  • [DEPRECATED] cards_video_direct_message
  • [DEPRECATED] cards_video_website
  • [DEPRECATED] cards_website

v10

  • [DEPRECATED] tracking_tags parameter on line_items (use tracking_tag instead)

v9

  • [DEPRECATED] line_item_apps (use line_item instead)

v7

  • [DEPRECATED] id parameter on targeting_criteria/events
  • [DEPRECATED] id parameter on targeting_criteria/tv_markets

v6

  • [REMOVED] scoped_timeline
  • [REMOVED] targeting_criteria/behaviors
  • [CHANGED] locale is a required parameter on targeting_criteria/tv_shows

Contributing

  1. Fork it (https://github.com/maiha/twitter-ads.cr/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors