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

blob: 20105d06ec2b289aad3e02c1db0220928f82ba31 [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	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	145	<code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
				146	<p class="firstline">Lookup for Google Signals settings for a property.</p>
				147	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	148	<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]	149	<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]	150	<p class="toc_element">
				151	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				152	<p class="firstline">Retrieves the next page of results.</p>
				153	<p class="toc_element">
				154	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				155	<p class="firstline">Updates a property.</p>
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	156	<p class="toc_element">
				157	<code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				158	<p class="firstline">Updates Google Signals settings for a property.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	159	<h3>Method Details</h3>
				160	<div class="method">
				161	<code class="details" id="close">close()</code>
				162	<pre>Close httplib2 connections.</pre>
				163	</div>
				164
				165	<div class="method">
				166	<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]	167	<pre>Creates an "GA4" property with the specified location and attributes.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	168
				169	Args:
				170	body: object, The request body.
				171	The object takes the form of:
				172
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	173	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	174	"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]	175	"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]	176	"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]	177	"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]	178	"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]	179	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				180	"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]	181	"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]	182	"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]	183	"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]	184	"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]	185	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	195	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	196	"createTime": "A String", # Output only. Time when the entity was originally created.
				197	"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]	198	"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]	199	"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]	200	"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]	201	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				202	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				203	"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]	204	"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]	205	"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]	206	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				207	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	208	</div>
				209
				210	<div class="method">
				211	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	212	<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]	213
				214	Args:
				215	name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000" (required)
				216	x__xgafv: string, V1 error format.
				217	Allowed values
				218	1 - v1 error format
				219	2 - v2 error format
				220
				221	Returns:
				222	An object of the form:
				223
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	224	{ # A resource message representing a Google Analytics GA4 property.
				225	"createTime": "A String", # Output only. Time when the entity was originally created.
				226	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
				227	"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.
				228	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
				229	"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.
				230	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				231	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				232	"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]	233	"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]	234	"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"
				235	"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]	236	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	237	</div>
				238
				239	<div class="method">
				240	<code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	241	<pre>Lookup for a single "GA4" Property.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	242
				243	Args:
				244	name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000" (required)
				245	x__xgafv: string, V1 error format.
				246	Allowed values
				247	1 - v1 error format
				248	2 - v2 error format
				249
				250	Returns:
				251	An object of the form:
				252
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	253	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	254	"createTime": "A String", # Output only. Time when the entity was originally created.
				255	"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]	256	"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]	257	"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]	258	"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]	259	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				260	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				261	"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]	262	"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]	263	"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]	264	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				265	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	266	</div>
				267
				268	<div class="method">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	269	<code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
				270	<pre>Lookup for Google Signals settings for a property.
				271
				272	Args:
				273	name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
				274	x__xgafv: string, V1 error format.
				275	Allowed values
				276	1 - v1 error format
				277	2 - v2 error format
				278
				279	Returns:
				280	An object of the form:
				281
				282	{ # Settings values for Google Signals. This is a singleton resource.
				283	"consent": "A String", # Output only. Terms of Service acceptance.
				284	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				285	"state": "A String", # Status of this setting.
				286	}</pre>
				287	</div>
				288
				289	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	290	<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]	291	<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]	292
				293	Args:
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	294	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]	295	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)
				296	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]	297	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]	298	x__xgafv: string, V1 error format.
				299	Allowed values
				300	1 - v1 error format
				301	2 - v2 error format
				302
				303	Returns:
				304	An object of the form:
				305
				306	{ # Response message for ListProperties RPC.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	307	"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.
				308	"properties": [ # Results that matched the filter criteria and were accessible to the caller.
				309	{ # A resource message representing a Google Analytics GA4 property.
				310	"createTime": "A String", # Output only. Time when the entity was originally created.
				311	"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]	312	"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]	313	"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]	314	"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]	315	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				316	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				317	"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]	318	"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]	319	"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]	320	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				321	},
				322	],
				323	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	324	</div>
				325
				326	<div class="method">
				327	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				328	<pre>Retrieves the next page of results.
				329
				330	Args:
				331	previous_request: The request for the previous page. (required)
				332	previous_response: The response from the request for the previous page. (required)
				333
				334	Returns:
				335	A request object that you can call 'execute()' on to request the next
				336	page. Returns None if there are no more items in the collection.
				337	</pre>
				338	</div>
				339
				340	<div class="method">
				341	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				342	<pre>Updates a property.
				343
				344	Args:
				345	name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
				346	body: object, The request body.
				347	The object takes the form of:
				348
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	349	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	350	"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]	351	"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]	352	"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]	353	"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]	354	"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]	355	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				356	"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]	357	"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]	358	"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]	359	"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]	360	"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]	361	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	362
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	363	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]	364	x__xgafv: string, V1 error format.
				365	Allowed values
				366	1 - v1 error format
				367	2 - v2 error format
				368
				369	Returns:
				370	An object of the form:
				371
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	372	{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	373	"createTime": "A String", # Output only. Time when the entity was originally created.
				374	"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]	375	"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]	376	"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]	377	"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]	378	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				379	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				380	"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]	381	"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]	382	"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]	383	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				384	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	385	</div>
				386
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame]	387	<div class="method">
				388	<code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
				389	<pre>Updates Google Signals settings for a property.
				390
				391	Args:
				392	name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings" (required)
				393	body: object, The request body.
				394	The object takes the form of:
				395
				396	{ # Settings values for Google Signals. This is a singleton resource.
				397	"consent": "A String", # Output only. Terms of Service acceptance.
				398	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				399	"state": "A String", # Status of this setting.
				400	}
				401
				402	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.
				403	x__xgafv: string, V1 error format.
				404	Allowed values
				405	1 - v1 error format
				406	2 - v2 error format
				407
				408	Returns:
				409	An object of the form:
				410
				411	{ # Settings values for Google Signals. This is a singleton resource.
				412	"consent": "A String", # Output only. Terms of Service acceptance.
				413	"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"
				414	"state": "A String", # Status of this setting.
				415	}</pre>
				416	</div>
				417
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	418	</body></html>