| 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></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="css_v1.accounts.cssProductInputs.html">cssProductInputs()</a></code> |
| 79 |
</p> |
| 80 |
<p class="firstline">Returns the cssProductInputs Resource.</p> |
| 81 |
|
| 82 |
<p class="toc_element"> |
| 83 |
<code><a href="css_v1.accounts.cssProducts.html">cssProducts()</a></code> |
| 84 |
</p> |
| 85 |
<p class="firstline">Returns the cssProducts Resource.</p> |
| 86 |
|
| 87 |
<p class="toc_element"> |
| 88 |
<code><a href="css_v1.accounts.labels.html">labels()</a></code> |
| 89 |
</p> |
| 90 |
<p class="firstline">Returns the labels Resource.</p> |
| 91 |
|
| 92 |
<p class="toc_element"> |
| 93 |
<code><a href="css_v1.accounts.quotas.html">quotas()</a></code> |
| 94 |
</p> |
| 95 |
<p class="firstline">Returns the quotas Resource.</p> |
| 96 |
|
| 97 |
<p class="toc_element"> |
| 98 |
<code><a href="#close">close()</a></code></p> |
| 99 |
<p class="firstline">Close httplib2 connections.</p> |
| 100 |
<p class="toc_element"> |
| 101 |
<code><a href="#get">get(name, parent=None, x__xgafv=None)</a></code></p> |
| 102 |
<p class="firstline">Retrieves a single CSS/MC account by ID.</p> |
| 103 |
<p class="toc_element"> |
| 104 |
<code><a href="#listChildAccounts">listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 105 |
<p class="firstline">Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.</p> |
| 106 |
<p class="toc_element"> |
| 107 |
<code><a href="#listChildAccounts_next">listChildAccounts_next()</a></code></p> |
| 108 |
<p class="firstline">Retrieves the next page of results.</p> |
| 109 |
<p class="toc_element"> |
| 110 |
<code><a href="#updateLabels">updateLabels(name, body=None, x__xgafv=None)</a></code></p> |
| 111 |
<p class="firstline">Updates labels assigned to CSS/MC accounts by a CSS domain.</p> |
| 112 |
<h3>Method Details</h3> |
| 113 |
<div class="method"> |
| 114 |
<code class="details" id="close">close()</code> |
| 115 |
<pre>Close httplib2 connections.</pre> |
| 116 |
</div> |
| 117 |
|
| 118 |
<div class="method"> |
| 119 |
<code class="details" id="get">get(name, parent=None, x__xgafv=None)</code> |
| 120 |
<pre>Retrieves a single CSS/MC account by ID. |
| 121 |
|
| 122 |
Args: |
| 123 |
name: string, Required. The name of the managed CSS/MC account. Format: accounts/{account} (required) |
| 124 |
parent: string, Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account} |
| 125 |
x__xgafv: string, V1 error format. |
| 126 |
Allowed values |
| 127 |
1 - v1 error format |
| 128 |
2 - v2 error format |
| 129 |
|
| 130 |
Returns: |
| 131 |
An object of the form: |
| 132 |
|
| 133 |
{ # Information about CSS/MC account. |
| 134 |
"accountType": "A String", # Output only. The type of this account. |
| 135 |
"automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center. |
| 136 |
"A String", |
| 137 |
], |
| 138 |
"displayName": "A String", # The CSS/MC account's short display name. |
| 139 |
"fullName": "A String", # Output only. Immutable. The CSS/MC account's full name. |
| 140 |
"homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage. |
| 141 |
"labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account. |
| 142 |
"A String", |
| 143 |
], |
| 144 |
"name": "A String", # The label resource name. Format: accounts/{account} |
| 145 |
"parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy." |
| 146 |
}</pre> |
| 147 |
</div> |
| 148 |
|
| 149 |
<div class="method"> |
| 150 |
<code class="details" id="listChildAccounts">listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 151 |
<pre>Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name. |
| 152 |
|
| 153 |
Args: |
| 154 |
parent: string, Required. The parent account. Must be a CSS group or domain. Format: accounts/{account} (required) |
| 155 |
fullName: string, If set, only the MC accounts with the given name (case sensitive) will be returned. |
| 156 |
labelId: string, If set, only the MC accounts with the given label ID will be returned. |
| 157 |
pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
| 158 |
pageToken: string, Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token. |
| 159 |
x__xgafv: string, V1 error format. |
| 160 |
Allowed values |
| 161 |
1 - v1 error format |
| 162 |
2 - v2 error format |
| 163 |
|
| 164 |
Returns: |
| 165 |
An object of the form: |
| 166 |
|
| 167 |
{ # Response message for the `ListChildAccounts` method. |
| 168 |
"accounts": [ # The CSS/MC accounts returned for the specified CSS parent account. |
| 169 |
{ # Information about CSS/MC account. |
| 170 |
"accountType": "A String", # Output only. The type of this account. |
| 171 |
"automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center. |
| 172 |
"A String", |
| 173 |
], |
| 174 |
"displayName": "A String", # The CSS/MC account's short display name. |
| 175 |
"fullName": "A String", # Output only. Immutable. The CSS/MC account's full name. |
| 176 |
"homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage. |
| 177 |
"labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account. |
| 178 |
"A String", |
| 179 |
], |
| 180 |
"name": "A String", # The label resource name. Format: accounts/{account} |
| 181 |
"parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy." |
| 182 |
}, |
| 183 |
], |
| 184 |
"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. |
| 185 |
}</pre> |
| 186 |
</div> |
| 187 |
|
| 188 |
<div class="method"> |
| 189 |
<code class="details" id="listChildAccounts_next">listChildAccounts_next()</code> |
| 190 |
<pre>Retrieves the next page of results. |
| 191 |
|
| 192 |
Args: |
| 193 |
previous_request: The request for the previous page. (required) |
| 194 |
previous_response: The response from the request for the previous page. (required) |
| 195 |
|
| 196 |
Returns: |
| 197 |
A request object that you can call 'execute()' on to request the next |
| 198 |
page. Returns None if there are no more items in the collection. |
| 199 |
</pre> |
| 200 |
</div> |
| 201 |
|
| 202 |
<div class="method"> |
| 203 |
<code class="details" id="updateLabels">updateLabels(name, body=None, x__xgafv=None)</code> |
| 204 |
<pre>Updates labels assigned to CSS/MC accounts by a CSS domain. |
| 205 |
|
| 206 |
Args: |
| 207 |
name: string, Required. The label resource name. Format: accounts/{account} (required) |
| 208 |
body: object, The request body. |
| 209 |
The object takes the form of: |
| 210 |
|
| 211 |
{ # The request message for the `UpdateLabels` method. |
| 212 |
"labelIds": [ # The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted. |
| 213 |
"A String", |
| 214 |
], |
| 215 |
"parent": "A String", # Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account} |
| 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 |
{ # Information about CSS/MC account. |
| 227 |
"accountType": "A String", # Output only. The type of this account. |
| 228 |
"automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center. |
| 229 |
"A String", |
| 230 |
], |
| 231 |
"displayName": "A String", # The CSS/MC account's short display name. |
| 232 |
"fullName": "A String", # Output only. Immutable. The CSS/MC account's full name. |
| 233 |
"homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage. |
| 234 |
"labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account. |
| 235 |
"A String", |
| 236 |
], |
| 237 |
"name": "A String", # The label resource name. Format: accounts/{account} |
| 238 |
"parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy." |
| 239 |
}</pre> |
| 240 |
</div> |
| 241 |
|
| 242 |
</body></html> |