Class GoogleAdsLink (0.59.0)

public final class GoogleAdsLink extends GeneratedMessageV3 implements GoogleAdsLinkOrBuilder

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

Protobuf type google.analytics.admin.v1beta.GoogleAdsLink

Static Fields

public static final int ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int CAN_MANAGE_CLIENTS_FIELD_NUMBER
Field Value
Type Description
int
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int CREATOR_EMAIL_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int
public static final int CUSTOMER_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

public static GoogleAdsLink getDefaultInstance()
Returns
Type Description
GoogleAdsLink
public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor
public static GoogleAdsLink.Builder newBuilder()
Returns
Type Description
GoogleAdsLink.Builder
public static GoogleAdsLink.Builder newBuilder(GoogleAdsLink prototype)
Parameter
Name Description
prototype GoogleAdsLink
Returns
Type Description
GoogleAdsLink.Builder
public static GoogleAdsLink parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
IOException
public static GoogleAdsLink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
IOException
public static GoogleAdsLink parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
IOException
public static GoogleAdsLink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
IOException
public static GoogleAdsLink parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
IOException
public static GoogleAdsLink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
IOException
public static GoogleAdsLink parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleAdsLink
Exceptions
Type Description
InvalidProtocolBufferException
public static Parser<GoogleAdsLink> parser()
Returns
Type Description
Parser<GoogleAdsLink>

Methods

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides
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.

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
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.

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.

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
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.

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.

public String getCustomerId()

Immutable. Google Ads customer ID.

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

Returns
Type Description
String

The customerId.

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.

public GoogleAdsLink getDefaultInstanceForType()
Returns
Type Description
GoogleAdsLink
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.

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.

public Parser<GoogleAdsLink> getParserForType()
Returns
Type Description
Parser<GoogleAdsLink>
Overrides
public int getSerializedSize()
Returns
Type Description
int
Overrides
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.

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
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.

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.

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.

public int hashCode()
Returns
Type Description
int
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
public GoogleAdsLink.Builder newBuilderForType()
Returns
Type Description
GoogleAdsLink.Builder
protected GoogleAdsLink.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GoogleAdsLink.Builder
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides
public GoogleAdsLink.Builder toBuilder()
Returns
Type Description
GoogleAdsLink.Builder
public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException