class

TwitterAds::Client

Inherits TwitterAds::Api::Executable < Reference < Object

Constants

ADS_DEFAULT_DOMAIN = "https://ads-api.twitter.com"
ADS_SANDBOX_DOMAIN = "https://ads-api-sandbox.twitter.com"
API_DEFAULT_DOMAIN = "https://api.twitter.com"
API_DEFAULT_VERSION = "12"

Constructors

from_twurlrc(path = "~/.twurlrc") : Client
Source
new(consumer_key : Nil | String, consumer_secret : Nil | String, access_token : Nil | String, access_token_secret : Nil | String, bearer_token : Nil | String = nil, url : String | Nil = nil, logger : Logger | Nil = nil)
Source

Instance methods

_stats(account_id : String, entity : String | Api::Stats::Entity, entity_ids : Array(String), start_time : String | Time, end_time : String | Time, metrics : String | Array(String) | Array(Api::Stats::Metric), granularity : String | Api::Stats::Granularity = "HOUR", placement : String | Api::Stats::Placement = "ALL_ON_TWITTER")
Source
access_token
access_token=(v : String) : String
access_token=(v : Nil)

nil assignments are always ignored

access_token?
access_token_secret
access_token_secret=(v : String) : String
access_token_secret=(v : Nil)

nil assignments are always ignored

access_token_secret?
account_media(account_id : String, count : Int32 = 200, cursor : String = "") : Api::AccountMedia
Source
accounts(with_deleted : Bool = false, count : Int32 = 200, cursor : String = "") : Api::Accounts
Source
api_suffix
api_suffix=(v : String) : String
api_suffix=(v : Nil)

nil assignments are always ignored

api_suffix?
api_version

API

api_version=(v : String) : String

API

api_version=(v : Nil)

nil assignments are always ignored

api_version?

API

authenticated_user_access(account_id : String) : Api::AuthenticatedUserAccess
Source
authorized?

#####################################################################

Accessor methods

Source
bearer_token
bearer_token=(v : String) : String
bearer_token=(v : Nil)

nil assignments are always ignored

