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