Class GoogleAdsLink.Builder (0.57.0) 

public static final class GoogleAdsLink.Builder extends GeneratedMessageV3.Builder<GoogleAdsLink.Builder> implements GoogleAdsLinkOrBuilder

A link between a GA4 property and a Google Ads account.

Protobuf type google.analytics.admin.v1alpha.GoogleAdsLink

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GoogleAdsLink.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public GoogleAdsLink build()
Returns
Type Description
GoogleAdsLink

buildPartial()

public GoogleAdsLink buildPartial()
Returns
Type Description
GoogleAdsLink

clear()

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

clearAdsPersonalizationEnabled()

public GoogleAdsLink.Builder clearAdsPersonalizationEnabled()

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Returns
Type Description
GoogleAdsLink.Builder

clearCanManageClients()

public GoogleAdsLink.Builder clearCanManageClients()

Output only. If true, this link is for a Google Ads manager account.

bool can_manage_clients = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

clearCreateTime()

public GoogleAdsLink.Builder clearCreateTime()

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GoogleAdsLink.Builder

clearCreatorEmailAddress()

public GoogleAdsLink.Builder clearCreatorEmailAddress()

Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.

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

Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

clearCustomerId()

public GoogleAdsLink.Builder clearCustomerId()

Immutable. Google Ads customer ID.

string customer_id = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public GoogleAdsLink.Builder clearName()

Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

Note: googleAdsLinkId is not the Google Ads customer ID.

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

Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUpdateTime()

public GoogleAdsLink.Builder clearUpdateTime()

Output only. Time when this link was last updated.

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

Returns
Type Description
GoogleAdsLink.Builder

clone()

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

getAdsPersonalizationEnabled()

public BoolValue getAdsPersonalizationEnabled()

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Returns
Type Description
BoolValue

The adsPersonalizationEnabled.

getAdsPersonalizationEnabledBuilder()

public BoolValue.Builder getAdsPersonalizationEnabledBuilder()

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Returns
Type Description
Builder

getAdsPersonalizationEnabledOrBuilder()

public BoolValueOrBuilder getAdsPersonalizationEnabledOrBuilder()

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Returns
Type Description
BoolValueOrBuilder

getCanManageClients()

public boolean getCanManageClients()

Output only. If true, this link is for a Google Ads manager account.

bool can_manage_clients = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The canManageClients.

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreatorEmailAddress()

public String getCreatorEmailAddress()

Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.

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

Returns
Type Description
String

The creatorEmailAddress.

getCreatorEmailAddressBytes()

public ByteString getCreatorEmailAddressBytes()

Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.

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

Returns
Type Description
ByteString

The bytes for creatorEmailAddress.

getCustomerId()

public String getCustomerId()

Immutable. Google Ads customer ID.

string customer_id = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The customerId.

getCustomerIdBytes()

public ByteString getCustomerIdBytes()

Immutable. Google Ads customer ID.

string customer_id = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for customerId.

getDefaultInstanceForType()

public GoogleAdsLink getDefaultInstanceForType()
Returns
Type Description
GoogleAdsLink

getDescriptorForType()

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

getName()

public String getName()

Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

Note: googleAdsLinkId is not the Google Ads customer ID.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

Note: googleAdsLinkId is not the Google Ads customer ID.

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

Returns
Type Description
ByteString

The bytes for name.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when this link was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Time when this link was last updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when this link was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasAdsPersonalizationEnabled()

public boolean hasAdsPersonalizationEnabled()

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Returns
Type Description
boolean

Whether the adsPersonalizationEnabled field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when this link was last updated.

.google.protobuf.Timestamp update_time = 8 [(.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

mergeAdsPersonalizationEnabled(BoolValue value)

public GoogleAdsLink.Builder mergeAdsPersonalizationEnabled(BoolValue value)

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Parameter
Name Description
value BoolValue
Returns
Type Description
GoogleAdsLink.Builder

mergeCreateTime(Timestamp value)

public GoogleAdsLink.Builder mergeCreateTime(Timestamp value)

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
GoogleAdsLink.Builder

mergeFrom(GoogleAdsLink other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public GoogleAdsLink.Builder mergeUpdateTime(Timestamp value)

Output only. Time when this link was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
GoogleAdsLink.Builder

setAdsPersonalizationEnabled(BoolValue value)

public GoogleAdsLink.Builder setAdsPersonalizationEnabled(BoolValue value)

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Parameter
Name Description
value BoolValue
Returns
Type Description
GoogleAdsLink.Builder

setAdsPersonalizationEnabled(BoolValue.Builder builderForValue)

public GoogleAdsLink.Builder setAdsPersonalizationEnabled(BoolValue.Builder builderForValue)

Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GoogleAdsLink.Builder

setCanManageClients(boolean value)

public GoogleAdsLink.Builder setCanManageClients(boolean value)

Output only. If true, this link is for a Google Ads manager account.

bool can_manage_clients = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The canManageClients to set.
Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public GoogleAdsLink.Builder setCreateTime(Timestamp value)

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
GoogleAdsLink.Builder

setCreateTime(Timestamp.Builder builderForValue)

public GoogleAdsLink.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when this link was originally created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GoogleAdsLink.Builder

setCreatorEmailAddress(String value)

public GoogleAdsLink.Builder setCreatorEmailAddress(String value)

Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.

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

Parameter
Name Description
value String

The creatorEmailAddress to set.
Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

setCreatorEmailAddressBytes(ByteString value)

public GoogleAdsLink.Builder setCreatorEmailAddressBytes(ByteString value)

Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.

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

Parameter
Name Description
value ByteString

The bytes for creatorEmailAddress to set.
Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

setCustomerId(String value)

public GoogleAdsLink.Builder setCustomerId(String value)

Immutable. Google Ads customer ID.

string customer_id = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The customerId to set.
Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

setCustomerIdBytes(ByteString value)

public GoogleAdsLink.Builder setCustomerIdBytes(ByteString value)

Immutable. Google Ads customer ID.

string customer_id = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for customerId to set.
Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public GoogleAdsLink.Builder setName(String value)

Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

Note: googleAdsLinkId is not the Google Ads customer ID.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GoogleAdsLink.Builder setNameBytes(ByteString value)

Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

Note: googleAdsLinkId is not the Google Ads customer ID.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
GoogleAdsLink.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public GoogleAdsLink.Builder setUpdateTime(Timestamp value)

Output only. Time when this link was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
GoogleAdsLink.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public GoogleAdsLink.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Time when this link was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GoogleAdsLink.Builder