1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(accountId, webPropertyId, webPropertyAdWordsLinkId)</a></code></p>
<p class="firstline">Deletes a web property-Google Ads link.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId, webPropertyAdWordsLinkId)</a></code></p>
<p class="firstline">Returns a web property-Google Ads link to which the user has access.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p>
<p class="firstline">Creates a webProperty-Google Ads link.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists webProperty-Google Ads links for a given web property.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</a></code></p>
<p class="firstline">Updates an existing webProperty-Google Ads link. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</a></code></p>
<p class="firstline">Updates an existing webProperty-Google Ads link.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(accountId, webPropertyId, webPropertyAdWordsLinkId)</code>
<pre>Deletes a web property-Google Ads link.
Args:
accountId: string, ID of the account which the given web property belongs to. (required)
webPropertyId: string, Web property ID to delete the Google Ads link for. (required)
webPropertyAdWordsLinkId: string, Web property Google Ads link ID. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, webPropertyId, webPropertyAdWordsLinkId)</code>
<pre>Returns a web property-Google Ads link to which the user has access.
Args:
accountId: string, ID of the account which the given web property belongs to. (required)
webPropertyId: string, Web property ID to retrieve the Google Ads link for. (required)
webPropertyAdWordsLinkId: string, Web property-Google Ads link ID. (required)
Returns:
An object of the form:
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code>
<pre>Creates a webProperty-Google Ads link.
Args:
accountId: string, ID of the Google Analytics account to create the link for. (required)
webPropertyId: string, Web property ID to create the link for. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
}
Returns:
An object of the form:
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
<pre>Lists webProperty-Google Ads links for a given web property.
Args:
accountId: string, ID of the account which the given web property belongs to. (required)
webPropertyId: string, Web property ID to retrieve the Google Ads links for. (required)
max_results: integer, The maximum number of webProperty-Google Ads links to include in this response.
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.
Returns:
An object of the form:
{ # An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link.
"items": [ # A list of entity Google Ads links.
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
},
],
"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.
"kind": "analytics#entityAdWordsLinks", # Collection type.
"nextLink": "A String", # Next link for this Google Ads link collection.
"previousLink": "A String", # Previous link for this Google Ads link collection.
"startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</code>
<pre>Updates an existing webProperty-Google Ads link. This method supports patch semantics.
Args:
accountId: string, ID of the account which the given web property belongs to. (required)
webPropertyId: string, Web property ID to retrieve the Google Ads link for. (required)
webPropertyAdWordsLinkId: string, Web property-Google Ads link ID. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
}
Returns:
An object of the form:
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, webPropertyId, webPropertyAdWordsLinkId, body=None)</code>
<pre>Updates an existing webProperty-Google Ads link.
Args:
accountId: string, ID of the account which the given web property belongs to. (required)
webPropertyId: string, Web property ID to retrieve the Google Ads link for. (required)
webPropertyAdWordsLinkId: string, Web property-Google Ads link ID. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
}
Returns:
An object of the form:
{ # JSON template for Analytics Entity Google Ads Link.
"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.
{ # JSON template for an Google Ads account.
"autoTaggingEnabled": True or False, # True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.
"customerId": "A String", # Customer ID. This field is required when creating a Google Ads link.
"kind": "analytics#adWordsAccount", # Resource type for Google Ads account.
},
],
"entity": { # Web property being linked.
"webPropertyRef": { # JSON template for a web property reference.
"accountId": "A String", # Account ID to which this web property belongs.
"href": "A String", # Link for this web property.
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"kind": "analytics#webPropertyRef", # Analytics web property reference.
"name": "A String", # Name of this web property.
},
},
"id": "A String", # Entity Google Ads link ID
"kind": "analytics#entityAdWordsLink", # Resource type for entity Google Ads link.
"name": "A String", # Name of the link. This field is required when creating a Google Ads link.
"profileIds": [ # IDs of linked Views (Profiles) represented as strings.
"A String",
],
"selfLink": "A String", # URL link for this Google Analytics - Google Ads link.
}</pre>
</div>
</body></html>
|
