Class: MailchimpMarketing::FacebookAdsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpMarketing/api/facebook_ads_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ FacebookAdsApi

Returns a new instance of FacebookAdsApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/facebook_ads_api.rb', line 19

def initialize(api_client)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/MailchimpMarketing/api/facebook_ads_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_ad(outreach_id = {}, opts = {}) ⇒ InlineResponse20010

__summary__ Get details of a facebook ad

Parameters:

  • outreach_id (defaults to: {}) —

    The outreach id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Returns:

  • (InlineResponse20010) 


89
90
91
92
 
# File 'lib/MailchimpMarketing/api/facebook_ads_api.rb', line 89

def get_ad(outreach_id = {}, opts = {})
  data, _status_code, _headers = get_ad_with_http_info(outreach_id, opts)
  data
end

#get_ad_with_http_info(outreach_id, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

__summary__ Get details of a facebook ad

Parameters:

  • outreach_id —

    The outreach id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Returns:

  • (Array<(InlineResponse20010, Fixnum, Hash)>) —

    InlineResponse20010 data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/MailchimpMarketing/api/facebook_ads_api.rb', line 101

def get_ad_with_http_info(outreach_id, opts = {})
  # resource path
  local_var_path = '/facebook-ads/{outreach_id}'.sub('{' + 'outreach_id' + '}', outreach_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20010')
  return data, status_code, headers
end

#list(opts = {}) ⇒ InlineResponse2009

__summary__ Get list of Facebook Ads

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

  • :count (Integer) —

    The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 10. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 1000 (default to 10)

  • :offset (Integer) —

    The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 0. (default to 0)

  • :sort_field (String) —

    Returns files sorted by the specified field.

  • :sort_dir (String) —

    Determines the order direction for sorted results.

Returns:

  • (InlineResponse2009) 


32
33
34
35
 
# File 'lib/MailchimpMarketing/api/facebook_ads_api.rb', line 32

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>

__summary__ Get list of Facebook Ads

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

  • :count (Integer) —

    The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 10. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 1000

  • :offset (Integer) —

    The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is 0.

  • :sort_field (String) —

    Returns files sorted by the specified field.

  • :sort_dir (String) —

    Determines the order direction for sorted results.

Returns:

  • (Array<(InlineResponse2009, Fixnum, Hash)>) —

    InlineResponse2009 data, response status code and response headers



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/MailchimpMarketing/api/facebook_ads_api.rb', line 47

def list_with_http_info(opts = {})
  # resource path
  local_var_path = '/facebook-ads'

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_field'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2009')
  return data, status_code, headers
end