Class: Google::Apis::PartnersV2::ListOffersHistoryResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/partners_v2/classes.rb,
generated/google/apis/partners_v2/representations.rb,
generated/google/apis/partners_v2/representations.rb

Overview

Response for ListOfferHistory.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ListOffersHistoryResponse

Returns a new instance of ListOffersHistoryResponse



2235
2236
2237
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2235

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#can_show_entire_company ⇒ Boolean Also known as: can_show_entire_company?

True if the user has the option to show entire company history. Corresponds to the JSON property canShowEntireCompany

Returns:

  • (Boolean) 


2206
2207
2208
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2206

def can_show_entire_company
  @can_show_entire_company
end

#next_page_token ⇒ String

Supply this token in a ListOffersHistoryRequest to retrieve the next page. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


2228
2229
2230
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2228

def next_page_token
  @next_page_token
end

#offers ⇒ Array<Google::Apis::PartnersV2::HistoricalOffer>

Historical offers meeting request. Corresponds to the JSON property offers

Returns:



2223
2224
2225
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2223

def offers
  @offers
end

#response_metadata ⇒ Google::Apis::PartnersV2::ResponseMetadata

Common data that is in each API response. Corresponds to the JSON property responseMetadata

Returns:



2233
2234
2235
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2233

def response_metadata
  @response_metadata
end

#showing_entire_company ⇒ Boolean Also known as: showing_entire_company?

True if this response is showing entire company history. Corresponds to the JSON property showingEntireCompany

Returns:

  • (Boolean) 


2217
2218
2219
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2217

def showing_entire_company
  @showing_entire_company
end

#total_results ⇒ Fixnum

Number of results across all pages. Corresponds to the JSON property totalResults

Returns:

  • (Fixnum) 


2212
2213
2214
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2212

def total_results
  @total_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2240
2241
2242
2243
2244
2245
2246
2247
 
# File 'generated/google/apis/partners_v2/classes.rb', line 2240

def update!(**args)
  @can_show_entire_company = args[:can_show_entire_company] if args.key?(:can_show_entire_company)
  @total_results = args[:total_results] if args.key?(:total_results)
  @showing_entire_company = args[:showing_entire_company] if args.key?(:showing_entire_company)
  @offers = args[:offers] if args.key?(:offers)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @response_metadata = args[:response_metadata] if args.key?(:response_metadata)
end