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

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