twitter-ads 5.0.0 → 5.1.0

data/lib/twitter-ads/creative/scheduled_tweet.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -31,12 +31,12 @@ module TwitterAds
       property :scheduled_at, type: :time
       property :text
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/scheduled_tweets'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/scheduled_tweets/%{id}'.freeze # @api private
-      PREVIEW  = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/scheduled_tweets/preview/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/scheduled_tweets' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/scheduled_tweets/%{id}' # @api private
+      PREVIEW  = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/scheduled_tweets/preview/%{id}' # @api private
 
       def preview(account, opts = {})
         if @id

data/lib/twitter-ads/creative/tweet_previews.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  module Creative
+
+    class TweetPreview
+
+      include TwitterAds::DSL
+      include TwitterAds::Resource
+
+      attr_reader :account
+
+      property :preview, read_only: true
+      property :tweet_id, read_only: true
+
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/tweet_previews' # @api private
+
+      def load(account, tweet_ids:, tweet_type:)
+        params = { tweet_ids: Array(tweet_ids).join(',') }
+        params[:tweet_type] = tweet_type
+        resource = RESOURCE_COLLECTION % { account_id: account.id }
+        request = Request.new(account.client, :get, resource, params: params)
+        Cursor.new(self.class, request, init_with: [account])
+      end
+
+      def initialize(account)
+        @account = account
+        self
+      end
+
+    end
+
+  end
+end

data/lib/twitter-ads/creative/video_app_download_card.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -36,10 +36,10 @@ module TwitterAds
       property :name
       property :video_id
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/cards/video_app_download'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/cards/video_app_download/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/cards/video_app_download' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/cards/video_app_download/%{id}' # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/video_conversation_card.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -38,10 +38,10 @@ module TwitterAds
       property :title
       property :video_id
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/cards/video_conversation'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/cards/video_conversation/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/cards/video_conversation' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/cards/video_conversation/%{id}' # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/video_website_card.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -37,9 +37,9 @@ module TwitterAds
       property :website_url
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/accounts/%{account_id}/cards/video_website"
-                            .freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/cards/video_website/%{id}'.freeze # @api private
+      # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/cards/video_website/%{id}' # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/website_card.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -30,9 +30,9 @@ module TwitterAds
       property :website_url
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/accounts/%{account_id}/cards/website"
-                            .freeze # @api private
+      # @api private
       RESOURCE            = "/#{TwitterAds::API_VERSION}/accounts/%{account_id}/cards/website/%{id}"
-                            .freeze # @api private
+      # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/cursor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Cursor
@@ -113,7 +113,7 @@ module TwitterAds
       @next_cursor = response.body[:next_cursor]
       @total_count = response.body[:total_count].to_i if response.body.key?(:total_count)
       response.body.fetch(:data, []).each do |object|
-        @collection << if @klass && @klass.method_defined?(:from_response)
+        @collection << if @klass&.method_defined?(:from_response)
                          @klass.new(
                            *@options[:init_with]).from_response(object)
                        else

data/lib/twitter-ads/enum.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 # Copyright (Cend 2015 Twitter, Inc.
 
@@ -7,27 +7,27 @@ module TwitterAds
   module Enum
 
     module Objective
-      APP_ENGAGEMENTS     = 'APP_ENGAGEMENTS'.freeze
-      APP_INSTALLS        = 'APP_INSTALLS'.freeze
-      FOLLOWERS           = 'FOLLOWERS'.freeze
-      LEAD_GENERATION     = 'LEAD_GENERATION'.freeze
-      TWEET_ENGAGEMENTS   = 'TWEET_ENGAGEMENTS'.freeze
-      VIDEO_VIEWS         = 'VIDEO_VIEWS'.freeze
-      WEBSITE_CLICKS      = 'WEBSITE_CLICKS'.freeze
-      WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'.freeze
+      APP_ENGAGEMENTS     = 'APP_ENGAGEMENTS'
+      APP_INSTALLS        = 'APP_INSTALLS'
+      FOLLOWERS           = 'FOLLOWERS'
+      LEAD_GENERATION     = 'LEAD_GENERATION'
+      TWEET_ENGAGEMENTS   = 'TWEET_ENGAGEMENTS'
+      VIDEO_VIEWS         = 'VIDEO_VIEWS'
+      WEBSITE_CLICKS      = 'WEBSITE_CLICKS'
+      WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'
 
     end
 
     module Product
