Class DisplayVideo360AdvertiserLinkProposal (0.56.0)

public final class DisplayVideo360AdvertiserLinkProposal extends GeneratedMessageV3 implements DisplayVideo360AdvertiserLinkProposalOrBuilder

A proposal for a link between a GA4 property and a Display & Video 360 advertiser.

A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.

Protobuf type google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLinkProposal

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DisplayVideo360AdvertiserLinkProposal

Static Fields

ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER

public static final int ADS_PERSONALIZATION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

ADVERTISER_DISPLAY_NAME_FIELD_NUMBER

public static final int ADVERTISER_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ADVERTISER_ID_FIELD_NUMBER

public static final int ADVERTISER_ID_FIELD_NUMBER
Field Value
Type Description
int

CAMPAIGN_DATA_SHARING_ENABLED_FIELD_NUMBER

public static final int CAMPAIGN_DATA_SHARING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

COST_DATA_SHARING_ENABLED_FIELD_NUMBER

public static final int COST_DATA_SHARING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
public static final int LINK_PROPOSAL_STATUS_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

VALIDATION_EMAIL_FIELD_NUMBER

public static final int VALIDATION_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DisplayVideo360AdvertiserLinkProposal getDefaultInstance()
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

getDescriptor()

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

newBuilder()

public static DisplayVideo360AdvertiserLinkProposal.Builder newBuilder()
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal.Builder

newBuilder(DisplayVideo360AdvertiserLinkProposal prototype)

public static DisplayVideo360AdvertiserLinkProposal.Builder newBuilder(DisplayVideo360AdvertiserLinkProposal prototype)
Parameter
Name Description
prototype DisplayVideo360AdvertiserLinkProposal
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal.Builder

parseDelimitedFrom(InputStream input)

public static DisplayVideo360AdvertiserLinkProposal parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DisplayVideo360AdvertiserLinkProposal parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DisplayVideo360AdvertiserLinkProposal parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DisplayVideo360AdvertiserLinkProposal> parser()
Returns
Type Description
Parser<DisplayVideo360AdvertiserLinkProposal>

Methods

equals(Object obj)

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

getAdsPersonalizationEnabled()

public BoolValue getAdsPersonalizationEnabled()

Immutable. 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 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BoolValue

The adsPersonalizationEnabled.

getAdsPersonalizationEnabledOrBuilder()

public BoolValueOrBuilder getAdsPersonalizationEnabledOrBuilder()

Immutable. 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 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BoolValueOrBuilder

getAdvertiserDisplayName()

public String getAdvertiserDisplayName()

Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.

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

Returns
Type Description
String

The advertiserDisplayName.

getAdvertiserDisplayNameBytes()

public ByteString getAdvertiserDisplayNameBytes()

Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.

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

Returns
Type Description
ByteString

The bytes for advertiserDisplayName.

getAdvertiserId()

public String getAdvertiserId()

Immutable. The Display & Video 360 Advertiser's advertiser ID.

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

Returns
Type Description
String

The advertiserId.

getAdvertiserIdBytes()

public ByteString getAdvertiserIdBytes()

Immutable. The Display & Video 360 Advertiser's advertiser ID.

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

Returns
Type Description
ByteString

The bytes for advertiserId.

getCampaignDataSharingEnabled()

public BoolValue getCampaignDataSharingEnabled()

Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.

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

Returns
Type Description
BoolValue

The campaignDataSharingEnabled.

getCampaignDataSharingEnabledOrBuilder()

public BoolValueOrBuilder getCampaignDataSharingEnabledOrBuilder()

Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.

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

Returns
Type Description
BoolValueOrBuilder

getCostDataSharingEnabled()

public BoolValue getCostDataSharingEnabled()

Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true.

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

Returns
Type Description
BoolValue

The costDataSharingEnabled.

getCostDataSharingEnabledOrBuilder()

public BoolValueOrBuilder getCostDataSharingEnabledOrBuilder()

Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true.

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

Returns
Type Description
BoolValueOrBuilder

getDefaultInstanceForType()

public DisplayVideo360AdvertiserLinkProposal getDefaultInstanceForType()
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

getLinkProposalStatusDetails()

public LinkProposalStatusDetails getLinkProposalStatusDetails()

Output only. The status information for this link proposal.

.google.analytics.admin.v1alpha.LinkProposalStatusDetails link_proposal_status_details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LinkProposalStatusDetails

The linkProposalStatusDetails.

getLinkProposalStatusDetailsOrBuilder()

public LinkProposalStatusDetailsOrBuilder getLinkProposalStatusDetailsOrBuilder()

Output only. The status information for this link proposal.

.google.analytics.admin.v1alpha.LinkProposalStatusDetails link_proposal_status_details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LinkProposalStatusDetailsOrBuilder

getName()

public String getName()

Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

Note: proposalId is not the Display & Video 360 Advertiser ID

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

Note: proposalId is not the Display & Video 360 Advertiser ID

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DisplayVideo360AdvertiserLinkProposal> getParserForType()
Returns
Type Description
Parser<DisplayVideo360AdvertiserLinkProposal>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValidationEmail()

public String getValidationEmail()

Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal.

string validation_email = 5 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
String

The validationEmail.

getValidationEmailBytes()

public ByteString getValidationEmailBytes()

Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal.

string validation_email = 5 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The bytes for validationEmail.

hasAdsPersonalizationEnabled()

public boolean hasAdsPersonalizationEnabled()

Immutable. 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 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the adsPersonalizationEnabled field is set.

hasCampaignDataSharingEnabled()

public boolean hasCampaignDataSharingEnabled()

Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.

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

Returns
Type Description
boolean

Whether the campaignDataSharingEnabled field is set.

hasCostDataSharingEnabled()

public boolean hasCostDataSharingEnabled()

Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true.

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

Returns
Type Description
boolean

Whether the costDataSharingEnabled field is set.

hasLinkProposalStatusDetails()

public boolean hasLinkProposalStatusDetails()

Output only. The status information for this link proposal.

.google.analytics.admin.v1alpha.LinkProposalStatusDetails link_proposal_status_details = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the linkProposalStatusDetails field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DisplayVideo360AdvertiserLinkProposal.Builder newBuilderForType()
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DisplayVideo360AdvertiserLinkProposal.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DisplayVideo360AdvertiserLinkProposal.Builder toBuilder()
Returns
Type Description
DisplayVideo360AdvertiserLinkProposal.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException