Class: Google::Apis::YoutubeV3::SponsorListResponse

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

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) ⇒ SponsorListResponse

Returns a new instance of SponsorListResponse.



6646
6647
6648
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6646

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

Instance Attribute Details

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


6606
6607
6608
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6606

def etag
  @etag
end

#event_id ⇒ String

Serialized EventId of the request which produced this response. Corresponds to the JSON property eventId

Returns:

  • (String) 


6611
6612
6613
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6611

def event_id
  @event_id
end

#items ⇒ Array<Google::Apis::YoutubeV3::Sponsor>

A list of sponsors that match the request criteria. Corresponds to the JSON property items

Returns:



6616
6617
6618
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6616

def items
  @items
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "youtube# sponsorListResponse". Corresponds to the JSON property kind

Returns:

  • (String) 


6622
6623
6624
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6622

def kind
  @kind
end

#next_page_token ⇒ String

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


6628
6629
6630
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6628

def next_page_token
  @next_page_token
end

#page_info ⇒ Google::Apis::YoutubeV3::PageInfo

Paging details for lists of resources, including total number of items available and number of resources returned in a single page. Corresponds to the JSON property pageInfo

Returns:



6634
6635
6636
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6634

def page_info
  @page_info
end

#token_pagination ⇒ Google::Apis::YoutubeV3::TokenPagination

Stub token pagination template to suppress results. Corresponds to the JSON property tokenPagination

Returns:



6639
6640
6641
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6639

def token_pagination
  @token_pagination
end

#visitor_id ⇒ String

The visitorId identifies the visitor. Corresponds to the JSON property visitorId

Returns:

  • (String) 


6644
6645
6646
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6644

def visitor_id
  @visitor_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6651

def update!(**args)
  @etag = args[:etag] if args.key?(:etag)
  @event_id = args[:event_id] if args.key?(:event_id)
  @items = args[:items] if args.key?(:items)
  @kind = args[:kind] if args.key?(:kind)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @page_info = args[:page_info] if args.key?(:page_info)
  @token_pagination = args[:token_pagination] if args.key?(:token_pagination)
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
end