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


6242
6243
6244
# File 'generated/google/apis/youtube_v3/classes.rb', line 6242

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

Instance Attribute Details

#etagString

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String)

6202
6203
6204
# File 'generated/google/apis/youtube_v3/classes.rb', line 6202

def etag
  @etag
end

#event_idString

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

Returns:

  • (String)

6207
6208
6209
# File 'generated/google/apis/youtube_v3/classes.rb', line 6207

def event_id
  @event_id
end

#itemsArray<Google::Apis::YoutubeV3::Sponsor>

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


6212
6213
6214
# File 'generated/google/apis/youtube_v3/classes.rb', line 6212

def items
  @items
end

#kindString

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

Returns:

  • (String)

6218
6219
6220
# File 'generated/google/apis/youtube_v3/classes.rb', line 6218

def kind
  @kind
end

#next_page_tokenString

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)

6224
6225
6226
# File 'generated/google/apis/youtube_v3/classes.rb', line 6224

def next_page_token
  @next_page_token
end

#page_infoGoogle::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


6230
6231
6232
# File 'generated/google/apis/youtube_v3/classes.rb', line 6230

def page_info
  @page_info
end

#token_paginationGoogle::Apis::YoutubeV3::TokenPagination

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


6235
6236
6237
# File 'generated/google/apis/youtube_v3/classes.rb', line 6235

def token_pagination
  @token_pagination
end

#visitor_idString

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

Returns:

  • (String)

6240
6241
6242
# File 'generated/google/apis/youtube_v3/classes.rb', line 6240

def visitor_id
  @visitor_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
# File 'generated/google/apis/youtube_v3/classes.rb', line 6247

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