-      PROMOTED_ACCOUNT = 'PROMOTED_ACCOUNT'.freeze
-      PROMOTED_TWEETS  = 'PROMOTED_TWEETS'.freeze
+      PROMOTED_ACCOUNT = 'PROMOTED_ACCOUNT'
+      PROMOTED_TWEETS  = 'PROMOTED_TWEETS'
     end
 
     module Placement
-      ALL_ON_TWITTER    = 'ALL_ON_TWITTER'.freeze
-      TWITTER_SEARCH    = 'TWITTER_SEARCH'.freeze
-      TWITTER_TIMELINE  = 'TWITTER_TIMELINE'.freeze
-      PUBLISHER_NETWORK = 'PUBLISHER_NETWORK'.freeze
+      ALL_ON_TWITTER    = 'ALL_ON_TWITTER'
+      TWITTER_SEARCH    = 'TWITTER_SEARCH'
+      TWITTER_TIMELINE  = 'TWITTER_TIMELINE'
+      PUBLISHER_NETWORK = 'PUBLISHER_NETWORK'
     end
 
     module Placement
@@ -56,176 +56,182 @@ module TwitterAds
     end
 
     module BidUnit
-      APP_CLICK   = 'APP_CLICK'.freeze
-      APP_INSTALL = 'APP_INSTALL'.freeze
-      ENGAGEMENT  = 'ENGAGEMENT'.freeze
-      FOLLOW      = 'FOLLOW'.freeze
-      LEAD        = 'LEAD'.freeze
-      LINK_CLICK  = 'LINK_CLICK'.freeze
-      VIEW        = 'VIEW'.freeze
-      VIEW_3S_100PCT = 'VIEW_3S_100PCT'.freeze
+      APP_CLICK   = 'APP_CLICK'
+      APP_INSTALL = 'APP_INSTALL'
+      ENGAGEMENT  = 'ENGAGEMENT'
+      FOLLOW      = 'FOLLOW'
+      LEAD        = 'LEAD'
+      LINK_CLICK  = 'LINK_CLICK'
+      VIEW        = 'VIEW'
+      VIEW_3S_100PCT = 'VIEW_3S_100PCT'
     end
 
     module BidType
-      MAX    = 'MAX'.freeze
-      AUTO   = 'AUTO'.freeze
-      TARGET = 'TARGET'.freeze
+      MAX    = 'MAX'
+      AUTO   = 'AUTO'
+      TARGET = 'TARGET'
     end
 
     module ChargeBy
-      APP_CLICK   = 'APP_CLICK'.freeze
-      APP_INSTALL = 'APP_INSTALL'.freeze
-      ENGAGEMENT  = 'ENGAGEMENT'.freeze
-      FOLLOW      = 'FOLLOW'.freeze
-      LEAD        = 'LEAD'.freeze
-      LINK_CLICK  = 'LINK_CLICK'.freeze
-      VIEW        = 'VIEW'.freeze
-      VIEW_3S_100PCT = 'VIEW_3S_100PCT'.freeze
+      APP_CLICK   = 'APP_CLICK'
+      APP_INSTALL = 'APP_INSTALL'
+      ENGAGEMENT  = 'ENGAGEMENT'
+      FOLLOW      = 'FOLLOW'
+      LEAD        = 'LEAD'
+      LINK_CLICK  = 'LINK_CLICK'
+      VIEW        = 'VIEW'
+      VIEW_3S_100PCT = 'VIEW_3S_100PCT'
     end
 
     module MetricGroup
