1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html">displayVideo360AdvertiserLinkProposals</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.</p> 80<p class="toc_element"> 81 <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.</p> 83<p class="toc_element"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a DisplayVideo360AdvertiserLinkProposal.</p> 89<p class="toc_element"> 90 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Lookup for a single DisplayVideo360AdvertiserLinkProposal.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists DisplayVideo360AdvertiserLinkProposals on a property.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code> 104 <pre>Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created. 105 106Args: 107 name: string, Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 (required) 108 body: object, The request body. 109 The object takes the form of: 110 111{ # Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. 112} 113 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. 123 "displayVideo360AdvertiserLink": { # A link between a GA4 property and a Display & Video 360 advertiser. # The DisplayVideo360AdvertiserLink created as a result of approving the proposal. 124 "adsPersonalizationEnabled": True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true. 125 "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video 360 Advertiser. 126 "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. 127 "campaignDataSharingEnabled": True or False, # Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. 128 "costDataSharingEnabled": True or False, # Immutable. Enables the import of cost data from Display & Video 360 into 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 Display & Video 360 product. If this field is not set on create, it will be defaulted to true. 129 "name": "A String", # Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID 130 }, 131}</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code> 136 <pre>Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically. 137 138Args: 139 name: string, Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 (required) 140 body: object, The request body. 141 The object takes the form of: 142 143{ # Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC. 144} 145 146 x__xgafv: string, V1 error format. 147 Allowed values 148 1 - v1 error format 149 2 - v2 error format 150 151Returns: 152 An object of the form: 153 154 { # 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. 155 "adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. 156 "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. 157 "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. 158 "campaignDataSharingEnabled": True or False, # 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. 159 "costDataSharingEnabled": True or False, # 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. 160 "linkProposalStatusDetails": { # Status information for a link proposal. # Output only. The status information for this link proposal. 161 "linkProposalInitiatingProduct": "A String", # Output only. The source of this proposal. 162 "linkProposalState": "A String", # Output only. The state of this proposal. 163 "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. 164 }, 165 "name": "A 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 166 "validationEmail": "A 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. 167}</pre> 168</div> 169 170<div class="method"> 171 <code class="details" id="close">close()</code> 172 <pre>Close httplib2 connections.</pre> 173</div> 174 175<div class="method"> 176 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 177 <pre>Creates a DisplayVideo360AdvertiserLinkProposal. 178 179Args: 180 parent: string, Required. Example format: properties/1234 (required) 181 body: object, The request body. 182 The object takes the form of: 183 184{ # 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. 185 "adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. 186 "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. 187 "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. 188 "campaignDataSharingEnabled": True or False, # 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. 189 "costDataSharingEnabled": True or False, # 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. 190 "linkProposalStatusDetails": { # Status information for a link proposal. # Output only. The status information for this link proposal. 191 "linkProposalInitiatingProduct": "A String", # Output only. The source of this proposal. 192 "linkProposalState": "A String", # Output only. The state of this proposal. 193 "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. 194 }, 195 "name": "A 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 196 "validationEmail": "A 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. 197} 198 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # 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. 208 "adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. 209 "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. 210 "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. 211 "campaignDataSharingEnabled": True or False, # 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. 212 "costDataSharingEnabled": True or False, # 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. 213 "linkProposalStatusDetails": { # Status information for a link proposal. # Output only. The status information for this link proposal. 214 "linkProposalInitiatingProduct": "A String", # Output only. The source of this proposal. 215 "linkProposalState": "A String", # Output only. The state of this proposal. 216 "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. 217 }, 218 "name": "A 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 219 "validationEmail": "A 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. 220}</pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 225 <pre>Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals. 226 227Args: 228 name: string, Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 (required) 229 x__xgafv: string, V1 error format. 230 Allowed values 231 1 - v1 error format 232 2 - v2 error format 233 234Returns: 235 An object of the form: 236 237 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 238}</pre> 239</div> 240 241<div class="method"> 242 <code class="details" id="get">get(name, x__xgafv=None)</code> 243 <pre>Lookup for a single DisplayVideo360AdvertiserLinkProposal. 244 245Args: 246 name: string, Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678 (required) 247 x__xgafv: string, V1 error format. 248 Allowed values 249 1 - v1 error format 250 2 - v2 error format 251 252Returns: 253 An object of the form: 254 255 { # 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. 256 "adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. 257 "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. 258 "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. 259 "campaignDataSharingEnabled": True or False, # 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. 260 "costDataSharingEnabled": True or False, # 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. 261 "linkProposalStatusDetails": { # Status information for a link proposal. # Output only. The status information for this link proposal. 262 "linkProposalInitiatingProduct": "A String", # Output only. The source of this proposal. 263 "linkProposalState": "A String", # Output only. The state of this proposal. 264 "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. 265 }, 266 "name": "A 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 267 "validationEmail": "A 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. 268}</pre> 269</div> 270 271<div class="method"> 272 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 273 <pre>Lists DisplayVideo360AdvertiserLinkProposals on a property. 274 275Args: 276 parent: string, Required. Example format: properties/1234 (required) 277 pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). 278 pageToken: string, A page token, received from a previous `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinkProposals` must match the call that provided the page token. 279 x__xgafv: string, V1 error format. 280 Allowed values 281 1 - v1 error format 282 2 - v2 error format 283 284Returns: 285 An object of the form: 286 287 { # Response message for ListDisplayVideo360AdvertiserLinkProposals RPC. 288 "displayVideo360AdvertiserLinkProposals": [ # List of DisplayVideo360AdvertiserLinkProposals. 289 { # 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. 290 "adsPersonalizationEnabled": True or False, # Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. 291 "advertiserDisplayName": "A String", # Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. 292 "advertiserId": "A String", # Immutable. The Display & Video 360 Advertiser's advertiser ID. 293 "campaignDataSharingEnabled": True or False, # 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. 294 "costDataSharingEnabled": True or False, # 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. 295 "linkProposalStatusDetails": { # Status information for a link proposal. # Output only. The status information for this link proposal. 296 "linkProposalInitiatingProduct": "A String", # Output only. The source of this proposal. 297 "linkProposalState": "A String", # Output only. The state of this proposal. 298 "requestorEmail": "A String", # Output only. The email address of the user that proposed this linkage. 299 }, 300 "name": "A 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 301 "validationEmail": "A 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. 302 }, 303 ], 304 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 305}</pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 310 <pre>Retrieves the next page of results. 311 312Args: 313 previous_request: The request for the previous page. (required) 314 previous_response: The response from the request for the previous page. (required) 315 316Returns: 317 A request object that you can call 'execute()' on to request the next 318 page. Returns None if there are no more items in the collection. 319 </pre> 320</div> 321 322</body></html>