Class: Zernio::ReachAndFrequencyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zernio-sdk/api/reach_and_frequency_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReachAndFrequencyApi

Returns a new instance of ReachAndFrequencyApi.



19
20
21
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_rf_reservation(prediction_id, account_id, ad_account_id, opts = {}) ⇒ nil

Cancel a Reach & Frequency reservation Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.

Parameters:

  • prediction_id (String)
  • account_id (String)
  • ad_account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 29

def cancel_rf_reservation(prediction_id, , , opts = {})
  cancel_rf_reservation_with_http_info(prediction_id, , , opts)
  nil
end

#cancel_rf_reservation_with_http_info(prediction_id, account_id, ad_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Cancel a Reach & Frequency reservation Releases a RESERVATION's locked price and inventory. Unreserved predictions expire on their own.

Parameters:

  • prediction_id (String)
  • account_id (String)
  • ad_account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



41
42
43
44
45
46
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 41

def cancel_rf_reservation_with_http_info(prediction_id, , , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReachAndFrequencyApi.cancel_rf_reservation ...'
  end
  # verify the required parameter 'prediction_id' is set
  if @api_client.config.client_side_validation && prediction_id.nil?
    fail ArgumentError, "Missing the required parameter 'prediction_id' when calling ReachAndFrequencyApi.cancel_rf_reservation"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ReachAndFrequencyApi.cancel_rf_reservation"
  end
  # verify the required parameter 'ad_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling ReachAndFrequencyApi.cancel_rf_reservation"
  end
  # resource path
  local_var_path = '/v1/ads/rf-predictions/{predictionId}'.sub('{' + 'predictionId' + '}', CGI.escape(prediction_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = 
  query_params[:'adAccountId'] = 

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ReachAndFrequencyApi.cancel_rf_reservation",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReachAndFrequencyApi#cancel_rf_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_rf_prediction(create_rf_prediction_request, opts = {}) ⇒ CreateRfPrediction201Response

Create a Reach & Frequency prediction Creates an R&F prediction — a QUOTE, nothing is bought and no ad entities are created. Provide a date range plus exactly one of budgetAmount (Meta predicts reach) or reach (Meta predicts the budget). The response carries the estimate and its allowed bounds (min/max budget and reach). Predictions expire on their own; to buy, reserve one via POST /v1/ads/rf-predictions/predictionId/reserve and pass the RESERVED id to POST /v1/ads/create with buyingType: \"RESERVED\". Reservation campaigns reject automatic placements, so omitted placements default to Facebook feed (+ Instagram stream when a linked IG professional account resolves); Instagram placements require that IG account.

Parameters:

Returns:



104
105
106
107
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 104

def create_rf_prediction(create_rf_prediction_request, opts = {})
  data, _status_code, _headers = create_rf_prediction_with_http_info(create_rf_prediction_request, opts)
  data
end

#create_rf_prediction_with_http_info(create_rf_prediction_request, opts = {}) ⇒ Array<(CreateRfPrediction201Response, Integer, Hash)>

Create a Reach & Frequency prediction Creates an R&F prediction — a QUOTE, nothing is bought and no ad entities are created. Provide a date range plus exactly one of `budgetAmount` (Meta predicts reach) or `reach` (Meta predicts the budget). The response carries the estimate and its allowed bounds (min/max budget and reach). Predictions expire on their own; to buy, reserve one via POST /v1/ads/rf-predictions/predictionId/reserve and pass the RESERVED id to POST /v1/ads/create with `buyingType: &quot;RESERVED&quot;`. Reservation campaigns reject automatic placements, so omitted `placements` default to Facebook feed (+ Instagram stream when a linked IG professional account resolves); Instagram placements require that IG account.

Parameters:

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 114

def create_rf_prediction_with_http_info(create_rf_prediction_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReachAndFrequencyApi.create_rf_prediction ...'
  end
  # verify the required parameter 'create_rf_prediction_request' is set
  if @api_client.config.client_side_validation && create_rf_prediction_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_rf_prediction_request' when calling ReachAndFrequencyApi.create_rf_prediction"
  end
  # resource path
  local_var_path = '/v1/ads/rf-predictions'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_rf_prediction_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateRfPrediction201Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ReachAndFrequencyApi.create_rf_prediction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReachAndFrequencyApi#create_rf_prediction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rf_prediction(prediction_id, account_id, ad_account_id, opts = {}) ⇒ CreateRfPrediction201Response

Read a Reach & Frequency prediction

Parameters:

  • prediction_id (String)
  • account_id (String)
  • ad_account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



173
174
175
176
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 173

def get_rf_prediction(prediction_id, , , opts = {})
  data, _status_code, _headers = get_rf_prediction_with_http_info(prediction_id, , , opts)
  data
end

#get_rf_prediction_with_http_info(prediction_id, account_id, ad_account_id, opts = {}) ⇒ Array<(CreateRfPrediction201Response, Integer, Hash)>

Read a Reach & Frequency prediction

Parameters:

  • prediction_id (String)
  • account_id (String)
  • ad_account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 184

def get_rf_prediction_with_http_info(prediction_id, , , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReachAndFrequencyApi.get_rf_prediction ...'
  end
  # verify the required parameter 'prediction_id' is set
  if @api_client.config.client_side_validation && prediction_id.nil?
    fail ArgumentError, "Missing the required parameter 'prediction_id' when calling ReachAndFrequencyApi.get_rf_prediction"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ReachAndFrequencyApi.get_rf_prediction"
  end
  # verify the required parameter 'ad_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling ReachAndFrequencyApi.get_rf_prediction"
  end
  # resource path
  local_var_path = '/v1/ads/rf-predictions/{predictionId}'.sub('{' + 'predictionId' + '}', CGI.escape(prediction_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = 
  query_params[:'adAccountId'] = 

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreateRfPrediction201Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ReachAndFrequencyApi.get_rf_prediction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReachAndFrequencyApi#get_rf_prediction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reserve_rf_prediction(prediction_id, reserve_rf_prediction_request, opts = {}) ⇒ ReserveRfPrediction201Response

Reserve a Reach & Frequency prediction Locks the quoted price + inventory until the returned expiresAt and mints a NEW prediction id — pass that RESERVED id (not the original) as rfPredictionId on POST /v1/ads/create. Release an unused reservation via DELETE.

Parameters:

  • prediction_id (String)
  • reserve_rf_prediction_request (ReserveRfPredictionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



248
249
250
251
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 248

def reserve_rf_prediction(prediction_id, reserve_rf_prediction_request, opts = {})
  data, _status_code, _headers = reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request, opts)
  data
end

#reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request, opts = {}) ⇒ Array<(ReserveRfPrediction201Response, Integer, Hash)>

Reserve a Reach & Frequency prediction Locks the quoted price + inventory until the returned `expiresAt` and mints a NEW prediction id — pass that RESERVED id (not the original) as `rfPredictionId` on POST /v1/ads/create. Release an unused reservation via DELETE.

Parameters:

  • prediction_id (String)
  • reserve_rf_prediction_request (ReserveRfPredictionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/zernio-sdk/api/reach_and_frequency_api.rb', line 259

def reserve_rf_prediction_with_http_info(prediction_id, reserve_rf_prediction_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReachAndFrequencyApi.reserve_rf_prediction ...'
  end
  # verify the required parameter 'prediction_id' is set
  if @api_client.config.client_side_validation && prediction_id.nil?
    fail ArgumentError, "Missing the required parameter 'prediction_id' when calling ReachAndFrequencyApi.reserve_rf_prediction"
  end
  # verify the required parameter 'reserve_rf_prediction_request' is set
  if @api_client.config.client_side_validation && reserve_rf_prediction_request.nil?
    fail ArgumentError, "Missing the required parameter 'reserve_rf_prediction_request' when calling ReachAndFrequencyApi.reserve_rf_prediction"
  end
  # resource path
  local_var_path = '/v1/ads/rf-predictions/{predictionId}/reserve'.sub('{' + 'predictionId' + '}', CGI.escape(prediction_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(reserve_rf_prediction_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ReserveRfPrediction201Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ReachAndFrequencyApi.reserve_rf_prediction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReachAndFrequencyApi#reserve_rf_prediction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end