Class CreativeAsset.Builder (0.62.0)

public static final class CreativeAsset.Builder extends GeneratedMessage.Builder<CreativeAsset.Builder> implements CreativeAssetOrBuilder

A CreativeAsset is an asset that can be used in creatives.

Protobuf type google.ads.admanager.v1.CreativeAsset

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllClickTags(Iterable<? extends ClickTag> values)

public CreativeAsset.Builder addAllClickTags(Iterable<? extends ClickTag> values)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.ClickTag>
Returns
Type Description
CreativeAsset.Builder

addClickTags(ClickTag value)

public CreativeAsset.Builder addClickTags(ClickTag value)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ClickTag
Returns
Type Description
CreativeAsset.Builder

addClickTags(ClickTag.Builder builderForValue)

public CreativeAsset.Builder addClickTags(ClickTag.Builder builderForValue)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ClickTag.Builder
Returns
Type Description
CreativeAsset.Builder

addClickTags(int index, ClickTag value)

public CreativeAsset.Builder addClickTags(int index, ClickTag value)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value ClickTag
Returns
Type Description
CreativeAsset.Builder

addClickTags(int index, ClickTag.Builder builderForValue)

public CreativeAsset.Builder addClickTags(int index, ClickTag.Builder builderForValue)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue ClickTag.Builder
Returns
Type Description
CreativeAsset.Builder

addClickTagsBuilder()

public ClickTag.Builder addClickTagsBuilder()

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ClickTag.Builder

addClickTagsBuilder(int index)

public ClickTag.Builder addClickTagsBuilder(int index)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ClickTag.Builder

build()

public CreativeAsset build()
Returns
Type Description
CreativeAsset

buildPartial()

public CreativeAsset buildPartial()
Returns
Type Description
CreativeAsset

clear()

public CreativeAsset.Builder clear()
Returns
Type Description
CreativeAsset.Builder
Overrides

clearAsset()

public CreativeAsset.Builder clearAsset()

Required. The resource name of the asset. This attribute is generated by Google upon creation. Format: networks/{network_code}/assets/{asset}

optional string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

clearAssetByteArray()

public CreativeAsset.Builder clearAssetByteArray()

Input only. The content of the asset as a byte array. This attribute is required when creating the creative that contains this asset if asset is not provided.

When updating the content, pass a new byte array, and set asset to null. Otherwise, this field can be null.

The asset_byte_array will be null when the creative is retrieved.

optional bytes asset_byte_array = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

clearAssetUrl()

public CreativeAsset.Builder clearAssetUrl()

Output only. A URL where the asset can be previewed.

optional string asset_url = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

clearClickTags()

public CreativeAsset.Builder clearClickTags()

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CreativeAsset.Builder

clearFileName()

public CreativeAsset.Builder clearFileName()

Optional. The file name of the asset. This attribute is required when creating a new asset (e.g. when asset_byte_array is not null).

optional string file_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

clearFileSize()

public CreativeAsset.Builder clearFileSize()

Output only. The file size of the asset in bytes.

optional int64 file_size = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

clearImageDensity()

public CreativeAsset.Builder clearImageDensity()

Non-empty default. The display density of the image. This is the ratio between a dimension in pixels of the image and the dimension in pixels that it should occupy in device-independent pixels when displayed. This attribute defaults to ONE_TO_ONE.

optional .google.ads.admanager.v1.AssetImageDensityEnum.AssetImageDensity image_density = 8 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

clearSize()

public CreativeAsset.Builder clearSize()

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeAsset.Builder

getAsset()

public String getAsset()

Required. The resource name of the asset. This attribute is generated by Google upon creation. Format: networks/{network_code}/assets/{asset}

optional string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The asset.

getAssetByteArray()

public ByteString getAssetByteArray()

Input only. The content of the asset as a byte array. This attribute is required when creating the creative that contains this asset if asset is not provided.

When updating the content, pass a new byte array, and set asset to null. Otherwise, this field can be null.

The asset_byte_array will be null when the creative is retrieved.

optional bytes asset_byte_array = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The assetByteArray.

getAssetBytes()

public ByteString getAssetBytes()

Required. The resource name of the asset. This attribute is generated by Google upon creation. Format: networks/{network_code}/assets/{asset}

optional string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for asset.

getAssetUrl()

public String getAssetUrl()

Output only. A URL where the asset can be previewed.

optional string asset_url = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The assetUrl.

getAssetUrlBytes()

