Google Analytics Admin V1alpha Client - Class DisplayVideo360AdvertiserLinkProposal (0.8.2)

Version 0.8.2

• 0.24.1 (latest)
• 0.24.0
• 0.23.0
• 0.22.5
• 0.20.0
• 0.19.0
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.2

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class DisplayVideo360AdvertiserLinkProposal.

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.

Generated from protobuf message google.analytics.admin.v1alpha.DisplayVideo360AdvertiserLinkProposal

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID
↳ advertiser_id	string Immutable. The Display & Video 360 Advertiser's advertiser ID.
↳ link_proposal_status_details	Google\Analytics\Admin\V1alpha\LinkProposalStatusDetails Output only. The status information for this link proposal.
↳ advertiser_display_name	string Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.
↳ validation_email	string 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.
↳ ads_personalization_enabled	Google\Protobuf\BoolValue Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.
↳ campaign_data_sharing_enabled	Google\Protobuf\BoolValue 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.
↳ cost_data_sharing_enabled	Google\Protobuf\BoolValue 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.

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

Returns
Type	Description
string

setName

Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource.

Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAdvertiserId

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

Returns
Type	Description
string

setAdvertiserId

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLinkProposalStatusDetails

Output only. The status information for this link proposal.

Returns
Type	Description
Google\Analytics\Admin\V1alpha\LinkProposalStatusDetails|null

hasLinkProposalStatusDetails

clearLinkProposalStatusDetails

setLinkProposalStatusDetails

Output only. The status information for this link proposal.

Parameter
Name	Description
var	Google\Analytics\Admin\V1alpha\LinkProposalStatusDetails

Returns
Type	Description
$this

getAdvertiserDisplayName

Output only. The display name of the Display & Video Advertiser.

Only populated for proposals that originated from Display & Video 360.

Returns
Type	Description
string

setAdvertiserDisplayName

Output only. The display name of the Display & Video Advertiser.

Only populated for proposals that originated from Display & Video 360.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

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.

Returns
Type	Description
string

setValidationEmail

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAdsPersonalizationEnabled

Immutable. Enables personalized advertising features with this integration.

If this field is not set on create, it will be defaulted to true.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasAdsPersonalizationEnabled

clearAdsPersonalizationEnabled

getAdsPersonalizationEnabledValue

Returns the unboxed value from getAdsPersonalizationEnabled()

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

Returns
Type	Description
bool|null

setAdsPersonalizationEnabled

Immutable. Enables personalized advertising features with this integration.

If this field is not set on create, it will be defaulted to true.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setAdsPersonalizationEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

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

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

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.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasCampaignDataSharingEnabled

clearCampaignDataSharingEnabled

getCampaignDataSharingEnabledValue

Returns the unboxed value from 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.

Returns
Type	Description
bool|null

setCampaignDataSharingEnabled

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.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setCampaignDataSharingEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

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.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

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.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasCostDataSharingEnabled

clearCostDataSharingEnabled

getCostDataSharingEnabledValue

Returns the unboxed value from 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.

Returns
Type	Description
bool|null

setCostDataSharingEnabled

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.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setCostDataSharingEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

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.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this