bearer_token?
campaigns(account_id : String, with_deleted : Bool = false, with_draft : Bool = false, count : Int32 = 200, cursor : String = "") : Api::Campaigns
Source
cards(account_id : String, count : Int32 = 200, cursor : String = "") : Api::Cards
Source
cards_all(account_id : String, card_uris : Array(String)) : Api::CardsAll
Source
cards_image_app_download(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsImageAppDownload
Source
cards_image_conversation(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsImageConversation
Source
cards_image_direct_message(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsImageDirectMessage
Source
cards_poll(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsPoll
Source
cards_video_app_download(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsVideoAppDownload
Source
cards_video_conversation(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsVideoConversation
Source
cards_video_direct_message(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsVideoDirectMessage
Source
cards_video_website(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsVideoWebsite
Source
cards_website(account_id : String, count : Int32 = 200, cursor : String = "") : Api::CardsWebsite
Source
connect_timeout
connect_timeout=(v : Float64) : Float64
connect_timeout=(v : Nil)

nil assignments are always ignored

connect_timeout?
consumer_key

OAuth

consumer_key=(v : String) : String

OAuth

consumer_key=(v : Nil)

nil assignments are always ignored

consumer_key?

OAuth

consumer_secret
consumer_secret=(v : String) : String
consumer_secret=(v : Nil)

nil assignments are always ignored

consumer_secret?
custom_audiences(account_id : String, with_deleted : Bool = false, count : Int32 = 200, cursor : String = "") : Api::CustomAudiences
Source
dns_timeout
dns_timeout=(v : Float64) : Float64
dns_timeout=(v : Nil)

nil assignments are always ignored

dns_timeout?
draft_tweets(account_id : String, count : Int32 = 200, cursor : String = "") : Api::DraftTweets
Source
dryrun
dryrun=(v : Bool) : Bool
dryrun=(v : Nil)

nil assignments are always ignored

dryrun?
funding_instruments(account_id : String, count : Int32 = 200, cursor : String = "") : Api::FundingInstruments
Source
get(path : String, params = {} of String => String) : Response

See ./api/*.cr #####################################################################

HTTP methods

Source
jq

JQ

jq=(v : Jq) : Jq

JQ

jq=(v : Nil)

nil assignments are always ignored

jq?

JQ

line_item_placements
Source
line_items(account_id : String, with_deleted : Bool = false, with_draft : Bool = false, count : Int32 = 200, cursor : String = "") : Api::LineItems
Source
logger
logger=(v : Logger) : Logger
logger=(v : Nil)

nil assignments are always ignored

logger?
media_creatives(account_id : String, with_deleted : Bool = false, count : Int32 = 200, cursor : String = "") : Api::MediaCreatives
Source
media_library(account_id : String, count : Int32 = 200, cursor : String = "") : Api::MediaLibrary
Source
oauth2_ads
oauth2_ads=(v : Bool) : Bool
oauth2_ads=(v : Nil)

nil assignments are always ignored

oauth2_ads?
oauth2_standard
oauth2_standard=(v : Bool) : Bool
oauth2_standard=(v : Nil)

nil assignments are always ignored

oauth2_standard?
post(path : String, form = {} of String => String) : Response
Source
preroll_call_to_actions(account_id : String, count : Int32 = 200, cursor : String = "") : Api::PrerollCallToActions
Source
promotable_users(account_id : String, with_deleted : Bool = false, count : Int32 = 200, cursor : String = "") : Api::PromotableUsers
Source
read_timeout
read_timeout=(v : Float64) : Float64
read_timeout=(v : Nil)

nil assignments are always ignored

read_timeout?
scheduled_promoted_tweets(account_id : String, with_deleted : Bool = false, count : Int32 = 200, cursor : String = "") : Api::ScheduledPromotedTweets
Source
scheduled_tweets(account_id : String, count : Int32 = 200, cursor : String = "") : Api::ScheduledTweets
Source
stats(account_id : String, entity : String | Api::Stats::Entity, entity_ids : Array(String), start_time : String | Time, end_time : String | Time, metrics : String | Array(String) | Array(Api::Stats::Metric), granularity : String | Api::Stats::Granularity = "HOUR", placement : String | Api::Stats::Placement = "ALL_ON_TWITTER") : TwitterAds::StatsAccount
Source
statuses_lookup(id : String | Array(String)) : Api::StatusesLookup

This is not "twitter-ads-api" but "twitter-api" that requires ".json" extension. So the setting of TwitterAds::Client#api_suffix should be ignored.

Source
switch_domain
switch_domain=(v : Bool) : Bool
switch_domain=(v : Nil)

nil assignments are always ignored

switch_domain?
targeting_criteria(account_id : String, line_item_ids : Array(String), with_deleted : Bool = false, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteria
Source
targeting_criteria_app_store_categories(q : String | Nil = nil, store : String | Api::TargetingCriteriaAppStoreCategories::Store | Nil = nil) : Api::TargetingCriteriaAppStoreCategories
Source
targeting_criteria_conversations(conversation_type : String | Api::TargetingCriteriaConversations::ConversationType | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteriaConversations
Source
targeting_criteria_devices(q : String | Nil = nil, count : Int32 = 200) : Api::TargetingCriteriaDevices
Source
targeting_criteria_events(event_types : String | Api::TargetingCriteriaEvents::EventTypes, country_codes : String | Nil = nil, ids : String | Array(String) | Nil = nil, start_time : String | Time | Nil = nil, end_time : String | Time | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteriaEvents
Source
targeting_criteria_interests(q : String | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteriaInterests
Source
targeting_criteria_languages(q : String | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteriaLanguages
Source
targeting_criteria_locations(country_code : String | Nil = nil, location_type : String | Nil = nil, q : String | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteriaLocations
Source
targeting_criteria_network_operators(country_code : String | Nil = nil, q : String | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteriaNetworkOperators
Source
targeting_criteria_platform_versions(q : String | Nil = nil) : Api::TargetingCriteriaPlatformVersions
Source
targeting_criteria_platforms(lang : String | Nil = nil, q : String | Nil = nil, count : Int32 = 200) : Api::TargetingCriteriaPlatforms
Source
targeting_criteria_tv_markets
Source
targeting_criteria_tv_shows(tv_market_locale : String, q : String | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::TargetingCriteriaTvShows
Source
tweet_previews(account_id : String, tweet_type : String | Api::TweetPreviews::TweetType, tweet_ids : Array(Int64)) : Api::TweetPreviews
Source
tweets(account_id : String, tweet_type : String | Api::Tweets::TweetType = "PUBLISHED", include_mentions_and_replies : Bool = false, timeline_type : String | Api::Tweets::TimelineType = "NULLCAST", trim_user : Bool = false, tweet_ids : String | Nil = nil, user_id : Int64 | Nil = nil, count : Int32 = 200, cursor : String = "") : Api::Tweets
Source
tweets_lookup(id : String | Array(String), expansions : String = "", tweet_fields : String = "", media_fields : String = "", place_fields : String = "", poll_fields : String = "", user_fields : String = "") : Api::TweetsLookup
Source
uri

HTTP

uri=(v : URI) : URI

HTTP

uri=(v : Nil)

nil assignments are always ignored

uri?

HTTP

url=(s : String)
Source
user_agent
user_agent=(v : String) : String
user_agent=(v : Nil)

nil assignments are always ignored

user_agent?