File: css_v1.accounts.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (242 lines) | stat: -rw-r--r-- 10,168 bytes parent folder | download
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<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="css_v1.html">CSS API</a> . <a href="css_v1.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="css_v1.accounts.cssProductInputs.html">cssProductInputs()</a></code>
</p>
<p class="firstline">Returns the cssProductInputs Resource.</p>

<p class="toc_element">
  <code><a href="css_v1.accounts.cssProducts.html">cssProducts()</a></code>
</p>
<p class="firstline">Returns the cssProducts Resource.</p>

<p class="toc_element">
  <code><a href="css_v1.accounts.labels.html">labels()</a></code>
</p>
<p class="firstline">Returns the labels Resource.</p>

<p class="toc_element">
  <code><a href="css_v1.accounts.quotas.html">quotas()</a></code>
</p>
<p class="firstline">Returns the quotas Resource.</p>

<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="#get">get(name, parent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a single CSS/MC account by ID.</p>
<p class="toc_element">
  <code><a href="#listChildAccounts">listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.</p>
<p class="toc_element">
  <code><a href="#listChildAccounts_next">listChildAccounts_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#updateLabels">updateLabels(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates labels assigned to CSS/MC accounts by a CSS domain.</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="get">get(name, parent=None, x__xgafv=None)</code>
  <pre>Retrieves a single CSS/MC account by ID.

Args:
  name: string, Required. The name of the managed CSS/MC account. Format: accounts/{account} (required)
  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}
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about CSS/MC account.
  &quot;accountType&quot;: &quot;A String&quot;, # Output only. The type of this account.
  &quot;automaticLabelIds&quot;: [ # Automatically created label IDs assigned to the MC account by CSS Center.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # The CSS/MC account&#x27;s short display name.
  &quot;fullName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS/MC account&#x27;s full name.
  &quot;homepageUri&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS/MC account&#x27;s homepage.
  &quot;labelIds&quot;: [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # The label resource name. Format: accounts/{account}
  &quot;parent&quot;: &quot;A String&quot;, # The CSS/MC account&#x27;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.&quot;
}</pre>
</div>

<div class="method">
    <code class="details" id="listChildAccounts">listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.

Args:
  parent: string, Required. The parent account. Must be a CSS group or domain. Format: accounts/{account} (required)
  fullName: string, If set, only the MC accounts with the given name (case sensitive) will be returned.
  labelId: string, If set, only the MC accounts with the given label ID will be returned.
  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.
  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.
  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 `ListChildAccounts` method.
  &quot;accounts&quot;: [ # The CSS/MC accounts returned for the specified CSS parent account.
    { # Information about CSS/MC account.
      &quot;accountType&quot;: &quot;A String&quot;, # Output only. The type of this account.
      &quot;automaticLabelIds&quot;: [ # Automatically created label IDs assigned to the MC account by CSS Center.
        &quot;A String&quot;,
      ],
      &quot;displayName&quot;: &quot;A String&quot;, # The CSS/MC account&#x27;s short display name.
      &quot;fullName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS/MC account&#x27;s full name.
      &quot;homepageUri&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS/MC account&#x27;s homepage.
      &quot;labelIds&quot;: [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
        &quot;A String&quot;,
      ],
      &quot;name&quot;: &quot;A String&quot;, # The label resource name. Format: accounts/{account}
      &quot;parent&quot;: &quot;A String&quot;, # The CSS/MC account&#x27;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.&quot;
    },
  ],
  &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.
}</pre>
</div>

<div class="method">
    <code class="details" id="listChildAccounts_next">listChildAccounts_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 &#x27;execute()&#x27; 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="updateLabels">updateLabels(name, body=None, x__xgafv=None)</code>
  <pre>Updates labels assigned to CSS/MC accounts by a CSS domain.

Args:
  name: string, Required. The label resource name. Format: accounts/{account} (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for the `UpdateLabels` method.
  &quot;labelIds&quot;: [ # 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.
    &quot;A String&quot;,
  ],
  &quot;parent&quot;: &quot;A String&quot;, # Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about CSS/MC account.
  &quot;accountType&quot;: &quot;A String&quot;, # Output only. The type of this account.
  &quot;automaticLabelIds&quot;: [ # Automatically created label IDs assigned to the MC account by CSS Center.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # The CSS/MC account&#x27;s short display name.
  &quot;fullName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS/MC account&#x27;s full name.
  &quot;homepageUri&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS/MC account&#x27;s homepage.
  &quot;labelIds&quot;: [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # The label resource name. Format: accounts/{account}
  &quot;parent&quot;: &quot;A String&quot;, # The CSS/MC account&#x27;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.&quot;
}</pre>
</div>

</body></html>