1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="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> 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(accountId, 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(accountId, labelId, 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(accountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists the labels assigned to an account.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</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(accountId, labelId, 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(accountId, body=None, x__xgafv=None)</code> 103 <pre>Creates a new label, not assigned to any account. 104 105Args: 106 accountId: string, Required. The id of the account this label belongs to. (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 "accountId": "A String", # Immutable. The ID of account this label belongs to. 112 "description": "A String", # The description of this label. 113 "labelId": "A String", # Output only. The ID of the label. 114 "labelType": "A String", # Output only. The type of this label. 115 "name": "A String", # The display name of this label. 116} 117 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 126 { # Label assigned by CSS domain or CSS group to one of its sub-accounts. 127 "accountId": "A String", # Immutable. The ID of account this label belongs to. 128 "description": "A String", # The description of this label. 129 "labelId": "A String", # Output only. The ID of the label. 130 "labelType": "A String", # Output only. The type of this label. 131 "name": "A String", # The display name of this label. 132}</pre> 133</div> 134 135<div class="method"> 136 <code class="details" id="delete">delete(accountId, labelId, x__xgafv=None)</code> 137 <pre>Deletes a label and removes it from all accounts to which it was assigned. 138 139Args: 140 accountId: string, Required. The id of the account that owns the label. (required) 141 labelId: string, Required. The id of the label to delete. (required) 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146</pre> 147</div> 148 149<div class="method"> 150 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</code> 151 <pre>Lists the labels assigned to an account. 152 153Args: 154 accountId: string, Required. The account id for whose labels are to be listed. (required) 155 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. 156 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. 157 x__xgafv: string, V1 error format. 158 Allowed values 159 1 - v1 error format 160 2 - v2 error format 161 162Returns: 163 An object of the form: 164 165 { # Response message for the `ListAccountLabels` method. 166 "accountLabels": [ # The labels from the specified account. 167 { # Label assigned by CSS domain or CSS group to one of its sub-accounts. 168 "accountId": "A String", # Immutable. The ID of account this label belongs to. 169 "description": "A String", # The description of this label. 170 "labelId": "A String", # Output only. The ID of the label. 171 "labelType": "A String", # Output only. The type of this label. 172 "name": "A String", # The display name of this label. 173 }, 174 ], 175 "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. 176}</pre> 177</div> 178 179<div class="method"> 180 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 181 <pre>Retrieves the next page of results. 182 183Args: 184 previous_request: The request for the previous page. (required) 185 previous_response: The response from the request for the previous page. (required) 186 187Returns: 188 A request object that you can call 'execute()' on to request the next 189 page. Returns None if there are no more items in the collection. 190 </pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="patch">patch(accountId, labelId, body=None, x__xgafv=None)</code> 195 <pre>Updates a label. 196 197Args: 198 accountId: string, Required. The id of the account this label belongs to. (required) 199 labelId: string, Required. The id of the label to update. (required) 200 body: object, The request body. 201 The object takes the form of: 202 203{ # Label assigned by CSS domain or CSS group to one of its sub-accounts. 204 "accountId": "A String", # Immutable. The ID of account this label belongs to. 205 "description": "A String", # The description of this label. 206 "labelId": "A String", # Output only. The ID of the label. 207 "labelType": "A String", # Output only. The type of this label. 208 "name": "A String", # The display name of this label. 209} 210 211 x__xgafv: string, V1 error format. 212 Allowed values 213 1 - v1 error format 214 2 - v2 error format 215 216Returns: 217 An object of the form: 218 219 { # Label assigned by CSS domain or CSS group to one of its sub-accounts. 220 "accountId": "A String", # Immutable. The ID of account this label belongs to. 221 "description": "A String", # The description of this label. 222 "labelId": "A String", # Output only. The ID of the label. 223 "labelType": "A String", # Output only. The type of this label. 224 "name": "A String", # The display name of this label. 225}</pre> 226</div> 227 228</body></html>