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

blob: 8d54cf47c00c43dd7512dcce05797bb56fd79443 [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	8595441	2021-12-06 23:26:37 -0800	[diff] [blame]	98	<code><a href="analyticsadmin_v1alpha.properties.dataStreams.html">dataStreams()</a></code>
				99	</p>
				100	<p class="firstline">Returns the dataStreams Resource.</p>
				101
				102	<p class="toc_element">
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	103	<code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html">displayVideo360AdvertiserLinkProposals()</a></code>
				104	</p>
				105	<p class="firstline">Returns the displayVideo360AdvertiserLinkProposals Resource.</p>
				106
				107	<p class="toc_element">
				108	<code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html">displayVideo360AdvertiserLinks()</a></code>
				109	</p>
				110	<p class="firstline">Returns the displayVideo360AdvertiserLinks Resource.</p>
				111
				112	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	113	<code><a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks()</a></code>
				114	</p>
				115	<p class="firstline">Returns the firebaseLinks Resource.</p>
				116
				117	<p class="toc_element">
				118	<code><a href="analyticsadmin_v1alpha.properties.googleAdsLinks.html">googleAdsLinks()</a></code>
				119	</p>
				120	<p class="firstline">Returns the googleAdsLinks Resource.</p>
				121
				122	<p class="toc_element">
				123	<code><a href="analyticsadmin_v1alpha.properties.iosAppDataStreams.html">iosAppDataStreams()</a></code>
				124	</p>
				125	<p class="firstline">Returns the iosAppDataStreams Resource.</p>
				126
				127	<p class="toc_element">
				128	<code><a href="analyticsadmin_v1alpha.properties.userLinks.html">userLinks()</a></code>
				129	</p>
				130	<p class="firstline">Returns the userLinks Resource.</p>
				131
				132	<p class="toc_element">
				133	<code><a href="analyticsadmin_v1alpha.properties.webDataStreams.html">webDataStreams()</a></code>
				134	</p>
				135	<p class="firstline">Returns the webDataStreams Resource.</p>
				136
				137	<p class="toc_element">
yoshi-code-bot	1c9dcfd	2021-10-12 00:20:31 -0700	[diff] [blame]	138	<code><a href="#acknowledgeUserDataCollection">acknowledgeUserDataCollection(property, body=None, x__xgafv=None)</a></code></p>
				139	<p class="firstline">Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.</p>
				140	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	141	<code><a href="#close">close()</a></code></p>
				142	<p class="firstline">Close httplib2 connections.</p>
				143	<p class="toc_element">
				144	<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]	145	<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]	146	<p class="toc_element">
				147	<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]	148	<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]	149	<p class="toc_element">
				150	<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]	151	<p class="firstline">Lookup for a single "GA4" Property.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	152	<p class="toc_element">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	153	<code><a href="#getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</a></code></p>
				154	<p class="firstline">Returns the singleton data retention settings for this property.</p>
				155	<p class="toc_element">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	156	<code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
				157	<p class="firstline">Lookup for Google Signals settings for a property.</p>
				158	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	159	<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]	160	<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]	161	<p class="toc_element">
				162	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				163	<p class="firstline">Retrieves the next page of results.</p>
				164	<p class="toc_element">
				165	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				166	<p class="firstline">Updates a property.</p>
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	167	<p class="toc_element">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	168	<code><a href="#updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				169	<p class="firstline">Updates the singleton data retention settings for this property.</p>
				170	<p class="toc_element">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	171	<code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				172	<p class="firstline">Updates Google Signals settings for a property.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	173	<h3>Method Details</h3>
				174	<div class="method">