public ByteString getAssetUrlBytes()

Output only. A URL where the asset can be previewed.

optional string asset_url = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for assetUrl.

getClickTags(int index)

public ClickTag getClickTags(int index)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ClickTag

getClickTagsBuilder(int index)

public ClickTag.Builder getClickTagsBuilder(int index)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ClickTag.Builder

getClickTagsBuilderList()

public List<ClickTag.Builder> getClickTagsBuilderList()

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getClickTagsCount()

public int getClickTagsCount()

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getClickTagsList()

public List<ClickTag> getClickTagsList()

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ClickTag>

getClickTagsOrBuilder(int index)

public ClickTagOrBuilder getClickTagsOrBuilder(int index)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ClickTagOrBuilder

getClickTagsOrBuilderList()

public List<? extends ClickTagOrBuilder> getClickTagsOrBuilderList()

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ClickTagOrBuilder>

getDefaultInstanceForType()

public CreativeAsset getDefaultInstanceForType()
Returns
Type Description
CreativeAsset

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFileName()

public String getFileName()

Optional. The file name of the asset. This attribute is required when creating a new asset (e.g. when asset_byte_array is not null).

optional string file_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The fileName.

getFileNameBytes()

public ByteString getFileNameBytes()

Optional. The file name of the asset. This attribute is required when creating a new asset (e.g. when asset_byte_array is not null).

optional string file_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for fileName.

getFileSize()

public long getFileSize()

Output only. The file size of the asset in bytes.

optional int64 file_size = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The fileSize.

getImageDensity()

public AssetImageDensityEnum.AssetImageDensity getImageDensity()

Non-empty default. The display density of the image. This is the ratio between a dimension in pixels of the image and the dimension in pixels that it should occupy in device-independent pixels when displayed. This attribute defaults to ONE_TO_ONE.

optional .google.ads.admanager.v1.AssetImageDensityEnum.AssetImageDensity image_density = 8 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
AssetImageDensityEnum.AssetImageDensity

The imageDensity.

getImageDensityValue()

public int getImageDensityValue()

Non-empty default. The display density of the image. This is the ratio between a dimension in pixels of the image and the dimension in pixels that it should occupy in device-independent pixels when displayed. This attribute defaults to ONE_TO_ONE.

optional .google.ads.admanager.v1.AssetImageDensityEnum.AssetImageDensity image_density = 8 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
int

The enum numeric value on the wire for imageDensity.

getSize()

public Size getSize()

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Size

The size.

getSizeBuilder()

public Size.Builder getSizeBuilder()

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Size.Builder

getSizeOrBuilder()

public SizeOrBuilder getSizeOrBuilder()

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SizeOrBuilder

hasAsset()

public boolean hasAsset()

Required. The resource name of the asset. This attribute is generated by Google upon creation. Format: networks/{network_code}/assets/{asset}

optional string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the asset field is set.

hasAssetByteArray()

public boolean hasAssetByteArray()

Input only. The content of the asset as a byte array. This attribute is required when creating the creative that contains this asset if asset is not provided.

When updating the content, pass a new byte array, and set asset to null. Otherwise, this field can be null.

The asset_byte_array will be null when the creative is retrieved.

optional bytes asset_byte_array = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the assetByteArray field is set.

hasAssetUrl()

public boolean hasAssetUrl()

Output only. A URL where the asset can be previewed.

optional string asset_url = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the assetUrl field is set.

hasFileName()

public boolean hasFileName()

Optional. The file name of the asset. This attribute is required when creating a new asset (e.g. when asset_byte_array is not null).

optional string file_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the fileName field is set.

hasFileSize()

public boolean hasFileSize()

Output only. The file size of the asset in bytes.

optional int64 file_size = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the fileSize field is set.

hasImageDensity()

public boolean hasImageDensity()

Non-empty default. The display density of the image. This is the ratio between a dimension in pixels of the image and the dimension in pixels that it should occupy in device-independent pixels when displayed. This attribute defaults to ONE_TO_ONE.

optional .google.ads.admanager.v1.AssetImageDensityEnum.AssetImageDensity image_density = 8 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Returns
Type Description
boolean

Whether the imageDensity field is set.

hasSize()

public boolean hasSize()

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the size field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreativeAsset other)

public CreativeAsset.Builder mergeFrom(CreativeAsset other)
Parameter
Name Description
other CreativeAsset
Returns
Type Description
CreativeAsset.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreativeAsset.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreativeAsset.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreativeAsset.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreativeAsset.Builder
Overrides

