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

blob: b2c5b1d852220097c9b1a09aea5835b6cfa0239e [file] [log] [blame]

yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -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> . <a href="analyticsadmin_v1alpha.properties.iosAppDataStreams.html">iosAppDataStreams</a> . <a href="analyticsadmin_v1alpha.properties.iosAppDataStreams.measurementProtocolSecrets.html">measurementProtocolSecrets</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
				81	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a measurement protocol secret.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes target MeasurementProtocolSecret.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Lookup for a single "GA4" MeasurementProtocolSecret.</p>
				89	<p class="toc_element">
				90	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Returns child MeasurementProtocolSecrets under the specified parent Property.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Updates a measurement protocol secret.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
				105	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				106	<pre>Creates a measurement protocol secret.
				107
				108	Args:
				109	parent: string, Required. The parent resource where this secret will be created. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream} (required)
				110	body: object, The request body.
				111	The object takes the form of:
				112
				113	{ # A secret value used for sending hits to Measurement Protocol.
				114	"displayName": "A String", # Required. Human-readable display name for this secret.
				115	"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
				116	"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
				117	}
				118
				119	x__xgafv: string, V1 error format.
				120	Allowed values
				121	1 - v1 error format
				122	2 - v2 error format
				123
				124	Returns:
				125	An object of the form:
				126
				127	{ # A secret value used for sending hits to Measurement Protocol.
				128	"displayName": "A String", # Required. Human-readable display name for this secret.
				129	"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
				130	"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
				131	}</pre>
				132	</div>
				133
				134	<div class="method">
				135	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				136	<pre>Deletes target MeasurementProtocolSecret.
				137
				138	Args:
				139	name: string, Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. (required)
				140	x__xgafv: string, V1 error format.
				141	Allowed values
				142	1 - v1 error format
				143	2 - v2 error format
				144
				145	Returns:
				146	An object of the form:
				147
				148	{ # 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 `{}`.
				149	}</pre>
				150	</div>
				151
				152	<div class="method">
				153	<code class="details" id="get">get(name, x__xgafv=None)</code>
				154	<pre>Lookup for a single "GA4" MeasurementProtocolSecret.
				155
				156	Args:
				157	name: string, Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. (required)
				158	x__xgafv: string, V1 error format.
				159	Allowed values
				160	1 - v1 error format
				161	2 - v2 error format
				162
				163	Returns:
				164	An object of the form:
				165
				166	{ # A secret value used for sending hits to Measurement Protocol.
				167	"displayName": "A String", # Required. Human-readable display name for this secret.
				168	"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
				169	"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
				170	}</pre>
				171	</div>
				172
				173	<div class="method">
				174	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
				175	<pre>Returns child MeasurementProtocolSecrets under the specified parent Property.
				176
				177	Args:
				178	parent: string, Required. The resource name of the parent stream. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets (required)
				179	pageSize: integer, The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.
				180	pageToken: string, A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token.
				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	{ # Response message for ListMeasurementProtocolSecret RPC
				190	"measurementProtocolSecrets": [ # A list of secrets for the parent stream specified in the request.
				191	{ # A secret value used for sending hits to Measurement Protocol.
				192	"displayName": "A String", # Required. Human-readable display name for this secret.
				193	"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
				194	"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
				195	},
				196	],
				197	"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.
				198	}</pre>
				199	</div>
				200
				201	<div class="method">
				202	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				203	<pre>Retrieves the next page of results.
				204
				205	Args:
				206	previous_request: The request for the previous page. (required)
				207	previous_response: The response from the request for the previous page. (required)
				208
				209	Returns:
				210	A request object that you can call 'execute()' on to request the next
				211	page. Returns None if there are no more items in the collection.
				212	</pre>
				213	</div>
				214
				215	<div class="method">
				216	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				217	<pre>Updates a measurement protocol secret.
				218
				219	Args:
				220	name: string, Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} (required)
				221	body: object, The request body.
				222	The object takes the form of:
				223
				224	{ # A secret value used for sending hits to Measurement Protocol.
				225	"displayName": "A String", # Required. Human-readable display name for this secret.
				226	"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
				227	"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
				228	}
				229
				230	updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
				231	x__xgafv: string, V1 error format.
				232	Allowed values
				233	1 - v1 error format
				234	2 - v2 error format
				235
				236	Returns:
				237	An object of the form:
				238
				239	{ # A secret value used for sending hits to Measurement Protocol.
				240	"displayName": "A String", # Required. Human-readable display name for this secret.
				241	"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
				242	"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.
				243	}</pre>
				244	</div>
				245
				246	</body></html>