1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.accounts.html">accounts</a> . <a href="content_v2_1.accounts.labels.html">labels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(accountId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new label, not assigned to any account.</p>
<p class="toc_element">
<code><a href="#delete">delete(accountId, labelId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a label and removes it from all accounts to which it was assigned.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the labels assigned to an account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, labelId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a label.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code>
<pre>Creates a new label, not assigned to any account.
Args:
accountId: string, Required. The id of the account this label belongs to. (required)
body: object, The request body.
The object takes the form of:
{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
"accountId": "A String", # Immutable. The ID of account this label belongs to.
"description": "A String", # The description of this label.
"labelId": "A String", # Output only. The ID of the label.
"labelType": "A String", # Output only. The type of this label.
"name": "A String", # The display name of this label.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
"accountId": "A String", # Immutable. The ID of account this label belongs to.
"description": "A String", # The description of this label.
"labelId": "A String", # Output only. The ID of the label.
"labelType": "A String", # Output only. The type of this label.
"name": "A String", # The display name of this label.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(accountId, labelId, x__xgafv=None)</code>
<pre>Deletes a label and removes it from all accounts to which it was assigned.
Args:
accountId: string, Required. The id of the account that owns the label. (required)
labelId: string, Required. The id of the label to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the labels assigned to an account.
Args:
accountId: string, Required. The account id for whose labels are to be listed. (required)
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.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the `ListAccountLabels` method.
"accountLabels": [ # The labels from the specified account.
{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
"accountId": "A String", # Immutable. The ID of account this label belongs to.
"description": "A String", # The description of this label.
"labelId": "A String", # Output only. The ID of the label.
"labelType": "A String", # Output only. The type of this label.
"name": "A String", # The display name of this label.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, labelId, body=None, x__xgafv=None)</code>
<pre>Updates a label.
Args:
accountId: string, Required. The id of the account this label belongs to. (required)
labelId: string, Required. The id of the label to update. (required)
body: object, The request body.
The object takes the form of:
{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
"accountId": "A String", # Immutable. The ID of account this label belongs to.
"description": "A String", # The description of this label.
"labelId": "A String", # Output only. The ID of the label.
"labelType": "A String", # Output only. The type of this label.
"name": "A String", # The display name of this label.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
"accountId": "A String", # Immutable. The ID of account this label belongs to.
"description": "A String", # The description of this label.
"labelId": "A String", # Output only. The ID of the label.
"labelType": "A String", # Output only. The type of this label.
"name": "A String", # The display name of this label.
}</pre>
</div>
</body></html>
|