-      ENGAGEMENT        = 'ENGAGEMENT'.freeze
-      WEB_CONVERSION    = 'WEB_CONVERSION'.freeze
-      MOBILE_CONVERSION = 'MOBILE_CONVERSION'.freeze
-      MEDIA             = 'MEDIA'.freeze
-      VIDEO             = 'VIDEO'.freeze
-      BILLING           = 'BILLING'.freeze
-      LIFE_TIME_VALUE_MOBILE_CONVERSION = 'LIFE_TIME_VALUE_MOBILE_CONVERSION'.freeze
+      ENGAGEMENT        = 'ENGAGEMENT'
+      WEB_CONVERSION    = 'WEB_CONVERSION'
+      MOBILE_CONVERSION = 'MOBILE_CONVERSION'
+      MEDIA             = 'MEDIA'
+      VIDEO             = 'VIDEO'
+      BILLING           = 'BILLING'
+      LIFE_TIME_VALUE_MOBILE_CONVERSION = 'LIFE_TIME_VALUE_MOBILE_CONVERSION'
     end
 
     module JobStatus
-      QUEUED      = 'QUEUED'.freeze
-      PROCESSING  = 'PROCESSING'.freeze
-      UPLOADING   = 'UPLOADING'.freeze
-      SUCCESS     = 'SUCCESS'.freeze
-      FAILED      = 'FAILED'.freeze
+      QUEUED      = 'QUEUED'
+      PROCESSING  = 'PROCESSING'
+      UPLOADING   = 'UPLOADING'
+      SUCCESS     = 'SUCCESS'
+      FAILED      = 'FAILED'
     end
 
     module Entity
-      ACCOUNT            = 'ACCOUNT'.freeze
-      FUNDING_INSTRUMENT = 'FUNDING_INSTRUMENT'.freeze
-      CAMPAIGN           = 'CAMPAIGN'.freeze
-      LINE_ITEM          = 'LINE_ITEM'.freeze
-      PROMOTED_TWEET     = 'PROMOTED_TWEET'.freeze
-      ORGANIC_TWEET      = 'ORGANIC_TWEET'.freeze
-      MEDIA_CREATIVE     = 'MEDIA_CREATIVE'.freeze
+      ACCOUNT            = 'ACCOUNT'
+      FUNDING_INSTRUMENT = 'FUNDING_INSTRUMENT'
+      CAMPAIGN           = 'CAMPAIGN'
+      LINE_ITEM          = 'LINE_ITEM'
+      PROMOTED_TWEET     = 'PROMOTED_TWEET'
+      ORGANIC_TWEET      = 'ORGANIC_TWEET'
+      MEDIA_CREATIVE     = 'MEDIA_CREATIVE'
     end
 
     module EntityStatus
-      ACTIVE = 'ACTIVE'.freeze
-      DRAFT  = 'DRAFT'.freeze
-      PAUSED = 'PAUSED'.freeze
+      ACTIVE = 'ACTIVE'
+      DRAFT  = 'DRAFT'
+      PAUSED = 'PAUSED'
     end
 
     module CreativeType
-      BANNER                        = 'BANNER'.freeze
-      INTERSTITIAL                  = 'INTERSTITIAL'.freeze
-      PREROLL                       = 'PREROLL'.freeze
-      VAST_PREROLL                  = 'VAST_PREROLL'.freeze
-      MEDIUM_RECTANGLE              = 'MEDIUM_RECTANGLE'.freeze
-      BANNER_TABLET                 = 'BANNER_TABLET'.freeze
-      INTERSTITIAL_LANDSCAPE        = 'INTERSTITIAL_LANDSCAPE'.freeze
-      INTERSTITIAL_TABLET           = 'INTERSTITIAL_TABLET'.freeze
-      INTERSTITIAL_LANDSCAPE_TABLET = 'INTERSTITIAL_LANDSCAPE_TABLET'.freeze
+      BANNER                        = 'BANNER'
+      INTERSTITIAL                  = 'INTERSTITIAL'
+      PREROLL                       = 'PREROLL'
+      VAST_PREROLL                  = 'VAST_PREROLL'
+      MEDIUM_RECTANGLE              = 'MEDIUM_RECTANGLE'
+      BANNER_TABLET                 = 'BANNER_TABLET'
+      INTERSTITIAL_LANDSCAPE        = 'INTERSTITIAL_LANDSCAPE'
+      INTERSTITIAL_TABLET           = 'INTERSTITIAL_TABLET'
+      INTERSTITIAL_LANDSCAPE_TABLET = 'INTERSTITIAL_LANDSCAPE_TABLET'
     end
 
     module MediaCategory
