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="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.webPropertyAdWordsLinks.html">webPropertyAdWordsLinks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(accountId, webPropertyId, webPropertyAdWordsLinkId)</a></code></p> 82<p class="firstline">Deletes a web property-Google Ads link.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(accountId, webPropertyId, webPropertyAdWordsLinkId)</a></code></p> 85<p class="firstline">Returns a web property-Google Ads link to which the user has access.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p> 88<p class="firstline">Creates a webProperty-Google Ads link.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p> 91<p class="firstline">Lists webProperty-Google Ads links for a given web property.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</a></code></p> 94<p class="firstline">Updates an existing webProperty-Google Ads link. This method supports patch semantics.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</a></code></p> 97<p class="firstline">Updates an existing webProperty-Google Ads link.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(accountId, webPropertyId, webPropertyAdWordsLinkId)</code> 106 <pre>Deletes a web property-Google Ads link. 107 108Args: 109 accountId: string, ID of the account which the given web property belongs to. (required) 110 webPropertyId: string, Web property ID to delete the Google Ads link for. (required) 111 webPropertyAdWordsLinkId: string, Web property Google Ads link ID. (required) 112</pre> 113</div> 114 115<div class="method"> 116 <code class="details" id="get">get(accountId, webPropertyId, webPropertyAdWordsLinkId)</code> 117 <pre>Returns a web property-Google Ads link to which the user has access. 118 119Args: 120 accountId: string, ID of the account which the given web property belongs to. (required) 121 webPropertyId: string, Web property ID to retrieve the Google Ads link for. (required) 122 webPropertyAdWordsLinkId: string, Web property-Google Ads link ID. (required) 123 124Returns: 125 An object of the form: 126 127 { # JSON template for Analytics Entity Google Ads Link. 128 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 129 { # JSON template for an Google Ads account. 130 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 131 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 132 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 133 }, 134 ], 135 "entity": { # Web property being linked. 136 "webPropertyRef": { # JSON template for a web property reference. 137 "accountId": "A String", # Account ID to which this web property belongs. 138 "href": "A String", # Link for this web property. 139 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 140 "internalWebPropertyId": "A String", # Internal ID for this web property. 141 "kind": "analytics#webPropertyRef", # Analytics web property reference. 142 "name": "A String", # Name of this web property. 143 }, 144 }, 145 "id": "A String", # Entity Google Ads link ID 146 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 147 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 148 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 149 "A String", 150 ], 151 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 152}</pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code> 157 <pre>Creates a webProperty-Google Ads link. 158 159Args: 160 accountId: string, ID of the Google Analytics account to create the link for. (required) 161 webPropertyId: string, Web property ID to create the link for. (required) 162 body: object, The request body. 163 The object takes the form of: 164 165{ # JSON template for Analytics Entity Google Ads Link. 166 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 167 { # JSON template for an Google Ads account. 168 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 169 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 170 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 171 }, 172 ], 173 "entity": { # Web property being linked. 174 "webPropertyRef": { # JSON template for a web property reference. 175 "accountId": "A String", # Account ID to which this web property belongs. 176 "href": "A String", # Link for this web property. 177 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 178 "internalWebPropertyId": "A String", # Internal ID for this web property. 179 "kind": "analytics#webPropertyRef", # Analytics web property reference. 180 "name": "A String", # Name of this web property. 181 }, 182 }, 183 "id": "A String", # Entity Google Ads link ID 184 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 185 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 186 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 187 "A String", 188 ], 189 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 190} 191 192 193Returns: 194 An object of the form: 195 196 { # JSON template for Analytics Entity Google Ads Link. 197 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 198 { # JSON template for an Google Ads account. 199 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 200 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 201 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 202 }, 203 ], 204 "entity": { # Web property being linked. 205 "webPropertyRef": { # JSON template for a web property reference. 206 "accountId": "A String", # Account ID to which this web property belongs. 207 "href": "A String", # Link for this web property. 208 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 209 "internalWebPropertyId": "A String", # Internal ID for this web property. 210 "kind": "analytics#webPropertyRef", # Analytics web property reference. 211 "name": "A String", # Name of this web property. 212 }, 213 }, 214 "id": "A String", # Entity Google Ads link ID 215 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 216 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 217 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 218 "A String", 219 ], 220 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 221}</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code> 226 <pre>Lists webProperty-Google Ads links for a given web property. 227 228Args: 229 accountId: string, ID of the account which the given web property belongs to. (required) 230 webPropertyId: string, Web property ID to retrieve the Google Ads links for. (required) 231 max_results: integer, The maximum number of webProperty-Google Ads links to include in this response. 232 start_index: integer, An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. 233 234Returns: 235 An object of the form: 236 237 { # An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link. 238 "items": [ # A list of entity Google Ads links. 239 { # JSON template for Analytics Entity Google Ads Link. 240 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 241 { # JSON template for an Google Ads account. 242 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 243 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 244 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 245 }, 246 ], 247 "entity": { # Web property being linked. 248 "webPropertyRef": { # JSON template for a web property reference. 249 "accountId": "A String", # Account ID to which this web property belongs. 250 "href": "A String", # Link for this web property. 251 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 252 "internalWebPropertyId": "A String", # Internal ID for this web property. 253 "kind": "analytics#webPropertyRef", # Analytics web property reference. 254 "name": "A String", # Name of this web property. 255 }, 256 }, 257 "id": "A String", # Entity Google Ads link ID 258 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 259 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 260 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 261 "A String", 262 ], 263 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 264 }, 265 ], 266 "itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. 267 "kind": "analytics#entityAdWordsLinks", # Collection type. 268 "nextLink": "A String", # Next link for this Google Ads link collection. 269 "previousLink": "A String", # Previous link for this Google Ads link collection. 270 "startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. 271 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. 272}</pre> 273</div> 274 275<div class="method"> 276 <code class="details" id="patch">patch(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</code> 277 <pre>Updates an existing webProperty-Google Ads link. This method supports patch semantics. 278 279Args: 280 accountId: string, ID of the account which the given web property belongs to. (required) 281 webPropertyId: string, Web property ID to retrieve the Google Ads link for. (required) 282 webPropertyAdWordsLinkId: string, Web property-Google Ads link ID. (required) 283 body: object, The request body. 284 The object takes the form of: 285 286{ # JSON template for Analytics Entity Google Ads Link. 287 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 288 { # JSON template for an Google Ads account. 289 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 290 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 291 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 292 }, 293 ], 294 "entity": { # Web property being linked. 295 "webPropertyRef": { # JSON template for a web property reference. 296 "accountId": "A String", # Account ID to which this web property belongs. 297 "href": "A String", # Link for this web property. 298 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 299 "internalWebPropertyId": "A String", # Internal ID for this web property. 300 "kind": "analytics#webPropertyRef", # Analytics web property reference. 301 "name": "A String", # Name of this web property. 302 }, 303 }, 304 "id": "A String", # Entity Google Ads link ID 305 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 306 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 307 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 308 "A String", 309 ], 310 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 311} 312 313 314Returns: 315 An object of the form: 316 317 { # JSON template for Analytics Entity Google Ads Link. 318 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 319 { # JSON template for an Google Ads account. 320 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 321 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 322 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 323 }, 324 ], 325 "entity": { # Web property being linked. 326 "webPropertyRef": { # JSON template for a web property reference. 327 "accountId": "A String", # Account ID to which this web property belongs. 328 "href": "A String", # Link for this web property. 329 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 330 "internalWebPropertyId": "A String", # Internal ID for this web property. 331 "kind": "analytics#webPropertyRef", # Analytics web property reference. 332 "name": "A String", # Name of this web property. 333 }, 334 }, 335 "id": "A String", # Entity Google Ads link ID 336 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 337 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 338 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 339 "A String", 340 ], 341 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 342}</pre> 343</div> 344 345<div class="method"> 346 <code class="details" id="update">update(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</code> 347 <pre>Updates an existing webProperty-Google Ads link. 348 349Args: 350 accountId: string, ID of the account which the given web property belongs to. (required) 351 webPropertyId: string, Web property ID to retrieve the Google Ads link for. (required) 352 webPropertyAdWordsLinkId: string, Web property-Google Ads link ID. (required) 353 body: object, The request body. 354 The object takes the form of: 355 356{ # JSON template for Analytics Entity Google Ads Link. 357 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 358 { # JSON template for an Google Ads account. 359 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 360 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 361 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 362 }, 363 ], 364 "entity": { # Web property being linked. 365 "webPropertyRef": { # JSON template for a web property reference. 366 "accountId": "A String", # Account ID to which this web property belongs. 367 "href": "A String", # Link for this web property. 368 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 369 "internalWebPropertyId": "A String", # Internal ID for this web property. 370 "kind": "analytics#webPropertyRef", # Analytics web property reference. 371 "name": "A String", # Name of this web property. 372 }, 373 }, 374 "id": "A String", # Entity Google Ads link ID 375 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 376 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 377 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 378 "A String", 379 ], 380 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 381} 382 383 384Returns: 385 An object of the form: 386 387 { # JSON template for Analytics Entity Google Ads Link. 388 "adWordsAccounts": [ # A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. 389 { # JSON template for an Google Ads account. 390 "autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. 391 "customerId": "A String", # Customer ID. This field is required when creating a Google Ads link. 392 "kind": "analytics#adWordsAccount", # Resource type for Google Ads account. 393 }, 394 ], 395 "entity": { # Web property being linked. 396 "webPropertyRef": { # JSON template for a web property reference. 397 "accountId": "A String", # Account ID to which this web property belongs. 398 "href": "A String", # Link for this web property. 399 "id": "A String", # Web property ID of the form UA-XXXXX-YY. 400 "internalWebPropertyId": "A String", # Internal ID for this web property. 401 "kind": "analytics#webPropertyRef", # Analytics web property reference. 402 "name": "A String", # Name of this web property. 403 }, 404 }, 405 "id": "A String", # Entity Google Ads link ID 406 "kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link. 407 "name": "A String", # Name of the link. This field is required when creating a Google Ads link. 408 "profileIds": [ # IDs of linked Views (Profiles) represented as strings. 409 "A String", 410 ], 411 "selfLink": "A String", # URL link for this Google Analytics - Google Ads link. 412}</pre> 413</div> 414 415</body></html>