Blame - docs/dyn/analyticsadmin_v1alpha.properties.googleAdsLinks.html - platform/external/python/google-api-python-client

blob: a5a41271cf6119e0dc033abf82367e222190a85d [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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.googleAdsLinks.html">googleAdsLinks</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a GoogleAdsLink.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a GoogleAdsLink on a property</p>
				86	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	87	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	88	<p class="firstline">Lists GoogleAdsLinks on a property.</p>
				89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
				93	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Updates a GoogleAdsLink on a property</p>
				95	<h3>Method Details</h3>
				96	<div class="method">
				97	<code class="details" id="close">close()</code>
				98	<pre>Close httplib2 connections.</pre>
				99	</div>
				100
				101	<div class="method">
				102	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				103	<pre>Creates a GoogleAdsLink.
				104
				105	Args:
				106	parent: string, Required. Example format: properties/1234 (required)
				107	body: object, The request body.
				108	The object takes the form of:
				109
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	110	{ # A link between an GA4 property and a Google Ads account.
yoshi-code-bot	3fd11cb	2021-04-28 05:44:03 -0700	[diff] [blame]	111	"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	112	"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
				113	"createTime": "A String", # Output only. Time when this link was originally created.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame]	114	"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	115	"customerId": "A String", # Immutable. Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	116	"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	117	"updateTime": "A String", # Output only. Time when this link was last updated.
				118	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119
				120	x__xgafv: string, V1 error format.
				121	Allowed values
				122	1 - v1 error format
				123	2 - v2 error format
				124
				125	Returns:
				126	An object of the form:
				127
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	128	{ # A link between an GA4 property and a Google Ads account.
yoshi-code-bot	3fd11cb	2021-04-28 05:44:03 -0700	[diff] [blame]	129	"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	130	"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
				131	"createTime": "A String", # Output only. Time when this link was originally created.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame]	132	"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	133	"customerId": "A String", # Immutable. Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	134	"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	135	"updateTime": "A String", # Output only. Time when this link was last updated.
				136	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137	</div>
				138
				139	<div class="method">
				140	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				141	<pre>Deletes a GoogleAdsLink on a property
				142
				143	Args:
				144	name: string, Required. Example format: properties/1234/googleAdsLinks/5678 (required)
				145	x__xgafv: string, V1 error format.
				146	Allowed values
				147	1 - v1 error format
				148	2 - v2 error format
				149
				150	Returns:
				151	An object of the form:
				152
				153	{ # 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 `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	154	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	155	</div>
				156
				157	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	158	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	159	<pre>Lists GoogleAdsLinks on a property.
				160
				161	Args:
				162	parent: string, Required. Example format: properties/1234 (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	163	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).
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	164	pageToken: string, A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	165	x__xgafv: string, V1 error format.
				166	Allowed values
				167	1 - v1 error format
				168	2 - v2 error format
				169
				170	Returns:
				171	An object of the form:
				172
				173	{ # Response message for ListGoogleAdsLinks RPC.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	174	"googleAdsLinks": [ # List of GoogleAdsLinks.
				175	{ # A link between an GA4 property and a Google Ads account.
yoshi-code-bot	3fd11cb	2021-04-28 05:44:03 -0700	[diff] [blame]	176	"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	177	"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
				178	"createTime": "A String", # Output only. Time when this link was originally created.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame]	179	"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	180	"customerId": "A String", # Immutable. Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	181	"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	182	"updateTime": "A String", # Output only. Time when this link was last updated.
				183	},
				184	],
				185	"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.
				186	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	187	</div>
				188
				189	<div class="method">
				190	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				191	<pre>Retrieves the next page of results.
				192
				193	Args:
				194	previous_request: The request for the previous page. (required)
				195	previous_response: The response from the request for the previous page. (required)
				196
				197	Returns:
				198	A request object that you can call 'execute()' on to request the next
				199	page. Returns None if there are no more items in the collection.
				200	</pre>
				201	</div>
				202
				203	<div class="method">
				204	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				205	<pre>Updates a GoogleAdsLink on a property
				206
				207	Args:
				208	name: string, Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. (required)
				209	body: object, The request body.
				210	The object takes the form of:
				211
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	212	{ # A link between an GA4 property and a Google Ads account.
yoshi-code-bot	3fd11cb	2021-04-28 05:44:03 -0700	[diff] [blame]	213	"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	214	"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
				215	"createTime": "A String", # Output only. Time when this link was originally created.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame]	216	"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	217	"customerId": "A String", # Immutable. Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	218	"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	219	"updateTime": "A String", # Output only. Time when this link was last updated.
				220	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	221
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	222	updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	223	x__xgafv: string, V1 error format.
				224	Allowed values
				225	1 - v1 error format
				226	2 - v2 error format
				227
				228	Returns:
				229	An object of the form:
				230
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	231	{ # A link between an GA4 property and a Google Ads account.
yoshi-code-bot	3fd11cb	2021-04-28 05:44:03 -0700	[diff] [blame]	232	"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	233	"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
				234	"createTime": "A String", # Output only. Time when this link was originally created.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame]	235	"creatorEmailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	236	"customerId": "A String", # Immutable. Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	238	"updateTime": "A String", # Output only. Time when this link was last updated.
				239	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	240	</div>
				241
				242	</body></html>