-      AMPLIFY_VIDEO = 'AMPLIFY_VIDEO'.freeze
-      TWEET_GIF     = 'TWEET_GIF'.freeze
-      TWEET_IMAGE   = 'TWEET_IMAGE'.freeze
-      TWEET_VIDEO   = 'TWEET_VIDEO'.freeze
+      AMPLIFY_VIDEO = 'AMPLIFY_VIDEO'
+      TWEET_GIF     = 'TWEET_GIF'
+      TWEET_IMAGE   = 'TWEET_IMAGE'
+      TWEET_VIDEO   = 'TWEET_VIDEO'
     end
 
     module MediaType
-      GIF   = 'GIF'.freeze
-      IMAGE = 'IMAGE'.freeze
-      VIDEO = 'VIDEO'.freeze
+      GIF   = 'GIF'
+      IMAGE = 'IMAGE'
+      VIDEO = 'VIDEO'
     end
 
     module Optimizations
-      DEFAULT             = 'DEFAULT'.freeze
-      WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'.freeze
+      DEFAULT             = 'DEFAULT'
+      WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'
     end
 
     module Granularity
-      HOUR  = 'HOUR'.freeze
-      DAY   = 'DAY'.freeze
-      TOTAL = 'TOTAL'.freeze
+      HOUR  = 'HOUR'
+      DAY   = 'DAY'
+      TOTAL = 'TOTAL'
     end
 
     module AgeBucket
-      AGE_13_TO_24 = 'AGE_13_TO_24'.freeze
-      AGE_13_TO_34 = 'AGE_13_TO_34'.freeze
-      AGE_13_TO_49 = 'AGE_13_TO_49'.freeze
-      AGE_13_TO_54 = 'AGE_13_TO_54'.freeze
-      AGE_OVER_13  = 'AGE_OVER_13'.freeze
-      AGE_18_TO_34 = 'AGE_18_TO_34'.freeze
-      AGE_18_TO_49 = 'AGE_18_TO_49'.freeze
-      AGE_18_TO_54 = 'AGE_18_TO_54'.freeze
-      AGE_OVER_18  = 'AGE_OVER_18'.freeze
-      AGE_21_TO_34 = 'AGE_21_TO_34'.freeze
-      AGE_21_TO_49 = 'AGE_21_TO_49'.freeze
-      AGE_21_TO_54 = 'AGE_21_TO_54'.freeze
-      AGE_OVER_21  = 'AGE_OVER_21'.freeze
-      AGE_25_TO_49 = 'AGE_25_TO_49'.freeze
-      AGE_25_TO_54 = 'AGE_25_TO_54'.freeze
-      AGE_OVER_25  = 'AGE_OVER_25'.freeze
-      AGE_35_TO_49 = 'AGE_35_TO_49'.freeze
-      AGE_35_TO_54 = 'AGE_35_TO_54'.freeze
-      AGE_OVER_35  = 'AGE_OVER_35'.freeze
-      AGE_OVER_50  = 'AGE_OVER_50'.freeze
+      AGE_13_TO_24 = 'AGE_13_TO_24'
+      AGE_13_TO_34 = 'AGE_13_TO_34'
+      AGE_13_TO_49 = 'AGE_13_TO_49'
+      AGE_13_TO_54 = 'AGE_13_TO_54'
+      AGE_OVER_13  = 'AGE_OVER_13'
+      AGE_18_TO_34 = 'AGE_18_TO_34'
+      AGE_18_TO_49 = 'AGE_18_TO_49'
+      AGE_18_TO_54 = 'AGE_18_TO_54'
+      AGE_OVER_18  = 'AGE_OVER_18'
+      AGE_21_TO_34 = 'AGE_21_TO_34'
+      AGE_21_TO_49 = 'AGE_21_TO_49'
+      AGE_21_TO_54 = 'AGE_21_TO_54'
+      AGE_OVER_21  = 'AGE_OVER_21'
+      AGE_25_TO_49 = 'AGE_25_TO_49'
+      AGE_25_TO_54 = 'AGE_25_TO_54'
+      AGE_OVER_25  = 'AGE_OVER_25'
+      AGE_35_TO_49 = 'AGE_35_TO_49'
+      AGE_35_TO_54 = 'AGE_35_TO_54'
+      AGE_OVER_35  = 'AGE_OVER_35'
+      AGE_OVER_50  = 'AGE_OVER_50'
     end
 
     module Events
