REST Resource: properties.displayVideo360AdvertiserLinkProposals

Resource: DisplayVideo360AdvertiserLinkProposal

A proposal for a link between an 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.

JSON representation
{
  "name": string,
  "advertiserId": string,
  "linkProposalStatusDetails": {
    object (LinkProposalStatusDetails)
  },
  "advertiserDisplayName": string,
  "validationEmail": string,
  "adsPersonalizationEnabled": boolean,
  "campaignDataSharingEnabled": boolean,
  "costDataSharingEnabled": boolean
}
Fields
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

advertiserId

string

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

advertiserDisplayName

string

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

validationEmail

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.

adsPersonalizationEnabled

boolean

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

campaignDataSharingEnabled

boolean

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.

costDataSharingEnabled

boolean

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

LinkProposalStatusDetails

Status information for a link proposal.

JSON representation
{
  "linkProposalInitiatingProduct": enum (LinkProposalInitiatingProduct),
  "requestorEmail": string,
  "linkProposalState": enum (LinkProposalState)
}
Fields
requestorEmail

string

Output only. The email address of the user that proposed this linkage.

LinkProposalInitiatingProduct

An indication of which product the user initiated a link proposal from.

Enums
GOOGLE_ANALYTICS This proposal was created by a user from Google Analytics.
LINKED_PRODUCT This proposal was created by a user from a linked product (not Google Analytics).

LinkProposalState

The state of a link proposal resource.

Enums
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS This proposal is awaiting review from a Google Analytics user. This proposal will automatically expire after some time.
AWAITING_REVIEW_FROM_LINKED_PRODUCT This proposal is awaiting review from a user of a linked product. This proposal will automatically expire after some time.
WITHDRAWN This proposal has been withdrawn by an admin on the initiating product. This proposal will be automatically deleted after some time.
DECLINED This proposal has been declined by an admin on the receiving product. This proposal will be automatically deleted after some time.
EXPIRED This proposal expired due to lack of response from an admin on the receiving product. This proposal will be automatically deleted after some time.
OBSOLETE This proposal has become obsolete because a link was directly created to the same external product resource that this proposal specifies. This proposal will be automatically deleted after some time.

Methods

approve

Approves a DisplayVideo360AdvertiserLinkProposal.

cancel

Cancels a DisplayVideo360AdvertiserLinkProposal.

create

Creates a DisplayVideo360AdvertiserLinkProposal.

delete

Deletes a DisplayVideo360AdvertiserLinkProposal on a property.

get

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

list

Lists DisplayVideo360AdvertiserLinkProposals on a property.