Class: TheTradeDeskAds::AdFormat

Inherits:
Base
  • Object
show all
Defined in:
lib/the_trade_desk_ads/ad_format.rb

Overview

An ad belongs to an ad set. It is created using an ad creative. developers.facebook.com/docs/marketing-api/reference/adgroup

Constant Summary collapse

FIELDS = 
%w[AdFormatId AdFormatName Width Height IsDisplayRTBEligible IsFacebookRightHandSideEligible IsFacebookPagePostEligible].freeze
SORTING_FIELDS =

Sorting Formats: name, display name

{"Name": "Name"}

Class Method Summary collapse

Methods inherited from Base

auth, delete, #destroy, find, get, paginate, post, #save, #update

Class Method Details

.all(sort_fields: nil, page_start_index: 0, page_size: nil) ⇒ Object 



15
16
17
18
19
20
21
22
 
# File 'lib/the_trade_desk_ads/ad_format.rb', line 15

def all(sort_fields: nil,page_start_index: 0, page_size: nil )
  query = {"SortFields": sort_fields,
           "PageStartIndex": page_start_index,
           "PageSize": page_size
           }
  # query.delete_if { |_k, v| v.nil? }
  post('adformat/query', query: query, objectify: true)
end

.facets(query = {}) ⇒ Object 



11
12
13
 
# File 'lib/the_trade_desk_ads/ad_format.rb', line 11

def facets(query = {})
  get('adformat/query/facets', query: query, objectify: false)
end

.search(search_terms: nil, sort_fields: nil, page_start_index: 0, page_size: 10) ⇒ Object

Search term example ad_formats = TheTradeDeskAds::AdFormat.search(search_terms: [“banner”]) Sorting example ad_formats = TheTradeDeskAds::AdFormat.search(sort_fields: [“Name”,“Ascending”: true])



29
30
31
32
33
34
35
36
37
 
# File 'lib/the_trade_desk_ads/ad_format.rb', line 29

def search(search_terms: nil, sort_fields: nil, page_start_index: 0, page_size: 10)
  query = {"SearchTerms": search_terms,
           "SortFields": sort_fields,
           "PageStartIndex": page_start_index,
           "PageSize": page_size
           }
  query.delete_if { |_k, v| v.nil? }
  post('adformat/query', query: query, objectify: true)
end