Class: BingAdsApi::ReportRequestStatus

Inherits:
DataObject
  • Object
show all
Defined in:
lib/bing-ads-api/data/report_request_status.rb

Overview

Public : Defines the status of a report request.

Reference: msdn.microsoft.com/en-US/library/bing-ads-reporting-bing-ads-reportrequeststatus.aspx

Author

[email protected]

Constant Summary collapse

REQUEST_STATUS =

Valid report request status for reports

BingAdsApi::Config.instance.
reporting_constants['request_status_type']

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DataObject

#initialize, #to_s

Methods included from SOAPHasheable

#date_to_hash, #get_attribute_key, #normalize_hash_keys, #object_to_hash, #to_hash

Constructor Details

This class inherits a constructor from BingAdsApi::DataObject

Instance Attribute Details

#report_download_url ⇒ Object

Returns the value of attribute report_download_url.



17
18
19
 
# File 'lib/bing-ads-api/data/report_request_status.rb', line 17

def report_download_url
  @report_download_url
end

#status ⇒ Object

Returns the value of attribute status.



17
18
19
 
# File 'lib/bing-ads-api/data/report_request_status.rb', line 17

def status
  @status
end

Instance Method Details

#error? ⇒ Boolean

Public

Returns true if the status is error

Author

[email protected]

Returns

boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/bing-ads-api/data/report_request_status.rb', line 42

def error?
	return status == REQUEST_STATUS['error']
end

#pending? ⇒ Boolean

Public

Returns true if the status is pending

Author

[email protected]

Returns

boolean

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/bing-ads-api/data/report_request_status.rb', line 33

def pending?
	return status == REQUEST_STATUS['pending']
end

#success? ⇒ Boolean

Public

Returns true if the status is success

Author

[email protected]

Returns

boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/bing-ads-api/data/report_request_status.rb', line 24

def success?
	return status == REQUEST_STATUS['success']
end