File: content_v2_1.csses.html

package info (click to toggle)
python-googleapi 2.187.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 562,316 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (208 lines) | stat: -rw-r--r-- 7,774 bytes parent folder | download | duplicates (2)
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
<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.csses.html">csses</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="#get">get(cssGroupId, cssDomainId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a single CSS domain by ID.</p>
<p class="toc_element">
  <code><a href="#list">list(cssGroupId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists CSS domains affiliated with a CSS group.</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="#updatelabels">updatelabels(cssGroupId, cssDomainId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates labels that are assigned to a CSS domain by its CSS group.</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(cssGroupId, cssDomainId, x__xgafv=None)</code>
  <pre>Retrieves a single CSS domain by ID.

Args:
  cssGroupId: string, Required. The ID of the managing account. If this parameter is not the same as [cssDomainId](#cssDomainId), then this ID must be a CSS group ID and `cssDomainId` must be the ID of a CSS domain affiliated with this group. (required)
  cssDomainId: string, Required. The ID of the CSS domain to return. (required)
  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 domain.
  &quot;cssDomainId&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain ID.
  &quot;cssGroupId&quot;: &quot;A String&quot;, # Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.
  &quot;displayName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s display name, used when space is constrained.
  &quot;fullName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s full name.
  &quot;homepageUri&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s homepage.
  &quot;labelIds&quot;: [ # A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(cssGroupId, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists CSS domains affiliated with a CSS group.

Args:
  cssGroupId: string, Required. The CSS group ID of CSS domains to be listed. (required)
  pageSize: integer, The maximum number of CSS domains to return. The service may return fewer than this value. If unspecified, at most 50 CSS domains 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 `ListCsses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCsses` 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:

    { # The response message for the `ListCsses` method
  &quot;csses&quot;: [ # The CSS domains affiliated with the specified CSS group.
    { # Information about CSS domain.
      &quot;cssDomainId&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain ID.
      &quot;cssGroupId&quot;: &quot;A String&quot;, # Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.
      &quot;displayName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s display name, used when space is constrained.
      &quot;fullName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s full name.
      &quot;homepageUri&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s homepage.
      &quot;labelIds&quot;: [ # A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.
        &quot;A String&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="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 &#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(cssGroupId, cssDomainId, body=None, x__xgafv=None)</code>
  <pre>Updates labels that are assigned to a CSS domain by its CSS group.

Args:
  cssGroupId: string, Required. The CSS group ID of the updated CSS domain. (required)
  cssDomainId: string, Required. The ID of the updated CSS domain. (required)
  body: object, The request body.
    The object takes the form of:

{ # The IDs of labels that should be assigned to the CSS domain.
  &quot;labelIds&quot;: [ # The list of label IDs.
    &quot;A String&quot;,
  ],
}

  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 domain.
  &quot;cssDomainId&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain ID.
  &quot;cssGroupId&quot;: &quot;A String&quot;, # Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.
  &quot;displayName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s display name, used when space is constrained.
  &quot;fullName&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s full name.
  &quot;homepageUri&quot;: &quot;A String&quot;, # Output only. Immutable. The CSS domain&#x27;s homepage.
  &quot;labelIds&quot;: [ # A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.
    &quot;A String&quot;,
  ],
}</pre>
</div>

</body></html>