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
243
244
245
246
247
248
|
<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_v1_1.html">Chrome Web Store API</a> . <a href="chromewebstore_v1_1.items.html">items</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(itemId, projection=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets your own Chrome Web Store item.</p>
<p class="toc_element">
<code><a href="#insert">insert(media_body=None, media_mime_type=None, publisherEmail=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new item.</p>
<p class="toc_element">
<code><a href="#publish">publish(itemId, body=None, deployPercentage=None, publishTarget=None, reviewExemption=None, x__xgafv=None)</a></code></p>
<p class="firstline">Publishes an item.</p>
<p class="toc_element">
<code><a href="#update">update(itemId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing item.</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(itemId, projection=None, x__xgafv=None)</code>
<pre>Gets your own Chrome Web Store item.
Args:
itemId: string, Unique identifier representing the Chrome App, Chrome Extension, or the Chrome Theme. (required)
projection: string, Determines which subset of the item information to return.
Allowed values
DRAFT - Return information extracted from the current draft.
PUBLISHED - Return information extracted from the published item draft.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"crxVersion": "A String", # The CRX version of the item. If the projection is draft, then it is the draft's CRX version.
"id": "A String", # Unique ID of the item.
"itemError": [ # Detail human-readable status of the operation, in English only. Same error messages are displayed when you upload your app to the Chrome Web Store.
{ # Error of the item
"error_code": "A String", # The error code.
"error_detail": "A String", # The human-readable detail message of the error.
},
],
"kind": "A String", # Identifies this resource as an Item. Value: the fixed string "chromewebstore#item".
"publicKey": "A String", # Public key of this item.
"uploadState": "A String", # Status of the operation. Possible values are: - \"FAILURE\" - \"IN_PROGRESS\" - \"NOT_FOUND\" - \"SUCCESS\"
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(media_body=None, media_mime_type=None, publisherEmail=None, x__xgafv=None)</code>
<pre>Inserts a new item.
Args:
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
publisherEmail: string, The email of the publisher who owns the items. Defaults to the caller's email address.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"crxVersion": "A String", # The CRX version of the item. If the projection is draft, then it is the draft's CRX version.
"id": "A String", # Unique ID of the item.
"itemError": [ # Detail human-readable status of the operation, in English only. Same error messages are displayed when you upload your app to the Chrome Web Store.
{ # Error of the item
"error_code": "A String", # The error code.
"error_detail": "A String", # The human-readable detail message of the error.
},
],
"kind": "A String", # Identifies this resource as an Item. Value: the fixed string "chromewebstore#item".
"publicKey": "A String", # Public key of this item.
"uploadState": "A String", # Status of the operation. Possible values are: - \"FAILURE\" - \"IN_PROGRESS\" - \"NOT_FOUND\" - \"SUCCESS\"
}</pre>
</div>
<div class="method">
<code class="details" id="publish">publish(itemId, body=None, deployPercentage=None, publishTarget=None, reviewExemption=None, x__xgafv=None)</code>
<pre>Publishes an item.
Args:
itemId: string, The ID of the item to publish. (required)
body: object, The request body.
The object takes the form of:
{
"deployPercentage": 42, # The target deploy percentage of the item. It's only useful for items with big user base.
"reviewExemption": True or False, # Optional. The caller request to exempt the review and directly publish because the update is within the list that we can automatically validate. The API will check if the exemption can be granted using real time data.
"target": "A String", # The publish target of this publish operation. This is the same as using publishTarget as a URL query parameter. The string value can either be target="trustedTesters" or target="default". The default value, if none is supplied, is target="default". Recommended usage is to use the URL query parameter to specificy the value.
}
deployPercentage: integer, The deploy percentage you want to set for your item. Valid values are [0, 100]. If set to any number less than 100, only that many percentage of users will be allowed to get the update.
publishTarget: string, Provide defined publishTarget in URL (case sensitive): publishTarget="trustedTesters" or publishTarget="default". Defaults to publishTarget="default".
reviewExemption: boolean, Optional. The caller request to exempt the review and directly publish because the update is within the list that we can automatically validate. The API will check if the exemption can be granted using real time data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"item_id": "A String", # The ID of this item.
"kind": "A String", # Static string value is always "chromewebstore#item".
"status": [ # The status code of this publish operation. It may contain multiple elements from the following list: NOT_AUTHORIZED, INVALID_DEVELOPER, DEVELOPER_NO_OWNERSHIP, DEVELOPER_SUSPENDED, ITEM_NOT_FOUND, ITEM_PENDING_REVIEW, ITEM_TAKEN_DOWN, PUBLISHER_SUSPENDED.
"A String",
],
"statusDetail": [ # Detailed human-comprehensible explanation of the status code above.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(itemId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
<pre>Updates an existing item.
Args:
itemId: string, The ID of the item to upload. (required)
body: object, The request body.
The object takes the form of:
{
"crxVersion": "A String", # The CRX version of the item. If the projection is draft, then it is the draft's CRX version.
"id": "A String", # Unique ID of the item.
"itemError": [ # Detail human-readable status of the operation, in English only. Same error messages are displayed when you upload your app to the Chrome Web Store.
{ # Error of the item
"error_code": "A String", # The error code.
"error_detail": "A String", # The human-readable detail message of the error.
},
],
"kind": "A String", # Identifies this resource as an Item. Value: the fixed string "chromewebstore#item".
"publicKey": "A String", # Public key of this item.
"uploadState": "A String", # Status of the operation. Possible values are: - \"FAILURE\" - \"IN_PROGRESS\" - \"NOT_FOUND\" - \"SUCCESS\"
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"crxVersion": "A String", # The CRX version of the item. If the projection is draft, then it is the draft's CRX version.
"id": "A String", # Unique ID of the item.
"itemError": [ # Detail human-readable status of the operation, in English only. Same error messages are displayed when you upload your app to the Chrome Web Store.
{ # Error of the item
"error_code": "A String", # The error code.
"error_detail": "A String", # The human-readable detail message of the error.
},
],
"kind": "A String", # Identifies this resource as an Item. Value: the fixed string "chromewebstore#item".
"publicKey": "A String", # Public key of this item.
"uploadState": "A String", # Status of the operation. Possible values are: - \"FAILURE\" - \"IN_PROGRESS\" - \"NOT_FOUND\" - \"SUCCESS\"
}</pre>
</div>
</body></html>
|