-      MUSIC_AND_ENTERTAINMENT = 'MUSIC_AND_ENTERTAINMENT'.freeze
-      SPORTS                  = 'SPORTS'.freeze
-      HOLIDAY                 = 'HOLIDAY'.freeze
-      CONFERENCE              = 'CONFERENCE'.freeze
-      OTHER                   = 'OTHER'.freeze
+      MUSIC_AND_ENTERTAINMENT = 'MUSIC_AND_ENTERTAINMENT'
+      SPORTS                  = 'SPORTS'
+      HOLIDAY                 = 'HOLIDAY'
+      CONFERENCE              = 'CONFERENCE'
+      OTHER                   = 'OTHER'
     end
 
     module Sentiment
-      ALL = 'ALL'.freeze
-      POSITIVE_ONLY = 'POSITIVE_ONLY'.freeze
+      ALL = 'ALL'
+      POSITIVE_ONLY = 'POSITIVE_ONLY'
     end
 
     module TAListTypes
-      EMAIL        = 'EMAIL'.freeze
-      DEVICE_ID    = 'DEVICE_ID'.freeze
-      TWITTER_ID   = 'TWITTER_ID'.freeze
-      HANDLE       = 'HANDLE'.freeze
-      PHONE_NUMBER = 'PHONE_NUMBER'.freeze
+      EMAIL        = 'EMAIL'
+      DEVICE_ID    = 'DEVICE_ID'
+      TWITTER_ID   = 'TWITTER_ID'
+      HANDLE       = 'HANDLE'
+      PHONE_NUMBER = 'PHONE_NUMBER'
     end
 
     module TAOperations
-      ADD = 'ADD'.freeze
-      REMOVE  = 'REMOVE'.freeze
-      REPLACE = 'REPLACE'.freeze
+      ADD = 'ADD'
+      REMOVE  = 'REMOVE'
+      REPLACE = 'REPLACE'
     end
 
     module PermissionLevel
-      READ_ONLY = 'READ_ONLY'.freeze
-      READ_WRITE = 'READ_WRITE'.freeze
+      READ_ONLY = 'READ_ONLY'
+      READ_WRITE = 'READ_WRITE'
     end
 
     module TrackingPartner
-      DOUBLE_CLICK = 'DOUBLE_CLICK'.freeze
+      DOUBLE_CLICK = 'DOUBLE_CLICK'
     end
 
     module ConversationType
-      EVENT = 'EVENT'.freeze
-      HANDLE = 'HANDLE'.freeze
-      HASHTAG = 'HASHTAG'.freeze
+      EVENT = 'EVENT'
+      HANDLE = 'HANDLE'
+      HASHTAG = 'HASHTAG'
     end
 
     module AudienceDefinition
-      TARGETING_CRITERIA = 'TARGETING_CRITERIA'.freeze
-      KEYWORD_AUDIENCE = 'KEYWORD_AUDIENCE'.freeze
+      TARGETING_CRITERIA = 'TARGETING_CRITERIA'
+      KEYWORD_AUDIENCE = 'KEYWORD_AUDIENCE'
     end
 
     module LookalikeExpansion
-      DEFINED = 'DEFINED'.freeze
-      EXPANDED = 'EXPANDED'.freeze
+      DEFINED = 'DEFINED'
+      EXPANDED = 'EXPANDED'
+    end
+
+    module TweetType
+      DRAFT = 'DRAFT'
+      PUBLISHED = 'PUBLISHED'
+      SCHEDULED = 'SCHEDULED'
     end
   end
 end