ImageSettings (YouTube Data API v3 v3-rev20201202-1.31.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.youtube.model.ImageSettings

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class ImageSettings
extends GenericJson
```
Branding properties for images associated with the channel.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the YouTube Data API v3. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ImageSettings()

Constructors
Constructor and Description
`ImageSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImageSettings`	`clone()`
`LocalizedProperty`	`getBackgroundImageUrl()` The URL for the background image shown on the video watch page.
`String`	`getBannerExternalUrl()` This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
`String`	`getBannerImageUrl()` Banner image.
`String`	`getBannerMobileExtraHdImageUrl()` Banner image.
`String`	`getBannerMobileHdImageUrl()` Banner image.
`String`	`getBannerMobileImageUrl()` Banner image.
`String`	`getBannerMobileLowImageUrl()` Banner image.
`String`	`getBannerMobileMediumHdImageUrl()` Banner image.
`String`	`getBannerTabletExtraHdImageUrl()` Banner image.
`String`	`getBannerTabletHdImageUrl()` Banner image.
`String`	`getBannerTabletImageUrl()` Banner image.
`String`	`getBannerTabletLowImageUrl()` Banner image.
`String`	`getBannerTvHighImageUrl()` Banner image.
`String`	`getBannerTvImageUrl()` Banner image.
`String`	`getBannerTvLowImageUrl()` Banner image.
`String`	`getBannerTvMediumImageUrl()` Banner image.
`LocalizedProperty`	`getLargeBrandedBannerImageImapScript()` The image map script for the large banner image.
`LocalizedProperty`	`getLargeBrandedBannerImageUrl()` The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
`LocalizedProperty`	`getSmallBrandedBannerImageImapScript()` The image map script for the small banner image.
`LocalizedProperty`	`getSmallBrandedBannerImageUrl()` The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
`String`	`getTrackingImageUrl()` The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
`String`	`getWatchIconImageUrl()`
`ImageSettings`	`set(String fieldName, Object value)`
`ImageSettings`	`setBackgroundImageUrl(LocalizedProperty backgroundImageUrl)` The URL for the background image shown on the video watch page.
`ImageSettings`	`setBannerExternalUrl(String bannerExternalUrl)` This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
`ImageSettings`	`setBannerImageUrl(String bannerImageUrl)` Banner image.
`ImageSettings`	`setBannerMobileExtraHdImageUrl(String bannerMobileExtraHdImageUrl)` Banner image.
`ImageSettings`	`setBannerMobileHdImageUrl(String bannerMobileHdImageUrl)` Banner image.
`ImageSettings`	`setBannerMobileImageUrl(String bannerMobileImageUrl)` Banner image.
`ImageSettings`	`setBannerMobileLowImageUrl(String bannerMobileLowImageUrl)` Banner image.
`ImageSettings`	`setBannerMobileMediumHdImageUrl(String bannerMobileMediumHdImageUrl)` Banner image.
`ImageSettings`	`setBannerTabletExtraHdImageUrl(String bannerTabletExtraHdImageUrl)` Banner image.
`ImageSettings`	`setBannerTabletHdImageUrl(String bannerTabletHdImageUrl)` Banner image.
`ImageSettings`	`setBannerTabletImageUrl(String bannerTabletImageUrl)` Banner image.
`ImageSettings`	`setBannerTabletLowImageUrl(String bannerTabletLowImageUrl)` Banner image.
`ImageSettings`	`setBannerTvHighImageUrl(String bannerTvHighImageUrl)` Banner image.
`ImageSettings`	`setBannerTvImageUrl(String bannerTvImageUrl)` Banner image.
`ImageSettings`	`setBannerTvLowImageUrl(String bannerTvLowImageUrl)` Banner image.
`ImageSettings`	`setBannerTvMediumImageUrl(String bannerTvMediumImageUrl)` Banner image.
`ImageSettings`	`setLargeBrandedBannerImageImapScript(LocalizedProperty largeBrandedBannerImageImapScript)` The image map script for the large banner image.
`ImageSettings`	`setLargeBrandedBannerImageUrl(LocalizedProperty largeBrandedBannerImageUrl)` The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
`ImageSettings`	`setSmallBrandedBannerImageImapScript(LocalizedProperty smallBrandedBannerImageImapScript)` The image map script for the small banner image.
`ImageSettings`	`setSmallBrandedBannerImageUrl(LocalizedProperty smallBrandedBannerImageUrl)` The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.
`ImageSettings`	`setTrackingImageUrl(String trackingImageUrl)` The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
`ImageSettings`	`setWatchIconImageUrl(String watchIconImageUrl)`

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ImageSettings
```
public ImageSettings()
```
- Method Detail
  - getBackgroundImageUrl
```
public LocalizedProperty getBackgroundImageUrl()
```
    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.
    
    Returns:
    
    value or null for none
  - setBackgroundImageUrl
```
public ImageSettings setBackgroundImageUrl(LocalizedProperty backgroundImageUrl)
```
    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.
    
    Parameters:
    
    backgroundImageUrl - backgroundImageUrl or null for none
  - getBannerExternalUrl
```
public String getBannerExternalUrl()
```
    This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
    
    Returns:
    
    value or null for none
  - setBannerExternalUrl
```
public ImageSettings setBannerExternalUrl(String bannerExternalUrl)
```
    This is generated when a ChannelBanner.Insert request has succeeded for the given channel.
    
    Parameters:
    
    bannerExternalUrl - bannerExternalUrl or null for none
  - getBannerImageUrl
```
public String getBannerImageUrl()
```
    Banner image. Desktop size (1060x175).
    
    Returns:
    
    value or null for none
  - setBannerImageUrl
```
public ImageSettings setBannerImageUrl(String bannerImageUrl)
```
    Banner image. Desktop size (1060x175).
    
    Parameters:
    
    bannerImageUrl - bannerImageUrl or null for none
  - getBannerMobileExtraHdImageUrl
```
public String getBannerMobileExtraHdImageUrl()
```
    Banner image. Mobile size high resolution (1440x395).
    
    Returns:
    
    value or null for none
  - setBannerMobileExtraHdImageUrl
```
public ImageSettings setBannerMobileExtraHdImageUrl(String bannerMobileExtraHdImageUrl)
```
    Banner image. Mobile size high resolution (1440x395).
    
    Parameters:
    
    bannerMobileExtraHdImageUrl - bannerMobileExtraHdImageUrl or null for none
  - getBannerMobileHdImageUrl
```
public String getBannerMobileHdImageUrl()
```
    Banner image. Mobile size high resolution (1280x360).
    
    Returns:
    
    value or null for none
  - setBannerMobileHdImageUrl
```
public ImageSettings setBannerMobileHdImageUrl(String bannerMobileHdImageUrl)
```
    Banner image. Mobile size high resolution (1280x360).
    
    Parameters:
    
    bannerMobileHdImageUrl - bannerMobileHdImageUrl or null for none
  - getBannerMobileImageUrl
```
public String getBannerMobileImageUrl()
```
    Banner image. Mobile size (640x175).
    
    Returns:
    
    value or null for none
  - setBannerMobileImageUrl
```
public ImageSettings setBannerMobileImageUrl(String bannerMobileImageUrl)
```
    Banner image. Mobile size (640x175).
    
    Parameters:
    
    bannerMobileImageUrl - bannerMobileImageUrl or null for none
  - getBannerMobileLowImageUrl
```
public String getBannerMobileLowImageUrl()
```
    Banner image. Mobile size low resolution (320x88).
    
    Returns:
    
    value or null for none
  - setBannerMobileLowImageUrl
```
public ImageSettings setBannerMobileLowImageUrl(String bannerMobileLowImageUrl)
```
    Banner image. Mobile size low resolution (320x88).
    
    Parameters:
    
    bannerMobileLowImageUrl - bannerMobileLowImageUrl or null for none
  - getBannerMobileMediumHdImageUrl
```
public String getBannerMobileMediumHdImageUrl()
```
    Banner image. Mobile size medium/high resolution (960x263).
    
    Returns:
    
    value or null for none
  - setBannerMobileMediumHdImageUrl
```
public ImageSettings setBannerMobileMediumHdImageUrl(String bannerMobileMediumHdImageUrl)
```
    Banner image. Mobile size medium/high resolution (960x263).
    
    Parameters:
    
    bannerMobileMediumHdImageUrl - bannerMobileMediumHdImageUrl or null for none
  - getBannerTabletExtraHdImageUrl
```
public String getBannerTabletExtraHdImageUrl()
```
    Banner image. Tablet size extra high resolution (2560x424).
    
    Returns:
    
    value or null for none
  - setBannerTabletExtraHdImageUrl
```
public ImageSettings setBannerTabletExtraHdImageUrl(String bannerTabletExtraHdImageUrl)
```
    Banner image. Tablet size extra high resolution (2560x424).
    
    Parameters:
    
    bannerTabletExtraHdImageUrl - bannerTabletExtraHdImageUrl or null for none
  - getBannerTabletHdImageUrl
```
public String getBannerTabletHdImageUrl()
```
    Banner image. Tablet size high resolution (2276x377).
    
    Returns:
    
    value or null for none
  - setBannerTabletHdImageUrl
```
public ImageSettings setBannerTabletHdImageUrl(String bannerTabletHdImageUrl)
```
    Banner image. Tablet size high resolution (2276x377).
    
    Parameters:
    
    bannerTabletHdImageUrl - bannerTabletHdImageUrl or null for none
  - getBannerTabletImageUrl
```
public String getBannerTabletImageUrl()
```
    Banner image. Tablet size (1707x283).
    
    Returns:
    
    value or null for none
  - setBannerTabletImageUrl
```
public ImageSettings setBannerTabletImageUrl(String bannerTabletImageUrl)
```
    Banner image. Tablet size (1707x283).
    
    Parameters:
    
    bannerTabletImageUrl - bannerTabletImageUrl or null for none
  - getBannerTabletLowImageUrl
```
public String getBannerTabletLowImageUrl()
```
    Banner image. Tablet size low resolution (1138x188).
    
    Returns:
    
    value or null for none
  - setBannerTabletLowImageUrl
```
public ImageSettings setBannerTabletLowImageUrl(String bannerTabletLowImageUrl)
```
    Banner image. Tablet size low resolution (1138x188).
    
    Parameters:
    
    bannerTabletLowImageUrl - bannerTabletLowImageUrl or null for none
  - getBannerTvHighImageUrl
```
public String getBannerTvHighImageUrl()
```
    Banner image. TV size high resolution (1920x1080).
    
    Returns:
    
    value or null for none
  - setBannerTvHighImageUrl
```
public ImageSettings setBannerTvHighImageUrl(String bannerTvHighImageUrl)
```
    Banner image. TV size high resolution (1920x1080).
    
    Parameters:
    
    bannerTvHighImageUrl - bannerTvHighImageUrl or null for none
  - getBannerTvImageUrl
```
public String getBannerTvImageUrl()
```
    Banner image. TV size extra high resolution (2120x1192).
    
    Returns:
    
    value or null for none
  - setBannerTvImageUrl
```
public ImageSettings setBannerTvImageUrl(String bannerTvImageUrl)
```
    Banner image. TV size extra high resolution (2120x1192).
    
    Parameters:
    
    bannerTvImageUrl - bannerTvImageUrl or null for none
  - getBannerTvLowImageUrl
```
public String getBannerTvLowImageUrl()
```
    Banner image. TV size low resolution (854x480).
    
    Returns:
    
    value or null for none
  - setBannerTvLowImageUrl
```
public ImageSettings setBannerTvLowImageUrl(String bannerTvLowImageUrl)
```
    Banner image. TV size low resolution (854x480).
    
    Parameters:
    
    bannerTvLowImageUrl - bannerTvLowImageUrl or null for none
  - getBannerTvMediumImageUrl
```
public String getBannerTvMediumImageUrl()
```
    Banner image. TV size medium resolution (1280x720).
    
    Returns:
    
    value or null for none
  - setBannerTvMediumImageUrl
```
public ImageSettings setBannerTvMediumImageUrl(String bannerTvMediumImageUrl)
```
    Banner image. TV size medium resolution (1280x720).
    
    Parameters:
    
    bannerTvMediumImageUrl - bannerTvMediumImageUrl or null for none
  - getLargeBrandedBannerImageImapScript
```
public LocalizedProperty getLargeBrandedBannerImageImapScript()
```
    The image map script for the large banner image.
    
    Returns:
    
    value or null for none
  - setLargeBrandedBannerImageImapScript
```
public ImageSettings setLargeBrandedBannerImageImapScript(LocalizedProperty largeBrandedBannerImageImapScript)
```
    The image map script for the large banner image.
    
    Parameters:
    
    largeBrandedBannerImageImapScript - largeBrandedBannerImageImapScript or null for none
  - getLargeBrandedBannerImageUrl
```
public LocalizedProperty getLargeBrandedBannerImageUrl()
```
    The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
    
    Returns:
    
    value or null for none
  - setLargeBrandedBannerImageUrl
```
public ImageSettings setLargeBrandedBannerImageUrl(LocalizedProperty largeBrandedBannerImageUrl)
```
    The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.
    
    Parameters:
    
    largeBrandedBannerImageUrl - largeBrandedBannerImageUrl or null for none
  - getSmallBrandedBannerImageImapScript
```
public LocalizedProperty getSmallBrandedBannerImageImapScript()
```
    The image map script for the small banner image.
    
    Returns:
    
    value or null for none
  - setSmallBrandedBannerImageImapScript
```
public ImageSettings setSmallBrandedBannerImageImapScript(LocalizedProperty smallBrandedBannerImageImapScript)
```
    The image map script for the small banner image.
    
    Parameters:
    
    smallBrandedBannerImageImapScript - smallBrandedBannerImageImapScript or null for none
  - getSmallBrandedBannerImageUrl
```
public LocalizedProperty getSmallBrandedBannerImageUrl()
```
    The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. 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.
    
    Returns:
    
    value or null for none
  - setSmallBrandedBannerImageUrl
```
public ImageSettings setSmallBrandedBannerImageUrl(LocalizedProperty smallBrandedBannerImageUrl)
```
    The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. 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.
    
    Parameters:
    
    smallBrandedBannerImageUrl - smallBrandedBannerImageUrl or null for none
  - getTrackingImageUrl
```
public String getTrackingImageUrl()
```
    The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
    
    Returns:
    
    value or null for none
  - setTrackingImageUrl
```
public ImageSettings setTrackingImageUrl(String trackingImageUrl)
```
    The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.
    
    Parameters:
    
    trackingImageUrl - trackingImageUrl or null for none
  - getWatchIconImageUrl
```
public String getWatchIconImageUrl()
```
    Returns:
    
    value or null for none
  - setWatchIconImageUrl
```
public ImageSettings setWatchIconImageUrl(String watchIconImageUrl)
```
    Parameters:
    
    watchIconImageUrl - watchIconImageUrl or null for none
  - set
```
public ImageSettings set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public ImageSettings clone()
```
    Overrides:
    
    clone in class GenericJson

Class ImageSettings

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ImageSettings

Method Detail

getBackgroundImageUrl

setBackgroundImageUrl

getBannerExternalUrl

setBannerExternalUrl

getBannerImageUrl

setBannerImageUrl

getBannerMobileExtraHdImageUrl

setBannerMobileExtraHdImageUrl

getBannerMobileHdImageUrl

setBannerMobileHdImageUrl

getBannerMobileImageUrl

setBannerMobileImageUrl

getBannerMobileLowImageUrl

setBannerMobileLowImageUrl

getBannerMobileMediumHdImageUrl

setBannerMobileMediumHdImageUrl

getBannerTabletExtraHdImageUrl

setBannerTabletExtraHdImageUrl

getBannerTabletHdImageUrl

setBannerTabletHdImageUrl

getBannerTabletImageUrl

setBannerTabletImageUrl

getBannerTabletLowImageUrl

setBannerTabletLowImageUrl

getBannerTvHighImageUrl

setBannerTvHighImageUrl

getBannerTvImageUrl

setBannerTvImageUrl

getBannerTvLowImageUrl

setBannerTvLowImageUrl

getBannerTvMediumImageUrl

setBannerTvMediumImageUrl

getLargeBrandedBannerImageImapScript

setLargeBrandedBannerImageImapScript

getLargeBrandedBannerImageUrl

setLargeBrandedBannerImageUrl

getSmallBrandedBannerImageImapScript

setSmallBrandedBannerImageImapScript

getSmallBrandedBannerImageUrl

setSmallBrandedBannerImageUrl

getTrackingImageUrl

setTrackingImageUrl

getWatchIconImageUrl

setWatchIconImageUrl

set

clone