Debian Codegraph @

docs/dyn/css_v1.accounts.labels.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="css_v1.html">CSS API</a> . <a href="css_v1.accounts.html">accounts</a> . <a href="css_v1.accounts.labels.html">labels</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 new label, not assigned to any account.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a label and removes it from all accounts to which it was assigned.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists the labels owned by an account.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates a label.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
103 <pre>Creates a new label, not assigned to any account.
104
105 Args:
106 parent: string, Required. The parent account. Format: accounts/{account} (required)
107 body: object, The request body.
108 The object takes the form of:
109
110 { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
111 &quot;accountId&quot;: &quot;A String&quot;, # Output only. The ID of account this label belongs to.
112 &quot;description&quot;: &quot;A String&quot;, # The description of this label.
113 &quot;displayName&quot;: &quot;A String&quot;, # The display name of this label.
114 &quot;labelId&quot;: &quot;A String&quot;, # Output only. The ID of the label.
115 &quot;labelType&quot;: &quot;A String&quot;, # Output only. The type of this label.
116 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}
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 { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
128 &quot;accountId&quot;: &quot;A String&quot;, # Output only. The ID of account this label belongs to.
129 &quot;description&quot;: &quot;A String&quot;, # The description of this label.
130 &quot;displayName&quot;: &quot;A String&quot;, # The display name of this label.
131 &quot;labelId&quot;: &quot;A String&quot;, # Output only. The ID of the label.
132 &quot;labelType&quot;: &quot;A String&quot;, # Output only. The type of this label.
133 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}
134 }</pre>
135 </div>
136
137 <div class="method">
138 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
139 <pre>Deletes a label and removes it from all accounts to which it was assigned.
140
141 Args:
142 name: string, Required. The name of the label to delete. Format: accounts/{account}/labels/{label} (required)
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148 Returns:
149 An object of the form:
150
151 { # 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); }
152 }</pre>
153 </div>
154
155 <div class="method">
156 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
157 <pre>Lists the labels owned by an account.
158
159 Args:
160 parent: string, Required. The parent account. Format: accounts/{account} (required)
161 pageSize: integer, The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
162 pageToken: string, A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # Response message for the `ListAccountLabels` method.
172 &quot;accountLabels&quot;: [ # The labels from the specified account.
173 { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
174 &quot;accountId&quot;: &quot;A String&quot;, # Output only. The ID of account this label belongs to.
175 &quot;description&quot;: &quot;A String&quot;, # The description of this label.
176 &quot;displayName&quot;: &quot;A String&quot;, # The display name of this label.
177 &quot;labelId&quot;: &quot;A String&quot;, # Output only. The ID of the label.
178 &quot;labelType&quot;: &quot;A String&quot;, # Output only. The type of this label.
179 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}
180 },
181 ],
182 &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.
183 }</pre>
184 </div>
185
186 <div class="method">
187 <code class="details" id="list_next">list_next()</code>
188 <pre>Retrieves the next page of results.
189
190 Args:
191 previous_request: The request for the previous page. (required)
192 previous_response: The response from the request for the previous page. (required)
193
194 Returns:
195 A request object that you can call &#x27;execute()&#x27; on to request the next
196 page. Returns None if there are no more items in the collection.
197 </pre>
198 </div>
199
200 <div class="method">
201 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
202 <pre>Updates a label.
203
204 Args:
205 name: string, Identifier. The resource name of the label. Format: accounts/{account}/labels/{label} (required)
206 body: object, The request body.
207 The object takes the form of:
208
209 { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
210 &quot;accountId&quot;: &quot;A String&quot;, # Output only. The ID of account this label belongs to.
211 &quot;description&quot;: &quot;A String&quot;, # The description of this label.
212 &quot;displayName&quot;: &quot;A String&quot;, # The display name of this label.
213 &quot;labelId&quot;: &quot;A String&quot;, # Output only. The ID of the label.
214 &quot;labelType&quot;: &quot;A String&quot;, # Output only. The type of this label.
215 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}
216 }
217
218 x__xgafv: string, V1 error format.
219 Allowed values
220 1 - v1 error format
221 2 - v2 error format
222
223 Returns:
224 An object of the form:
225
226 { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
227 &quot;accountId&quot;: &quot;A String&quot;, # Output only. The ID of account this label belongs to.
228 &quot;description&quot;: &quot;A String&quot;, # The description of this label.
229 &quot;displayName&quot;: &quot;A String&quot;, # The display name of this label.
230 &quot;labelId&quot;: &quot;A String&quot;, # Output only. The ID of the label.
231 &quot;labelType&quot;: &quot;A String&quot;, # Output only. The type of this label.
232 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}
233 }</pre>
234 </div>
235
236 </body></html>