Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html

raw
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.subpropertySyncConfigs.html">subpropertySyncConfigs</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="#get">get(name, x__xgafv=None)</a></code></p>
82 <p class="firstline">Lookup for a single `SubpropertySyncConfig`.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">List all `SubpropertySyncConfig` resources for a property.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <p class="toc_element">
90 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Updates a `SubpropertySyncConfig`.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="get">get(name, x__xgafv=None)</code>
100 <pre>Lookup for a single `SubpropertySyncConfig`.
101
102 Args:
103 name: string, Required. Resource name of the SubpropertySyncConfig to lookup. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 (required)
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109 Returns:
110 An object of the form:
111
112 { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
113 &quot;applyToProperty&quot;: &quot;A String&quot;, # Output only. Immutable. Resource name of the subproperty that these settings apply to.
114 &quot;customDimensionAndMetricSyncMode&quot;: &quot;A String&quot;, # Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
115 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
116 }</pre>
117 </div>
118
119 <div class="method">
120 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
121 <pre>List all `SubpropertySyncConfig` resources for a property.
122
123 Args:
124 parent: string, Required. Resource name of the property. Format: properties/property_id Example: properties/123 (required)
125 pageSize: integer, Optional. 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)
126 pageToken: string, Optional. A page token, received from a previous `ListSubpropertySyncConfig` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertySyncConfig` must match the call that provided the page token.
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132 Returns:
133 An object of the form:
134
135 { # Response message for ListSubpropertySyncConfigs RPC.
136 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
137 &quot;subpropertySyncConfigs&quot;: [ # List of `SubpropertySyncConfig` resources.
138 { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
139 &quot;applyToProperty&quot;: &quot;A String&quot;, # Output only. Immutable. Resource name of the subproperty that these settings apply to.
140 &quot;customDimensionAndMetricSyncMode&quot;: &quot;A String&quot;, # Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
141 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
142 },
143 ],
144 }</pre>
145 </div>
146
147 <div class="method">
148 <code class="details" id="list_next">list_next()</code>
149 <pre>Retrieves the next page of results.
150
151 Args:
152 previous_request: The request for the previous page. (required)
153 previous_response: The response from the request for the previous page. (required)
154
155 Returns:
156 A request object that you can call &#x27;execute()&#x27; on to request the next
157 page. Returns None if there are no more items in the collection.
158 </pre>
159 </div>
160
161 <div class="method">
162 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
163 <pre>Updates a `SubpropertySyncConfig`.
164
165 Args:
166 name: string, Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 (required)
167 body: object, The request body.
168 The object takes the form of:
169
170 { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
171 &quot;applyToProperty&quot;: &quot;A String&quot;, # Output only. Immutable. Resource name of the subproperty that these settings apply to.
172 &quot;customDimensionAndMetricSyncMode&quot;: &quot;A String&quot;, # Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
173 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
174 }
175
176 updateMask: string, Optional. The list of fields to update. Field names must be in snake case (for example, &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182 Returns:
183 An object of the form:
184
185 { # Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.
186 &quot;applyToProperty&quot;: &quot;A String&quot;, # Output only. Immutable. Resource name of the subproperty that these settings apply to.
187 &quot;customDimensionAndMetricSyncMode&quot;: &quot;A String&quot;, # Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.
188 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678
189 }</pre>
190 </div>
191
192 </body></html>