Class Creative.Builder (0.8.0)

public static final class Creative.Builder extends GeneratedMessageV3.Builder<Creative.Builder> implements CreativeOrBuilder

The Creative resource.

Protobuf type google.ads.admanager.v1.Creative

Implements

CreativeOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Creative.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Creative.Builder
Overrides

build()

public Creative build()
Returns
Type Description
Creative

buildPartial()

public Creative buildPartial()
Returns
Type Description
Creative

clear()

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

clearAdPartnerDeclaration()

public Creative.Builder clearAdPartnerDeclaration()

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Creative.Builder

clearAdvertiser()

public Creative.Builder clearAdvertiser()

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this Creative belongs. Format: "networks/{network_code}/companies/{company_id}"

string advertiser = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Creative.Builder

This builder for chaining.

clearCreativeId()

public Creative.Builder clearCreativeId()

Output only. Creative ID.

int64 creative_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Creative.Builder

This builder for chaining.

clearDisplayName()

public Creative.Builder clearDisplayName()

Optional. Display name of the Creative. This attribute has a maximum length of 255 characters.

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Creative.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Creative.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Creative.Builder
Overrides

clearName()

public Creative.Builder clearName()

Identifier. The resource name of the Creative. Format: networks/{network_code}/creatives/{creative_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Creative.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Creative.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Creative.Builder
Overrides

clearPreviewUrl()

public Creative.Builder clearPreviewUrl()

Output only. The URL of the creative for previewing the media.

string preview_url = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Creative.Builder

This builder for chaining.

clearSizeLabel()

public Creative.Builder clearSizeLabel()

Output only. String representations of creative size. This field is temporarily available and will be deprecated when Creative.size becomes available.

string size_label = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Creative.Builder

This builder for chaining.

clearUpdateTime()

public Creative.Builder clearUpdateTime()

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Creative.Builder

clone()

public Creative.Builder clone()
Returns
Type Description
Creative.Builder
Overrides

getAdPartnerDeclaration()

public AdPartnerDeclaration getAdPartnerDeclaration()

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AdPartnerDeclaration

The adPartnerDeclaration.

getAdPartnerDeclarationBuilder()

public AdPartnerDeclaration.Builder getAdPartnerDeclarationBuilder()

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AdPartnerDeclaration.Builder

getAdPartnerDeclarationOrBuilder()

public AdPartnerDeclarationOrBuilder getAdPartnerDeclarationOrBuilder()

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AdPartnerDeclarationOrBuilder

getAdvertiser()

public String getAdvertiser()

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this Creative belongs. Format: "networks/{network_code}/companies/{company_id}"

string advertiser = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The advertiser.

getAdvertiserBytes()

public ByteString getAdvertiserBytes()

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this Creative belongs. Format: "networks/{network_code}/companies/{company_id}"

string advertiser = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for advertiser.

getCreativeId()

public long getCreativeId()

Output only. Creative ID.

int64 creative_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The creativeId.

getDefaultInstanceForType()

public Creative getDefaultInstanceForType()
Returns
Type Description
Creative

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. Display name of the Creative. This attribute has a maximum length of 255 characters.

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name of the Creative. This attribute has a maximum length of 255 characters.

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the Creative. Format: networks/{network_code}/creatives/{creative_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the Creative. Format: networks/{network_code}/creatives/{creative_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPreviewUrl()

public String getPreviewUrl()

Output only. The URL of the creative for previewing the media.

string preview_url = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The previewUrl.

getPreviewUrlBytes()

public ByteString getPreviewUrlBytes()

Output only. The URL of the creative for previewing the media.

string preview_url = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for previewUrl.

getSizeLabel()

public String getSizeLabel()

Output only. String representations of creative size. This field is temporarily available and will be deprecated when Creative.size becomes available.

string size_label = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The sizeLabel.

getSizeLabelBytes()

public ByteString getSizeLabelBytes()

Output only. String representations of creative size. This field is temporarily available and will be deprecated when Creative.size becomes available.

string size_label = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for sizeLabel.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAdPartnerDeclaration()

public boolean hasAdPartnerDeclaration()

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the adPartnerDeclaration field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdPartnerDeclaration(AdPartnerDeclaration value)

public Creative.Builder mergeAdPartnerDeclaration(AdPartnerDeclaration value)

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AdPartnerDeclaration
Returns
Type Description
Creative.Builder

mergeFrom(Creative other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Creative.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Creative.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Creative.Builder mergeUpdateTime(Timestamp value)

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Creative.Builder

setAdPartnerDeclaration(AdPartnerDeclaration value)

public Creative.Builder setAdPartnerDeclaration(AdPartnerDeclaration value)

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AdPartnerDeclaration
Returns
Type Description
Creative.Builder

setAdPartnerDeclaration(AdPartnerDeclaration.Builder builderForValue)

public Creative.Builder setAdPartnerDeclaration(AdPartnerDeclaration.Builder builderForValue)

Optional. The Ad Partners associated with this creative. This is distinct from any associated companies that Google may detect programmatically.

.google.ads.admanager.v1.AdPartnerDeclaration ad_partner_declaration = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AdPartnerDeclaration.Builder
Returns
Type Description
Creative.Builder

setAdvertiser(String value)

public Creative.Builder setAdvertiser(String value)

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this Creative belongs. Format: "networks/{network_code}/companies/{company_id}"

string advertiser = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The advertiser to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setAdvertiserBytes(ByteString value)

public Creative.Builder setAdvertiserBytes(ByteString value)

Required. The resource name of the Company, which is of type Company.Type.ADVERTISER, to which this Creative belongs. Format: "networks/{network_code}/companies/{company_id}"

string advertiser = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for advertiser to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setCreativeId(long value)

public Creative.Builder setCreativeId(long value)

Output only. Creative ID.

int64 creative_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The creativeId to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setDisplayName(String value)

public Creative.Builder setDisplayName(String value)

Optional. Display name of the Creative. This attribute has a maximum length of 255 characters.

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Creative.Builder setDisplayNameBytes(ByteString value)

Optional. Display name of the Creative. This attribute has a maximum length of 255 characters.

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Creative.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Creative.Builder
Overrides

setName(String value)

public Creative.Builder setName(String value)

Identifier. The resource name of the Creative. Format: networks/{network_code}/creatives/{creative_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Creative.Builder setNameBytes(ByteString value)

Identifier. The resource name of the Creative. Format: networks/{network_code}/creatives/{creative_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setPreviewUrl(String value)

public Creative.Builder setPreviewUrl(String value)

Output only. The URL of the creative for previewing the media.

string preview_url = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The previewUrl to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setPreviewUrlBytes(ByteString value)

public Creative.Builder setPreviewUrlBytes(ByteString value)

Output only. The URL of the creative for previewing the media.

string preview_url = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for previewUrl to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Creative.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Creative.Builder
Overrides

setSizeLabel(String value)

public Creative.Builder setSizeLabel(String value)

Output only. String representations of creative size. This field is temporarily available and will be deprecated when Creative.size becomes available.

string size_label = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The sizeLabel to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setSizeLabelBytes(ByteString value)

public Creative.Builder setSizeLabelBytes(ByteString value)

Output only. String representations of creative size. This field is temporarily available and will be deprecated when Creative.size becomes available.

string size_label = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for sizeLabel to set.

Returns
Type Description
Creative.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Creative.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Creative.Builder
Overrides

setUpdateTime(Timestamp value)

public Creative.Builder setUpdateTime(Timestamp value)

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Creative.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Creative.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The instant this Creative was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Creative.Builder