Class SearchAds360Link (0.56.0)

public final class SearchAds360Link extends GeneratedMessageV3 implements SearchAds360LinkOrBuilder

A link between a GA4 property and a Search Ads 360 entity.

Protobuf type google.analytics.admin.v1alpha.SearchAds360Link

Static Fields

public static final int ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int ADVERTISER_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int ADVERTISER_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int CAMPAIGN_DATA_SHARING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int COST_DATA_SHARING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int SITE_STATS_SHARING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

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

Methods

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides
public BoolValue getAdsPersonalizationEnabled()

Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 6;

Returns
Type Description
BoolValue

The adsPersonalizationEnabled.

public BoolValueOrBuilder getAdsPersonalizationEnabledOrBuilder()

Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 6;

Returns
Type Description
BoolValueOrBuilder
public String getAdvertiserDisplayName()

Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource.

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

Returns
Type Description
String

The advertiserDisplayName.

public ByteString getAdvertiserDisplayNameBytes()

Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource.

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

Returns
Type Description
ByteString

The bytes for advertiserDisplayName.

public String getAdvertiserId()

Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked.

string advertiser_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The advertiserId.

public ByteString getAdvertiserIdBytes()

Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked.

string advertiser_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for advertiserId.

public BoolValue getCampaignDataSharingEnabled()

Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue campaign_data_sharing_enabled = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BoolValue

The campaignDataSharingEnabled.

public BoolValueOrBuilder getCampaignDataSharingEnabledOrBuilder()

Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue campaign_data_sharing_enabled = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BoolValueOrBuilder
public BoolValue getCostDataSharingEnabled()

Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue cost_data_sharing_enabled = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BoolValue

The costDataSharingEnabled.

public BoolValueOrBuilder getCostDataSharingEnabledOrBuilder()

Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue cost_data_sharing_enabled = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BoolValueOrBuilder
public SearchAds360Link getDefaultInstanceForType()
Returns
Type Description
SearchAds360Link
public String getName()

Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId}

Note: linkId is not the Search Ads 360 advertiser ID

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

Returns
Type Description
String

The name.

public ByteString getNameBytes()

Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId}

Note: linkId is not the Search Ads 360 advertiser ID

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

Returns
Type Description
ByteString

The bytes for name.

public Parser<SearchAds360Link> getParserForType()
Returns
Type Description
Parser<SearchAds360Link>
Overrides
public int getSerializedSize()
Returns
Type Description
int
Overrides
public BoolValue getSiteStatsSharingEnabled()

Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue site_stats_sharing_enabled = 7;

Returns
Type Description
BoolValue

The siteStatsSharingEnabled.

public BoolValueOrBuilder getSiteStatsSharingEnabledOrBuilder()

Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue site_stats_sharing_enabled = 7;

Returns
Type Description
BoolValueOrBuilder
public boolean hasAdsPersonalizationEnabled()

Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue ads_personalization_enabled = 6;

Returns
Type Description
boolean

Whether the adsPersonalizationEnabled field is set.

public boolean hasCampaignDataSharingEnabled()

Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue campaign_data_sharing_enabled = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the campaignDataSharingEnabled field is set.

public boolean hasCostDataSharingEnabled()

Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue cost_data_sharing_enabled = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the costDataSharingEnabled field is set.

public boolean hasSiteStatsSharingEnabled()

Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.

.google.protobuf.BoolValue site_stats_sharing_enabled = 7;

Returns
Type Description
boolean

Whether the siteStatsSharingEnabled 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 SearchAds360Link.Builder newBuilderForType()
Returns
Type Description
SearchAds360Link.Builder
protected SearchAds360Link.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchAds360Link.Builder
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides
public SearchAds360Link.Builder toBuilder()
Returns
Type Description
SearchAds360Link.Builder
public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException