Class GoogleAdsLink (0.50.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.v1alpha.GoogleAdsLink

Static Fields

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

Static Methods

public static GoogleAdsLink getDefaultInstance()
Returns
TypeDescription
GoogleAdsLink
public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor
public static GoogleAdsLink.Builder newBuilder()
Returns
TypeDescription
GoogleAdsLink.Builder
public static GoogleAdsLink.Builder newBuilder(GoogleAdsLink prototype)
Parameter
NameDescription
prototypeGoogleAdsLink
Returns
TypeDescription
GoogleAdsLink.Builder
public static GoogleAdsLink parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
IOException
public static GoogleAdsLink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
IOException
public static GoogleAdsLink parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
IOException
public static GoogleAdsLink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
IOException
public static GoogleAdsLink parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
IOException
public static GoogleAdsLink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
IOException
public static GoogleAdsLink parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static GoogleAdsLink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleAdsLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static Parser<GoogleAdsLink> parser()
Returns
TypeDescription
Parser<GoogleAdsLink>

Methods

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for creatorEmailAddress.

public String getCustomerId()

Immutable. Google Ads customer ID.

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

Returns
TypeDescription
String

The customerId.

public ByteString getCustomerIdBytes()

Immutable. Google Ads customer ID.

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

Returns
TypeDescription
ByteString

The bytes for customerId.

public GoogleAdsLink getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

public Parser<GoogleAdsLink> getParserForType()
Returns
TypeDescription
Parser<GoogleAdsLink>
Overrides
public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

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