Class: Google::Apis::YoutubeV3::ImageSettings

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

Overview

Branding properties for images associated with the channel.

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

Returns a new instance of ImageSettings



3268
3269
3270
# File 'generated/google/apis/youtube_v3/classes.rb', line 3268

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

Instance Attribute Details

#background_image_urlGoogle::Apis::YoutubeV3::LocalizedProperty

The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k. Corresponds to the JSON property backgroundImageUrl



3155
3156
3157
# File 'generated/google/apis/youtube_v3/classes.rb', line 3155

def background_image_url
  @background_image_url
end

This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs. Corresponds to the JSON property bannerExternalUrl

Returns:

  • (String)


3161
3162
3163
# File 'generated/google/apis/youtube_v3/classes.rb', line 3161

def banner_external_url
  @banner_external_url
end

Banner image. Desktop size (1060x175). Corresponds to the JSON property bannerImageUrl

Returns:

  • (String)


3166
3167
3168
# File 'generated/google/apis/youtube_v3/classes.rb', line 3166

def banner_image_url
  @banner_image_url
end

Banner image. Mobile size high resolution (1440x395). Corresponds to the JSON property bannerMobileExtraHdImageUrl

Returns:

  • (String)


3171
3172
3173
# File 'generated/google/apis/youtube_v3/classes.rb', line 3171

def banner_mobile_extra_hd_image_url
  @banner_mobile_extra_hd_image_url
end

Banner image. Mobile size high resolution (1280x360). Corresponds to the JSON property bannerMobileHdImageUrl

Returns:

  • (String)


3176
3177
3178
# File 'generated/google/apis/youtube_v3/classes.rb', line 3176

def banner_mobile_hd_image_url
  @banner_mobile_hd_image_url
end

Banner image. Mobile size (640x175). Corresponds to the JSON property bannerMobileImageUrl

Returns:

  • (String)


3181
3182
3183
# File 'generated/google/apis/youtube_v3/classes.rb', line 3181

def banner_mobile_image_url
  @banner_mobile_image_url
end

Banner image. Mobile size low resolution (320x88). Corresponds to the JSON property bannerMobileLowImageUrl

Returns:

  • (String)


3186
3187
3188
# File 'generated/google/apis/youtube_v3/classes.rb', line 3186

def banner_mobile_low_image_url
  @banner_mobile_low_image_url
end

Banner image. Mobile size medium/high resolution (960x263). Corresponds to the JSON property bannerMobileMediumHdImageUrl

Returns:

  • (String)


3191
3192
3193
# File 'generated/google/apis/youtube_v3/classes.rb', line 3191

def banner_mobile_medium_hd_image_url
  @banner_mobile_medium_hd_image_url
end

Banner image. Tablet size extra high resolution (2560x424). Corresponds to the JSON property bannerTabletExtraHdImageUrl

Returns:

  • (String)


3196
3197
3198
# File 'generated/google/apis/youtube_v3/classes.rb', line 3196

def banner_tablet_extra_hd_image_url
  @banner_tablet_extra_hd_image_url
end

Banner image. Tablet size high resolution (2276x377). Corresponds to the JSON property bannerTabletHdImageUrl

Returns:

  • (String)


3201
3202
3203
# File 'generated/google/apis/youtube_v3/classes.rb', line 3201

def banner_tablet_hd_image_url
  @banner_tablet_hd_image_url
end

Banner image. Tablet size (1707x283). Corresponds to the JSON property bannerTabletImageUrl

Returns:

  • (String)


3206
3207
3208
# File 'generated/google/apis/youtube_v3/classes.rb', line 3206

def banner_tablet_image_url
  @banner_tablet_image_url
end

Banner image. Tablet size low resolution (1138x188). Corresponds to the JSON property bannerTabletLowImageUrl

Returns:

  • (String)


3211
3212
3213
# File 'generated/google/apis/youtube_v3/classes.rb', line 3211

def banner_tablet_low_image_url
  @banner_tablet_low_image_url
end

Banner image. TV size high resolution (1920x1080). Corresponds to the JSON property bannerTvHighImageUrl

Returns:

  • (String)


3216
3217
3218
# File 'generated/google/apis/youtube_v3/classes.rb', line 3216

def banner_tv_high_image_url
  @banner_tv_high_image_url
end

Banner image. TV size extra high resolution (2120x1192). Corresponds to the JSON property bannerTvImageUrl

Returns:

  • (String)


3221
3222
3223
# File 'generated/google/apis/youtube_v3/classes.rb', line 3221

def banner_tv_image_url
  @banner_tv_image_url
end

Banner image. TV size low resolution (854x480). Corresponds to the JSON property bannerTvLowImageUrl

Returns:

  • (String)


3226
3227
3228
# File 'generated/google/apis/youtube_v3/classes.rb', line 3226

def banner_tv_low_image_url
  @banner_tv_low_image_url
end

Banner image. TV size medium resolution (1280x720). Corresponds to the JSON property bannerTvMediumImageUrl

Returns:

  • (String)