yoshi-code-bot	1c9dcfd	2021-10-12 00:20:31 -0700	[diff] [blame]	175	<code class="details" id="acknowledgeUserDataCollection">acknowledgeUserDataCollection(property, body=None, x__xgafv=None)</code>
				176	<pre>Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
				177
				178	Args:
				179	property: string, Required. The property for which to acknowledge user data collection. (required)
				180	body: object, The request body.
				181	The object takes the form of:
				182
				183	{ # Request message for AcknowledgeUserDataCollection RPC.
				184	"acknowledgement": "A String", # Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."
				185	}
				186
				187	x__xgafv: string, V1 error format.
				188	Allowed values
				189	1 - v1 error format
				190	2 - v2 error format
				191
				192	Returns:
				193	An object of the form:
				194
				195	{ # Response message for AcknowledgeUserDataCollection RPC.
				196	}</pre>
				197	</div>
				198
				199	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	200	<code class="details" id="close">close()</code>
				201	<pre>Close httplib2 connections.</pre>
				202	</div>
				203
				204	<div class="method">
				205	<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]	206	<pre>Creates an "GA4" property with the specified location and attributes.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	207
				208	Args:
				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 resource message representing a Google Analytics GA4 property.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	213	"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	214	"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]	215	"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]	216	"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]	217	"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]	218	"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]	219	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				220	"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]	221	"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]	222	"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]	223	"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]	224	"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]	225	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	226
				227	x__xgafv: string, V1 error format.
				228	Allowed values
				229	1 - v1 error format
				230	2 - v2 error format
				231
				232	Returns:
				233	An object of the form:
				234
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	235	{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	236	"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	"createTime": "A String", # Output only. Time when the entity was originally created.
				238	"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]	239	"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]	240	"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]	241	"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]	242	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				243	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				244	"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]	245	"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]	246	"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]	247	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				248	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	249	</div>
				250
				251	<div class="method">
				252	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	253	<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]	254
				255	Args:
				256	name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000" (required)
				257	x__xgafv: string, V1 error format.
				258	Allowed values
				259	1 - v1 error format
				260	2 - v2 error format
				261
				262	Returns:
				263	An object of the form:
				264
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	265	{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	266	"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	267	"createTime": "A String", # Output only. Time when the entity was originally created.
				268	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
				269	"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.
				270	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
				271	"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.
				272	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				273	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				274	"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]	275	"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]	276	"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"
				277	"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]	278	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	279	</div>
				280
				281	<div class="method">
				282	<code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	283	<pre>Lookup for a single "GA4" Property.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	284
				285	Args:
				286	name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000" (required)
				287	x__xgafv: string, V1 error format.
				288	Allowed values
				289	1 - v1 error format
				290	2 - v2 error format
				291
				292	Returns:
				293	An object of the form:
				294
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	295	{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	296	"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	297	"createTime": "A String", # Output only. Time when the entity was originally created.
				298	"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]	299	"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]	300	"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]	301	"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]	302	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				303	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				304	"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]	305	"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]	306	"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]	307	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				308	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	309	</div>
				310
				311	<div class="method">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	312	<code class="details" id="getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</code>
				313	<pre>Returns the singleton data retention settings for this property.
				314
				315	Args:
				316	name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings" (required)
				317	x__xgafv: string, V1 error format.
				318	Allowed values
				319	1 - v1 error format
				320	2 - v2 error format
				321
				322	Returns:
				323	An object of the form:
				324
				325	{ # Settings values for data retention. This is a singleton resource.
				326	"eventDataRetention": "A String", # The length of time that event-level data is retained.
				327	"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
				328	"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
				329	}</pre>
				330	</div>
				331
				332	<div class="method">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	333	<code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
				334	<pre>Lookup for Google Signals settings for a property.
				335
				336	Args:
				337	name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
				338	x__xgafv: string, V1 error format.
				339	Allowed values
				340	1 - v1 error format
				341	2 - v2 error format
				342
				343	Returns:
				344	An object of the form:
				345
				346	{ # Settings values for Google Signals. This is a singleton resource.
				347	"consent": "A String", # Output only. Terms of Service acceptance.
				348	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				349	"state": "A String", # Status of this setting.
				350	}</pre>
				351	</div>
				352
				353	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	354	<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]	355	<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]	356
				357	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	358	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]	359	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)
				360	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]	361	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]	362	x__xgafv: string, V1 error format.
				363	Allowed values
				364	1 - v1 error format
				365	2 - v2 error format
				366
				367	Returns:
				368	An object of the form:
				369
				370	{ # Response message for ListProperties RPC.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	371	"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.
				372	"properties": [ # Results that matched the filter criteria and were accessible to the caller.
				373	{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	374	"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	375	"createTime": "A String", # Output only. Time when the entity was originally created.
				376	"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]	377	"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]	378	"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]	379	"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]	380	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				381	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				382	"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]	383	"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]	384	"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]	385	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				386	},
				387	],
				388	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	389	</div>
				390
				391	<div class="method">
				392	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				393	<pre>Retrieves the next page of results.
				394
				395	Args:
				396	previous_request: The request for the previous page. (required)
				397	previous_response: The response from the request for the previous page. (required)
				398
				399	Returns:
				400	A request object that you can call 'execute()' on to request the next
				401	page. Returns None if there are no more items in the collection.
				402	</pre>
				403	</div>
				404
				405	<div class="method">
				406	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				407	<pre>Updates a property.
				408
				409	Args:
				410	name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
				411	body: object, The request body.
				412	The object takes the form of:
				413
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	414	{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	415	"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	416	"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]	417	"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]	418	"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]	419	"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]	420	"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]	421	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				422	"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]	423	"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]	424	"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]	425	"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]	426	"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]	427	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	428
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	438	{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-bot	ad81f3d	2021-09-28 00:22:30 -0700	[diff] [blame]	439	"account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	440	"createTime": "A String", # Output only. Time when the entity was originally created.
				441	"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]	442	"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]	443	"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]	444	"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]	445	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				446	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				447	"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]	448	"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]	449	"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]	450	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				451	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	452	</div>
				453
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	454	<div class="method">
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	455	<code class="details" id="updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
				456	<pre>Updates the singleton data retention settings for this property.
				457
				458	Args:
				459	name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
				460	body: object, The request body.
				461	The object takes the form of:
				462
				463	{ # Settings values for data retention. This is a singleton resource.
				464	"eventDataRetention": "A String", # The length of time that event-level data is retained.
				465	"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
				466	"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
				467	}
				468
				469	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.
				470	x__xgafv: string, V1 error format.
				471	Allowed values
				472	1 - v1 error format
				473	2 - v2 error format
				474
				475	Returns:
				476	An object of the form:
				477
				478	{ # Settings values for data retention. This is a singleton resource.
				479	"eventDataRetention": "A String", # The length of time that event-level data is retained.
				480	"name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
				481	"resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
				482	}</pre>
				483	</div>
				484
				485	<div class="method">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	486	<code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
				487	<pre>Updates Google Signals settings for a property.
				488
				489	Args:
				490	name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings" (required)
				491	body: object, The request body.
				492	The object takes the form of:
				493
				494	{ # Settings values for Google Signals. This is a singleton resource.
				495	"consent": "A String", # Output only. Terms of Service acceptance.
				496	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				497	"state": "A String", # Status of this setting.
				498	}
				499
				500	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.
				501	x__xgafv: string, V1 error format.
				502	Allowed values
				503	1 - v1 error format
				504	2 - v2 error format
				505
				506	Returns:
				507	An object of the form:
				508
				509	{ # Settings values for Google Signals. This is a singleton resource.
				510	"consent": "A String", # Output only. Terms of Service acceptance.
				511	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				512	"state": "A String", # Status of this setting.
				513	}</pre>
				514	</div>
				515
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	516	</body></html>