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

blob: 7230b60220784bd95e637e5867a091f4b93e778e [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">
				83	<code><a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks()</a></code>
				84	</p>
				85	<p class="firstline">Returns the firebaseLinks Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="analyticsadmin_v1alpha.properties.googleAdsLinks.html">googleAdsLinks()</a></code>
				89	</p>
				90	<p class="firstline">Returns the googleAdsLinks Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="analyticsadmin_v1alpha.properties.iosAppDataStreams.html">iosAppDataStreams()</a></code>
				94	</p>
				95	<p class="firstline">Returns the iosAppDataStreams Resource.</p>
				96
				97	<p class="toc_element">
				98	<code><a href="analyticsadmin_v1alpha.properties.userLinks.html">userLinks()</a></code>
				99	</p>
				100	<p class="firstline">Returns the userLinks Resource.</p>
				101
				102	<p class="toc_element">
				103	<code><a href="analyticsadmin_v1alpha.properties.webDataStreams.html">webDataStreams()</a></code>
				104	</p>
				105	<p class="firstline">Returns the webDataStreams Resource.</p>
				106
				107	<p class="toc_element">
				108	<code><a href="#close">close()</a></code></p>
				109	<p class="firstline">Close httplib2 connections.</p>
				110	<p class="toc_element">
				111	<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]	112	<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]	113	<p class="toc_element">
				114	<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]	115	<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]	116	<p class="toc_element">
				117	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	118	<p class="firstline">Lookup for a single "GA4" Property. Throws "Target not found" if no such property found, if property is not of the type "GA4", or if caller does not have permissions to access it.</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	119	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	120	<code><a href="#list">list(showDeleted=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	121	<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]	122	<p class="toc_element">
				123	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				124	<p class="firstline">Retrieves the next page of results.</p>
				125	<p class="toc_element">
				126	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				127	<p class="firstline">Updates a property.</p>
				128	<h3>Method Details</h3>
				129	<div class="method">
				130	<code class="details" id="close">close()</code>
				131	<pre>Close httplib2 connections.</pre>
				132	</div>
				133
				134	<div class="method">
				135	<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]	136	<pre>Creates an "GA4" property with the specified location and attributes.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137
				138	Args:
				139	body: object, The request body.
				140	The object takes the form of:
				141
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	142	{ # A resource message representing a Google Analytics GA4 property.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	143	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	144	"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"
				145	"deleted": True or False, # Output only. Indicates whether this Property is soft-deleted or not. Deleted properties are excluded from List results unless specifically requested.
				146	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				147	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				148	"timeZone": "A String", # 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"
				149	"createTime": "A String", # Output only. Time when the entity was originally created.
				150	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				151	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	152	}
				153
				154	x__xgafv: string, V1 error format.
				155	Allowed values
				156	1 - v1 error format
				157	2 - v2 error format
				158
				159	Returns:
				160	An object of the form:
				161
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	162	{ # A resource message representing a Google Analytics GA4 property.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	163	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	164	"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"
				165	"deleted": True or False, # Output only. Indicates whether this Property is soft-deleted or not. Deleted properties are excluded from List results unless specifically requested.
				166	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				167	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				168	"timeZone": "A String", # 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"
				169	"createTime": "A String", # Output only. Time when the entity was originally created.
				170	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				171	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	172	}</pre>
				173	</div>
				174
				175	<div class="method">
				176	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	177	<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]	178
				179	Args:
				180	name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000" (required)
				181	x__xgafv: string, V1 error format.
				182	Allowed values
				183	1 - v1 error format
				184	2 - v2 error format
				185
				186	Returns:
				187	An object of the form:
				188
				189	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
				190	}</pre>
				191	</div>
				192
				193	<div class="method">
				194	<code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	195	<pre>Lookup for a single "GA4" Property. Throws "Target not found" if no such property found, if property is not of the type "GA4", or if caller does not have permissions to access it.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	196
				197	Args:
				198	name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000" (required)
				199	x__xgafv: string, V1 error format.
				200	Allowed values
				201	1 - v1 error format
				202	2 - v2 error format
				203
				204	Returns:
				205	An object of the form:
				206
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	207	{ # A resource message representing a Google Analytics GA4 property.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	208	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	209	"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"
				210	"deleted": True or False, # Output only. Indicates whether this Property is soft-deleted or not. Deleted properties are excluded from List results unless specifically requested.
				211	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				212	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				213	"timeZone": "A String", # 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"
				214	"createTime": "A String", # Output only. Time when the entity was originally created.
				215	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				216	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	217	}</pre>
				218	</div>
				219
				220	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	221	<code class="details" id="list">list(showDeleted=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	222	<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]	223
				224	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	225	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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	226	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)
				227	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.
				228	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. \|
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	229	x__xgafv: string, V1 error format.
				230	Allowed values
				231	1 - v1 error format
				232	2 - v2 error format
				233
				234	Returns:
				235	An object of the form:
				236
				237	{ # Response message for ListProperties RPC.
				238	"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.
				239	"properties": [ # Results that matched the filter criteria and were accessible to the caller.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	240	{ # A resource message representing a Google Analytics GA4 property.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	241	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	242	"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"
				243	"deleted": True or False, # Output only. Indicates whether this Property is soft-deleted or not. Deleted properties are excluded from List results unless specifically requested.
				244	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				245	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				246	"timeZone": "A String", # 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"
				247	"createTime": "A String", # Output only. Time when the entity was originally created.
				248	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				249	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	250	},
				251	],
				252	}</pre>
				253	</div>
				254
				255	<div class="method">
				256	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				257	<pre>Retrieves the next page of results.
				258
				259	Args:
				260	previous_request: The request for the previous page. (required)
				261	previous_response: The response from the request for the previous page. (required)
				262
				263	Returns:
				264	A request object that you can call 'execute()' on to request the next
				265	page. Returns None if there are no more items in the collection.
				266	</pre>
				267	</div>
				268
				269	<div class="method">
				270	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				271	<pre>Updates a property.
				272
				273	Args:
				274	name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" (required)
				275	body: object, The request body.
				276	The object takes the form of:
				277
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	278	{ # A resource message representing a Google Analytics GA4 property.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	279	"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	280	"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"
				281	"deleted": True or False, # Output only. Indicates whether this Property is soft-deleted or not. Deleted properties are excluded from List results unless specifically requested.
				282	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				283	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				284	"timeZone": "A String", # 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"
				285	"createTime": "A String", # Output only. Time when the entity was originally created.
				286	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				287	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	288	}
				289
				290	updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
				291	x__xgafv: string, V1 error format.
				292	Allowed values
				293	1 - v1 error format
				294	2 - v2 error format
				295
				296	Returns:
				297	An object of the form:
				298
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	299	{ # A resource message representing a Google Analytics GA4 property.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	301	"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"
				302	"deleted": True or False, # Output only. Indicates whether this Property is soft-deleted or not. Deleted properties are excluded from List results unless specifically requested.
				303	"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
				304	"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
				305	"timeZone": "A String", # 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"
				306	"createTime": "A String", # Output only. Time when the entity was originally created.
				307	"updateTime": "A String", # Output only. Time when entity payload fields were last updated.
				308	"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	309	}</pre>
				310	</div>
				311
				312	</body></html>