Debian Codegraph @

docs/dyn/content_v2_1.collectionstatuses.html

raw
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="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.collectionstatuses.html">collectionstatuses</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="#get">get(merchantId, collectionId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets the status of a collection from your Merchant Center account.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists the statuses of the collections in your Merchant Center account.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(merchantId, collectionId, x__xgafv=None)</code>
97 <pre>Gets the status of a collection from your Merchant Center account.
98
99 Args:
100 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required)
101 collectionId: string, Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # The collectionstatus message.
111 &quot;collectionLevelIssuses&quot;: [ # A list of all issues associated with the collection.
112 { # Issue associated with the collection.
113 &quot;applicableCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
114 &quot;A String&quot;,
115 ],
116 &quot;attributeName&quot;: &quot;A String&quot;, # The attribute&#x27;s name, if the issue is caused by a single attribute.
117 &quot;code&quot;: &quot;A String&quot;, # The error code of the issue.
118 &quot;description&quot;: &quot;A String&quot;, # A short issue description in English.
119 &quot;destination&quot;: &quot;A String&quot;, # The destination the issue applies to.
120 &quot;detail&quot;: &quot;A String&quot;, # A detailed issue description in English.
121 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help with resolving this issue.
122 &quot;resolution&quot;: &quot;A String&quot;, # Whether the issue can be resolved by the merchant.
123 &quot;servability&quot;: &quot;A String&quot;, # How this issue affects the serving of the collection.
124 },
125 ],
126 &quot;creationDate&quot;: &quot;A String&quot;, # Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
127 &quot;destinationStatuses&quot;: [ # The intended destinations for the collection.
128 { # Destination status message.
129 &quot;approvedCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where the collection is approved.
130 &quot;A String&quot;,
131 ],
132 &quot;destination&quot;: &quot;A String&quot;, # The name of the destination
133 &quot;disapprovedCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where the collection is disapproved.
134 &quot;A String&quot;,
135 ],
136 &quot;pendingCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where the collection is pending approval.
137 &quot;A String&quot;,
138 ],
139 &quot;status&quot;: &quot;A String&quot;, # The status for the specified destination in the collections target country.
140 },
141 ],
142 &quot;id&quot;: &quot;A String&quot;, # Required. The ID of the collection for which status is reported.
143 &quot;lastUpdateDate&quot;: &quot;A String&quot;, # Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
144 }</pre>
145 </div>
146
147 <div class="method">
148 <code class="details" id="list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</code>
149 <pre>Lists the statuses of the collections in your Merchant Center account.
150
151 Args:
152 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required)
153 pageSize: integer, The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
154 pageToken: string, Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
155 x__xgafv: string, V1 error format.
156 Allowed values
157 1 - v1 error format
158 2 - v2 error format
159
160 Returns:
161 An object of the form:
162
163 { # Response message for the ListCollectionStatuses method.
164 &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.
165 &quot;resources&quot;: [ # The collectionstatuses listed.
166 { # The collectionstatus message.
167 &quot;collectionLevelIssuses&quot;: [ # A list of all issues associated with the collection.
168 { # Issue associated with the collection.
169 &quot;applicableCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where issue applies to the offer.
170 &quot;A String&quot;,
171 ],
172 &quot;attributeName&quot;: &quot;A String&quot;, # The attribute&#x27;s name, if the issue is caused by a single attribute.
173 &quot;code&quot;: &quot;A String&quot;, # The error code of the issue.
174 &quot;description&quot;: &quot;A String&quot;, # A short issue description in English.
175 &quot;destination&quot;: &quot;A String&quot;, # The destination the issue applies to.
176 &quot;detail&quot;: &quot;A String&quot;, # A detailed issue description in English.
177 &quot;documentation&quot;: &quot;A String&quot;, # The URL of a web page to help with resolving this issue.
178 &quot;resolution&quot;: &quot;A String&quot;, # Whether the issue can be resolved by the merchant.
179 &quot;servability&quot;: &quot;A String&quot;, # How this issue affects the serving of the collection.
180 },
181 ],
182 &quot;creationDate&quot;: &quot;A String&quot;, # Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
183 &quot;destinationStatuses&quot;: [ # The intended destinations for the collection.
184 { # Destination status message.
185 &quot;approvedCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where the collection is approved.
186 &quot;A String&quot;,
187 ],
188 &quot;destination&quot;: &quot;A String&quot;, # The name of the destination
189 &quot;disapprovedCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where the collection is disapproved.
190 &quot;A String&quot;,
191 ],
192 &quot;pendingCountries&quot;: [ # Country codes (ISO 3166-1 alpha-2) where the collection is pending approval.
193 &quot;A String&quot;,
194 ],
195 &quot;status&quot;: &quot;A String&quot;, # The status for the specified destination in the collections target country.
196 },
197 ],
198 &quot;id&quot;: &quot;A String&quot;, # Required. The ID of the collection for which status is reported.
199 &quot;lastUpdateDate&quot;: &quot;A String&quot;, # Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
200 },
201 ],
202 }</pre>
203 </div>
204
205 <div class="method">
206 <code class="details" id="list_next">list_next()</code>
207 <pre>Retrieves the next page of results.
208
209 Args:
210 previous_request: The request for the previous page. (required)
211 previous_response: The response from the request for the previous page. (required)
212
213 Returns:
214 A request object that you can call &#x27;execute()&#x27; on to request the next
215 page. Returns None if there are no more items in the collection.
216 </pre>
217 </div>
218
219 </body></html>