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
|
<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="chromewebstore_v2.html">Chrome Web Store API</a> . <a href="chromewebstore_v2.publishers.html">publishers</a> . <a href="chromewebstore_v2.publishers.items.html">items</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancelSubmission">cancelSubmission(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.</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="#fetchStatus">fetchStatus(name, x__xgafv=None)</a></code></p>
<p class="firstline">Fetch the status of an item.</p>
<p class="toc_element">
<code><a href="#publish">publish(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.</p>
<p class="toc_element">
<code><a href="#setPublishedDeployPercentage">setPublishedDeployPercentage(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancelSubmission">cancelSubmission(name, body=None, x__xgafv=None)</code>
<pre>Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.
Args:
name: string, Required. Name of the item to cancel the submission of in the form `publishers/{publisherId}/items/{itemId}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CancelSubmission.
}
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 `CancelSubmission`.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="fetchStatus">fetchStatus(name, x__xgafv=None)</code>
<pre>Fetch the status of an item.
Args:
name: string, Required. Name of the item to retrieve the status of in the form `publishers/{publisherId}/items/{itemId}` (required)
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 `FetchItemStatus`.
"itemId": "A String", # Output only. The ID of the item.
"lastAsyncUploadState": "A String", # Output only. The state of the last async upload for an item. Only set when there has been an async upload for the item in the past 24 hours.
"name": "A String", # The name of the requested item.
"publicKey": "A String", # The public key of the item, which may be generated by the store.
"publishedItemRevisionStatus": { # Details on the status of an item revision. # Output only. Status of the current published revision of the item. Will be unset if the item is not published.
"distributionChannels": [ # Details on the package of the item
{ # Deployment information for a specific release channel
"crxVersion": "A String", # The extension version provided in the manifest of the uploaded package.
"deployPercentage": 42, # The current deploy percentage for the release channel (nonnegative number between 0 and 100).
},
],
"state": "A String", # Output only. Current state of the item
},
"submittedItemRevisionStatus": { # Details on the status of an item revision. # Status of the item revision submitted to be published. Will be unset if the item has not been submitted for publishing since the last successful publish.
"distributionChannels": [ # Details on the package of the item
{ # Deployment information for a specific release channel
"crxVersion": "A String", # The extension version provided in the manifest of the uploaded package.
"deployPercentage": 42, # The current deploy percentage for the release channel (nonnegative number between 0 and 100).
},
],
"state": "A String", # Output only. Current state of the item
},
"takenDown": True or False, # If true, the item has been taken down for a policy violation. Check the developer dashboard for details.
"warned": True or False, # If true, the item has been warned for a policy violation and will be taken down if not resolved. Check the developer dashboard for details.
}</pre>
</div>
<div class="method">
<code class="details" id="publish">publish(name, body=None, x__xgafv=None)</code>
<pre>Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.
Args:
name: string, Required. Name of the item in the form `publishers/{publisherId}/items/{itemId}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PublishItem.
"deployInfos": [ # Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset.
{ # Deployment information for a specific release channel. Used in requests to update deployment parameters.
"deployPercentage": 42, # Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100).
},
],
"publishType": "A String", # Optional. Use this to control if the item is published immediately on approval or staged for publishing in the future. Defaults to `DEFAULT_PUBLISH` if unset.
"skipReview": True or False, # Optional. Whether to attempt to skip item review. The API will validate if the item qualifies and return a validation error if the item requires review. Defaults to `false` if unset.
}
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 `PublishItem`.
"itemId": "A String", # Output only. The ID of the item.
"name": "A String", # The name of the item that was submitted
"state": "A String", # Output only. The current state of the submission.
}</pre>
</div>
<div class="method">
<code class="details" id="setPublishedDeployPercentage">setPublishedDeployPercentage(name, body=None, x__xgafv=None)</code>
<pre>Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.
Args:
name: string, Required. Name of the item to update the published revision of in the form `publishers/{publisherId}/items/{itemId}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for SetPublishedDeployPercentage.
"deployPercentage": 42, # Required. Unscaled percentage value for the publised revision (nonnegative number between 0 and 100). It must be larger than the existing target percentage.
}
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 `SetPublishedDeployPercentage`.
}</pre>
</div>
</body></html>
|