mergeSize(Size value)

public CreativeAsset.Builder mergeSize(Size value)

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Size
Returns
Type Description
CreativeAsset.Builder

removeClickTags(int index)

public CreativeAsset.Builder removeClickTags(int index)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CreativeAsset.Builder

setAsset(String value)

public CreativeAsset.Builder setAsset(String value)

Required. The resource name of the asset. This attribute is generated by Google upon creation. Format: networks/{network_code}/assets/{asset}

optional string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The asset to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setAssetByteArray(ByteString value)

public CreativeAsset.Builder setAssetByteArray(ByteString value)

Input only. The content of the asset as a byte array. This attribute is required when creating the creative that contains this asset if asset is not provided.

When updating the content, pass a new byte array, and set asset to null. Otherwise, this field can be null.

The asset_byte_array will be null when the creative is retrieved.

optional bytes asset_byte_array = 2 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value ByteString

The assetByteArray to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setAssetBytes(ByteString value)

public CreativeAsset.Builder setAssetBytes(ByteString value)

Required. The resource name of the asset. This attribute is generated by Google upon creation. Format: networks/{network_code}/assets/{asset}

optional string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for asset to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setAssetUrl(String value)

public CreativeAsset.Builder setAssetUrl(String value)

Output only. A URL where the asset can be previewed.

optional string asset_url = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The assetUrl to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setAssetUrlBytes(ByteString value)

public CreativeAsset.Builder setAssetUrlBytes(ByteString value)

Output only. A URL where the asset can be previewed.

optional string asset_url = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for assetUrl to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setClickTags(int index, ClickTag value)

public CreativeAsset.Builder setClickTags(int index, ClickTag value)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value ClickTag
Returns
Type Description
CreativeAsset.Builder

setClickTags(int index, ClickTag.Builder builderForValue)

public CreativeAsset.Builder setClickTags(int index, ClickTag.Builder builderForValue)

Output only. The click tags of the asset.

repeated .google.ads.admanager.v1.ClickTag click_tags = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue ClickTag.Builder
Returns
Type Description
CreativeAsset.Builder

setFileName(String value)

public CreativeAsset.Builder setFileName(String value)

Optional. The file name of the asset. This attribute is required when creating a new asset (e.g. when asset_byte_array is not null).

optional string file_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The fileName to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setFileNameBytes(ByteString value)

public CreativeAsset.Builder setFileNameBytes(ByteString value)

Optional. The file name of the asset. This attribute is required when creating a new asset (e.g. when asset_byte_array is not null).

optional string file_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for fileName to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setFileSize(long value)

public CreativeAsset.Builder setFileSize(long value)

Output only. The file size of the asset in bytes.

optional int64 file_size = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The fileSize to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setImageDensity(AssetImageDensityEnum.AssetImageDensity value)

public CreativeAsset.Builder setImageDensity(AssetImageDensityEnum.AssetImageDensity value)

Non-empty default. The display density of the image. This is the ratio between a dimension in pixels of the image and the dimension in pixels that it should occupy in device-independent pixels when displayed. This attribute defaults to ONE_TO_ONE.

optional .google.ads.admanager.v1.AssetImageDensityEnum.AssetImageDensity image_density = 8 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value AssetImageDensityEnum.AssetImageDensity

The imageDensity to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setImageDensityValue(int value)

public CreativeAsset.Builder setImageDensityValue(int value)

Non-empty default. The display density of the image. This is the ratio between a dimension in pixels of the image and the dimension in pixels that it should occupy in device-independent pixels when displayed. This attribute defaults to ONE_TO_ONE.

optional .google.ads.admanager.v1.AssetImageDensityEnum.AssetImageDensity image_density = 8 [(.google.api.field_behavior) = NON_EMPTY_DEFAULT];

Parameter
Name Description
value int

The enum numeric value on the wire for imageDensity to set.

Returns
Type Description
CreativeAsset.Builder

This builder for chaining.

setSize(Size value)

public CreativeAsset.Builder setSize(Size value)

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Size
Returns
Type Description
CreativeAsset.Builder

setSize(Size.Builder builderForValue)

public CreativeAsset.Builder setSize(Size.Builder builderForValue)

Optional. The size of the asset. Note that this may not always reflect the actual physical size of the asset, but may reflect the expected size.

.google.ads.admanager.v1.Size size = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Size.Builder
Returns
Type Description
CreativeAsset.Builder