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

blob: 2415b39193abe8b6b3c069502253a58249b90beb [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></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="analyticsadmin_v1alpha.properties.androidAppDataStreams.html">androidAppDataStreams()</a></code>
				79	</p>
				80	<p class="firstline">Returns the androidAppDataStreams Resource.</p>
				81
				82	<p class="toc_element">
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	83	<code><a href="analyticsadmin_v1alpha.properties.conversionEvents.html">conversionEvents()</a></code>
				84	</p>
				85	<p class="firstline">Returns the conversionEvents Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="analyticsadmin_v1alpha.properties.customDimensions.html">customDimensions()</a></code>
				89	</p>
				90	<p class="firstline">Returns the customDimensions Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="analyticsadmin_v1alpha.properties.customMetrics.html">customMetrics()</a></code>
				94	</p>
				95	<p class="firstline">Returns the customMetrics Resource.</p>
				96
				97	<p class="toc_element">
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	98	<code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html">displayVideo360AdvertiserLinkProposals()</a></code>
				99	</p>
				100	<p class="firstline">Returns the displayVideo360AdvertiserLinkProposals Resource.</p>
				101
				102	<p class="toc_element">
				103	<code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html">displayVideo360AdvertiserLinks()</a></code>
				104	</p>
				105	<p class="firstline">Returns the displayVideo360AdvertiserLinks Resource.</p>
				106
				107	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<code><a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks()</a></code>
				109	</p>
				110	<p class="firstline">Returns the firebaseLinks Resource.</p>
				111
				112	<p class="toc_element">
				113	<code><a href="analyticsadmin_v1alpha.properties.googleAdsLinks.html">googleAdsLinks()</a></code>
				114	</p>
				115	<p class="firstline">Returns the googleAdsLinks Resource.</p>
				116
				117	<p class="toc_element">
				118	<code><a href="analyticsadmin_v1alpha.properties.iosAppDataStreams.html">iosAppDataStreams()</a></code>
				119	</p>
				120	<p class="firstline">Returns the iosAppDataStreams Resource.</p>
				121
				122	<p class="toc_element">
				123	<code><a href="analyticsadmin_v1alpha.properties.userLinks.html">userLinks()</a></code>
				124	</p>
				125	<p class="firstline">Returns the userLinks Resource.</p>
				126
				127	<p class="toc_element">
				128	<code><a href="analyticsadmin_v1alpha.properties.webDataStreams.html">webDataStreams()</a></code>
				129	</p>
				130	<p class="firstline">Returns the webDataStreams Resource.</p>
				131
				132	<p class="toc_element">
				133	<code><a href="#close">close()</a></code></p>
				134	<p class="firstline">Close httplib2 connections.</p>
				135	<p class="toc_element">
				136	<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	137	<p class="firstline">Creates an "GA4" property with the specified location and attributes.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	138	<p class="toc_element">
				139	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	140	<p class="firstline">Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	141	<p class="toc_element">
				142	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	143	<p class="firstline">Lookup for a single "GA4" Property.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	144	<p class="toc_element">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	145	<code><a href="#getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</a></code></p>
				146	<p class="firstline">Returns the singleton data retention settings for this property.</p>
				147	<p class="toc_element">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	148	<code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
				149	<p class="firstline">Lookup for Google Signals settings for a property.</p>
				150	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	151	<code><a href="#list">list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	152	<p class="firstline">Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	153	<p class="toc_element">
				154	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				155	<p class="firstline">Retrieves the next page of results.</p>
				156	<p class="toc_element">
				157	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				158	<p class="firstline">Updates a property.</p>
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	159	<p class="toc_element">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	160	<code><a href="#updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				161	<p class="firstline">Updates the singleton data retention settings for this property.</p>
				162	<p class="toc_element">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	163	<code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				164	<p class="firstline">Updates Google Signals settings for a property.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	165	<h3>Method Details</h3>
				166	<div class="method">
				167	<code class="details" id="close">close()</code>
				168	<pre>Close httplib2 connections.</pre>
				169	</div>
				170
				171	<div class="method">
				172	<code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	173	<pre>Creates an "GA4" property with the specified location and attributes.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	174
				175	Args:
				176	body: object, The request body.
				177	The object takes the form of:
				178
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	179	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	180	"createTime": "A String", # Output only. Time when the entity was originally created.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	181	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	182	"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	183	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	184	"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	185	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				186	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	187	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	188	"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	189	"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	190	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	191	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	192
				193	x__xgafv: string, V1 error format.
				194	Allowed values
				195	1 - v1 error format
				196	2 - v2 error format
				197
				198	Returns:
				199	An object of the form:
				200
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	201	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	202	"createTime": "A String", # Output only. Time when the entity was originally created.
				203	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	204	"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	205	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	206	"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	207	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				208	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				209	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	210	"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	211	"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	212	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				213	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	214	</div>
				215
				216	<div class="method">
				217	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	218	<pre>Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	219
				220	Args:
				221	name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000" (required)
				222	x__xgafv: string, V1 error format.
				223	Allowed values
				224	1 - v1 error format
				225	2 - v2 error format
				226
				227	Returns:
				228	An object of the form:
				229
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	230	{ # A resource message representing a Google Analytics GA4 property.
				231	"createTime": "A String", # Output only. Time when the entity was originally created.
				232	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
				233	"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
				234	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
				235	"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
				236	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				237	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				238	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	239	"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	240	"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
				241	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	242	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	243	</div>
				244
				245	<div class="method">
				246	<code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	247	<pre>Lookup for a single "GA4" Property.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	248
				249	Args:
				250	name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000" (required)
				251	x__xgafv: string, V1 error format.
				252	Allowed values
				253	1 - v1 error format
				254	2 - v2 error format
				255
				256	Returns:
				257	An object of the form:
				258
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	259	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	260	"createTime": "A String", # Output only. Time when the entity was originally created.
				261	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	262	"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	263	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	264	"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	265	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				266	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				267	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	268	"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	269	"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	270	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				271	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	272	</div>
				273
				274	<div class="method">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	275	<code class="details" id="getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</code>
				276	<pre>Returns the singleton data retention settings for this property.
				277
				278	Args:
				279	name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings" (required)
				280	x__xgafv: string, V1 error format.
				281	Allowed values
				282	1 - v1 error format
				283	2 - v2 error format
				284
				285	Returns:
				286	An object of the form:
				287
				288	{ # Settings values for data retention. This is a singleton resource.
				289	"eventDataRetention": "A String", # The length of time that event-level data is retained.
				290	"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
				291	"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
				292	}</pre>
				293	</div>
				294
				295	<div class="method">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	296	<code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
				297	<pre>Lookup for Google Signals settings for a property.
				298
				299	Args:
				300	name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
				301	x__xgafv: string, V1 error format.
				302	Allowed values
				303	1 - v1 error format
				304	2 - v2 error format
				305
				306	Returns:
				307	An object of the form:
				308
				309	{ # Settings values for Google Signals. This is a singleton resource.
				310	"consent": "A String", # Output only. Terms of Service acceptance.
				311	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				312	"state": "A String", # Status of this setting.
				313	}</pre>
				314	</div>
				315
				316	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	317	<code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	318	<pre>Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	319
				320	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	321	filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` \| Filter \| Description \| \|-----------------------------\|-------------------------------------------\| \| parent:accounts/123 \| The account with account id: 123. \| \| firebase_project:project-id \| The firebase project with id: project-id. \| \| firebase_project:123 \| The firebase project with number: 123. \| ```
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	322	pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
				323	pageToken: string, A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	324	showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	325	x__xgafv: string, V1 error format.
				326	Allowed values
				327	1 - v1 error format
				328	2 - v2 error format
				329
				330	Returns:
				331	An object of the form:
				332
				333	{ # Response message for ListProperties RPC.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	334	"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.
				335	"properties": [ # Results that matched the filter criteria and were accessible to the caller.
				336	{ # A resource message representing a Google Analytics GA4 property.
				337	"createTime": "A String", # Output only. Time when the entity was originally created.
				338	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	339	"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	340	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	341	"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	342	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				343	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				344	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	345	"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	346	"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	347	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				348	},
				349	],
				350	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	351	</div>
				352
				353	<div class="method">
				354	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				355	<pre>Retrieves the next page of results.
				356
				357	Args:
				358	previous_request: The request for the previous page. (required)
				359	previous_response: The response from the request for the previous page. (required)
				360
				361	Returns:
				362	A request object that you can call 'execute()' on to request the next
				363	page. Returns None if there are no more items in the collection.
				364	</pre>
				365	</div>
				366
				367	<div class="method">
				368	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				369	<pre>Updates a property.
				370
				371	Args:
				372	name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
				373	body: object, The request body.
				374	The object takes the form of:
				375
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	376	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	377	"createTime": "A String", # Output only. Time when the entity was originally created.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	378	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	379	"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	380	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	381	"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	382	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				383	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	384	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	385	"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	386	"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	387	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	388	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	389
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	390	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]	391	x__xgafv: string, V1 error format.
				392	Allowed values
				393	1 - v1 error format
				394	2 - v2 error format
				395
				396	Returns:
				397	An object of the form:
				398
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	399	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	400	"createTime": "A String", # Output only. Time when the entity was originally created.
				401	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	402	"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	403	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	404	"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	405	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				406	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				407	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
yoshi-code-bot	1a4514d	2021-07-13 00:20:24 -0700	[diff] [blame]	408	"serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	409	"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	410	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				411	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	412	</div>
				413
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	414	<div class="method">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	415	<code class="details" id="updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
				416	<pre>Updates the singleton data retention settings for this property.
				417
				418	Args:
				419	name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
				420	body: object, The request body.
				421	The object takes the form of:
				422
				423	{ # Settings values for data retention. This is a singleton resource.
				424	"eventDataRetention": "A String", # The length of time that event-level data is retained.
				425	"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
				426	"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
				427	}
				428
				429	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.
				430	x__xgafv: string, V1 error format.
				431	Allowed values
				432	1 - v1 error format
				433	2 - v2 error format
				434
				435	Returns:
				436	An object of the form:
				437
				438	{ # Settings values for data retention. This is a singleton resource.
				439	"eventDataRetention": "A String", # The length of time that event-level data is retained.
				440	"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
				441	"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
				442	}</pre>
				443	</div>
				444
				445	<div class="method">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	446	<code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
				447	<pre>Updates Google Signals settings for a property.
				448
				449	Args:
				450	name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings" (required)
				451	body: object, The request body.
				452	The object takes the form of:
				453
				454	{ # Settings values for Google Signals. This is a singleton resource.
				455	"consent": "A String", # Output only. Terms of Service acceptance.
				456	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				457	"state": "A String", # Status of this setting.
				458	}
				459
				460	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.
				461	x__xgafv: string, V1 error format.
				462	Allowed values
				463	1 - v1 error format
				464	2 - v2 error format
				465
				466	Returns:
				467	An object of the form:
				468
				469	{ # Settings values for Google Signals. This is a singleton resource.
				470	"consent": "A String", # Output only. Terms of Service acceptance.
				471	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				472	"state": "A String", # Status of this setting.
				473	}</pre>
				474	</div>
				475
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	476	</body></html>