3231
3232
3233
# File 'generated/google/apis/youtube_v3/classes.rb', line 3231

def banner_tv_medium_image_url
  @banner_tv_medium_image_url
end

#large_branded_banner_image_imap_scriptGoogle::Apis::YoutubeV3::LocalizedProperty

The image map script for the large banner image. Corresponds to the JSON property largeBrandedBannerImageImapScript



3236
3237
3238
# File 'generated/google/apis/youtube_v3/classes.rb', line 3236

def large_branded_banner_image_imap_script
  @large_branded_banner_image_imap_script
end

#large_branded_banner_image_urlGoogle::Apis::YoutubeV3::LocalizedProperty

The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page. Corresponds to the JSON property largeBrandedBannerImageUrl



3242
3243
3244
# File 'generated/google/apis/youtube_v3/classes.rb', line 3242

def large_branded_banner_image_url
  @large_branded_banner_image_url
end

#small_branded_banner_image_imap_scriptGoogle::Apis::YoutubeV3::LocalizedProperty

The image map script for the small banner image. Corresponds to the JSON property smallBrandedBannerImageImapScript



3247
3248
3249
# File 'generated/google/apis/youtube_v3/classes.rb', line 3247

def small_branded_banner_image_imap_script
  @small_branded_banner_image_imap_script
end

#small_branded_banner_image_urlGoogle::Apis::YoutubeV3::LocalizedProperty

The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. Corresponds to the JSON property smallBrandedBannerImageUrl



3253
3254
3255
# File 'generated/google/apis/youtube_v3/classes.rb', line 3253

def small_branded_banner_image_url
  @small_branded_banner_image_url
end

#tracking_image_urlString

The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages. Corresponds to the JSON property trackingImageUrl

Returns:

  • (String)


3259
3260
3261
# File 'generated/google/apis/youtube_v3/classes.rb', line 3259

def tracking_image_url
  @tracking_image_url
end

#watch_icon_image_urlString

The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels. Corresponds to the JSON property watchIconImageUrl

Returns:

  • (String)


3266
3267
3268
# File 'generated/google/apis/youtube_v3/classes.rb', line 3266

def watch_icon_image_url
  @watch_icon_image_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
# File 'generated/google/apis/youtube_v3/classes.rb', line 3273

def update!(**args)
  @background_image_url = args[:background_image_url] if args.key?(:background_image_url)
  @banner_external_url = args[:banner_external_url] if args.key?(:banner_external_url)
  @banner_image_url = args[:banner_image_url] if args.key?(:banner_image_url)
  @banner_mobile_extra_hd_image_url = args[:banner_mobile_extra_hd_image_url] if args.key?(:banner_mobile_extra_hd_image_url)
  @banner_mobile_hd_image_url = args[:banner_mobile_hd_image_url] if args.key?(:banner_mobile_hd_image_url)
  @banner_mobile_image_url = args[:banner_mobile_image_url] if args.key?(:banner_mobile_image_url)
  @banner_mobile_low_image_url = args[:banner_mobile_low_image_url] if args.key?(:banner_mobile_low_image_url)
  @banner_mobile_medium_hd_image_url = args[:banner_mobile_medium_hd_image_url] if args.key?(:banner_mobile_medium_hd_image_url)
  @banner_tablet_extra_hd_image_url = args[:banner_tablet_extra_hd_image_url] if args.key?(:banner_tablet_extra_hd_image_url)
  @banner_tablet_hd_image_url = args[:banner_tablet_hd_image_url] if args.key?(:banner_tablet_hd_image_url)
  @banner_tablet_image_url = args[:banner_tablet_image_url] if args.key?(:banner_tablet_image_url)
  @banner_tablet_low_image_url = args[:banner_tablet_low_image_url] if args.key?(:banner_tablet_low_image_url)
  @banner_tv_high_image_url = args[:banner_tv_high_image_url] if args.key?(:banner_tv_high_image_url)
  @banner_tv_image_url = args[:banner_tv_image_url] if args.key?(:banner_tv_image_url)
  @banner_tv_low_image_url = args[:banner_tv_low_image_url] if args.key?(:banner_tv_low_image_url)
  @banner_tv_medium_image_url = args[:banner_tv_medium_image_url] if args.key?(:banner_tv_medium_image_url)
  @large_branded_banner_image_imap_script = args[:large_branded_banner_image_imap_script] if args.key?(:large_branded_banner_image_imap_script)
  @large_branded_banner_image_url = args[:large_branded_banner_image_url] if args.key?(:large_branded_banner_image_url)
  @small_branded_banner_image_imap_script = args[:small_branded_banner_image_imap_script] if args.key?(:small_branded_banner_image_imap_script)
  @small_branded_banner_image_url = args[:small_branded_banner_image_url] if args.key?(:small_branded_banner_image_url)
  @tracking_image_url = args[:tracking_image_url] if args.key?(:tracking_image_url)
  @watch_icon_image_url = args[:watch_icon_image_url] if args.key?(:watch_icon_image_url)
end