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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
|
<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
1) The <head> information in this page is significant, should be uniform
across api docs and should be edited only with knowledge of the
templating mechanism.
3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
browser, it will be re-generated from the template, json schema and
authored overview content.
4) The <body>.innerHTML is also generated by an offline step so that this
page may easily be indexed by search engines.
--><html xmlns="http://www.w3.org/1999/xhtml"><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
<link href="css/print.css" rel="stylesheet" type="text/css" media="print">
<script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
</script>
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>Formats: Manifest Files - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
</div>
<!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
<!-- In particular, sub-templates that recurse, must be used by allowing
jstemplate to make a copy of the template in this section which
are not operated on by way of the jsskip="true" -->
<div style="display:none">
<!-- VALUE -->
<div id="valueTemplate">
<dt>
<var>paramName</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span class="enum">enumerated</span>
<span id="typeTemplate">
<span>
<a> Type</a>
</span>
<span>
<span>
array of <span><span></span></span>
</span>
<span>paramType</span>
<span></span>
</span>
</span>
)
</div>
</em>
</dt>
<dd class="todo">
Undocumented.
</dd>
<dd>
Description of this parameter from the json schema.
</dd>
<dd>
This parameter was added in version
<b><span></span></b>.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
<a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
can ensure that your extension won't be run in an earlier browser version.
</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
<div>
<div>
</div>
</div>
</dl>
</dd>
<!-- OBJECT METHODS -->
<dd>
<div></div>
</dd>
<!-- OBJECT EVENT FIELDS -->
<dd>
<div></div>
</dd>
<!-- FUNCTION PARAMETERS -->
<dd>
<div></div>
</dd>
</div> <!-- /VALUE -->
<div id="functionParametersTemplate">
<h5>Parameters</h5>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- Individual subsections from the table of contents -->
<ol>
<li id="propertiesTocTemplate">
<a href="#properties">Properties</a>
<ol>
<li>
<a href="#property-anchor">propertyName</a>
</li>
</ol>
</li>
<li id="methodsTocTemplate">
<a>Methods</a>
<ol>
<li>
<a href="#method-anchor">methodName</a>
</li>
</ol>
</li>
<li id="eventsTocTemplate">
<a>Events</a>
<ol>
<li>
<a href="#event-anchor">eventName</a>
</li>
</ol>
</li>
<li id="typesTocTemplate">
<a href="#types">Types</a>
<ol>
<li>
<a href="#id-anchor">id</a>
<ol>
<div></div>
<div></div>
</ol>
</li>
</ol>
</li>
</ol>
</div> <!-- /SUBTEMPLATES -->
<a id="top"></a>
<div id="skipto">
<a href="#gc-pagecontent">Skip to page content</a>
<a href="#gc-toc">Skip to main navigation</a>
</div>
<!-- API HEADER -->
<table id="header" width="100%" cellspacing="0" border="0">
<tbody><tr>
<td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>
<td valign="middle" width="100%" style="padding-left:0.6em;">
<form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
<div id="gsc-search-box">
<input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" value="" size="55">
<input class="gsc-search-button" type="submit" name="sa" value="Search">
<br>
<span class="greytext">e.g. "page action" or "tabs"</span>
</div>
</form>
<script type="text/javascript" src="http://www.google.com/jsapi"></script>
<script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
<script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>
<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script>
</td>
</tr>
</tbody></table>
<div id="codesiteContent" class="">
<a id="gc-topnav-anchor"></a>
<div id="gc-topnav">
<h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>
<ul id="home" class="gc-topnav-tabs">
<li id="home_link">
<a href="index.html" title="Google Chrome Extensions home page">Home</a>
</li>
<li id="docs_link">
<a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>
</li>
<li id="faq_link">
<a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>
</li>
<li id="samples_link">
<a href="samples.html" title="Sample extensions (with source code)">Samples</a>
</li>
<li id="group_link">
<a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>
</li>
<li id="so_link">
<a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
</li>
</ul>
</div> <!-- end gc-topnav -->
<div class="g-section g-tpl-170">
<!-- SIDENAV -->
<div class="g-unit g-first" id="gc-toc">
<ul>
<li><a href="getstarted.html">Getting Started</a></li>
<li><a href="overview.html">Overview</a></li>
<li><a href="whats_new.html">What's New?</a></li>
<li><h2><a href="devguide.html">Developer's Guide</a></h2>
<ul>
<li>Browser UI
<ul>
<li><a href="browserAction.html">Browser Actions</a></li>
<li><a href="contextMenus.html">Context Menus</a></li>
<li><a href="notifications.html">Desktop Notifications</a></li>
<li><a href="omnibox.html">Omnibox</a></li>
<li><a href="options.html">Options Pages</a></li>
<li><a href="override.html">Override Pages</a></li>
<li><a href="pageAction.html">Page Actions</a></li>
</ul>
</li>
<li>Browser Interaction
<ul>
<li><a href="bookmarks.html">Bookmarks</a></li>
<li><a href="cookies.html">Cookies</a></li>
<li><a href="events.html">Events</a></li>
<li><a href="history.html">History</a></li>
<li><a href="management.html">Management</a></li>
<li><a href="tabs.html">Tabs</a></li>
<li><a href="windows.html">Windows</a></li>
</ul>
</li>
<li>Implementation
<ul>
<li><a href="a11y.html">Accessibility</a></li>
<li><a href="background_pages.html">Background Pages</a></li>
<li><a href="content_scripts.html">Content Scripts</a></li>
<li><a href="xhr.html">Cross-Origin XHR</a></li>
<li><a href="i18n.html">Internationalization</a></li>
<li><a href="messaging.html">Message Passing</a></li>
<li><a href="permissions.html">Optional Permissions</a></li>
<li><a href="npapi.html">NPAPI Plugins</a></li>
</ul>
</li>
<li>Finishing
<ul>
<li><a href="hosting.html">Hosting</a></li>
<li><a href="external_extensions.html">Other Deployment Options</a></li>
</ul>
</li>
</ul>
</li>
<li><h2><a href="apps.html">Packaged Apps</a></h2></li>
<li><h2><a href="tutorials.html">Tutorials</a></h2>
<ul>
<li><a href="tut_debugging.html">Debugging</a></li>
<li><a href="tut_analytics.html">Google Analytics</a></li>
<li><a href="tut_oauth.html">OAuth</a></li>
</ul>
</li>
<li><h2>Reference</h2>
<ul>
<li>Formats
<ul>
<li class="leftNavSelected">Manifest Files</li>
<li><a href="match_patterns.html">Match Patterns</a></li>
</ul>
</li>
<li><a href="permission_warnings.html">Permission Warnings</a></li>
<li><a href="api_index.html">chrome.* APIs</a></li>
<li><a href="api_other.html">Other APIs</a></li>
</ul>
</li>
<li><h2><a href="samples.html">Samples</a></h2></li>
<div class="line"> </div>
<li><h2>More</h2>
<ul>
<li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>
<li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>
<li><a href="themes.html">Themes</a></li>
</ul>
</li>
</ul>
</div>
<script>
initToggles();
</script>
<div class="g-unit" id="gc-pagecontent">
<div id="pageTitle">
<h1 class="page_title">Formats: Manifest Files</h1>
</div>
<!-- TABLE OF CONTENTS -->
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
<a href="#overview"> Field summary </a>
<ol>
<li style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li>
<a href="#H2-1">Field details</a>
<ol>
<li>
<a href="#app">app</a>
</li><li>
<a href="#default_locale">default_locale</a>
</li><li>
<a href="#description">description</a>
</li><li>
<a href="#content_security_policy">content_security_policy</a>
</li><li>
<a href="#homepage_url">homepage_url</a>
</li><li>
<a href="#icons">icons</a>
</li><li>
<a href="#incognito">incognito</a>
</li><li>
<a href="#key">key</a>
</li><li>
<a href="#minimum_chrome_version">minimum_chrome_version</a>
</li><li>
<a href="#name">name</a>
</li><li>
<a href="#nacl_modules">nacl_modules</a>
</li><li>
<a href="#offline_enabled">offline_enabled</a>
</li><li>
<a href="#permissions">permissions</a>
</li><li>
<a href="#version">version</a>
</li>
</ol>
</li>
<li style="display: none; ">
<a href="#apiReference">API reference</a>
<ol>
<div></div>
<div></div>
<div></div>
<div></div>
</ol>
</li>
</ol>
</div>
<!-- /TABLE OF CONTENTS -->
<!-- Standard content lead-in for experimental API pages -->
<p id="classSummary" style="display: none; ">
For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.
</p>
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static"><div id="pageData-name" class="pageData">Formats: Manifest Files</div>
<div id="pageData-showTOC" class="pageData">true</div>
<p>
Every extension, installable web app, and theme has a
<a href="http://www.json.org">JSON</a>-formatted manifest file,
named <code>manifest.json</code>,
that provides important information.
</p>
<h2 id="overview"> Field summary </h2>
<p>
The following code shows the supported manifest fields,
with links to the page that discusses each field.
The only fields that are always required
are <b>name</b> and <b>version</b>.
</p>
<pre>{
<em>// Required</em>
"<a href="#name">name</a>": "<em>My Extension</em>",
"<a href="#version">version</a>": "<em>versionString</em>",
<em>// Recommended</em>
"<a href="#description">description</a>": "<em>A plain text description</em>",
"<a href="#icons">icons</a>": { ... },
"<a href="#default_locale">default_locale</a>": "<em>en</em>",
<em>// Pick one (or none)</em>
"<a href="browserAction.html">browser_action</a>": {...},
"<a href="pageAction.html">page_action</a>": {...},
"<a href="themes.html">theme</a>": {...},
"<a href="#app">app</a>": {...},
<em>// Add any of these that you need</em>
"<a href="background_pages.html">background_page</a>": "<em>aFile</em>.html",
"<a href="override.html">chrome_url_overrides</a>": {...},
"<a href="content_scripts.html">content_scripts</a>": [...],
"<a href="#content_security_policy">content_security_policy</a>": "<em>policyString</em>",
"<a href="fileBrowserHandler.html">file_browser_handlers</a>": [...],
"<a href="#homepage_url">homepage_url</a>": "http://<em>path/to/homepage</em>",
"<a href="#incognito">incognito</a>": "spanning" <em>or</em> "split",
"<a href="#key">key</a>": "<em>publicKey</em>",
"<a href="#minimum_chrome_version">minimum_chrome_version</a>": "<em>versionString</em>",
"<a href="#nacl_modules">nacl_modules</a>": [...],
"<a href="#offline_enabled">offline_enabled</a>": true,
"<a href="omnibox.html">omnibox</a>": { "keyword": "<em>aString</em>" },
"<a href="options.html">options_page</a>": "<em>aFile</em>.html",
"<a href="#permissions">permissions</a>": [...],
"<a href="npapi.html">plugins</a>": [...],
"<a href="autoupdate.html">update_url</a>": "http://<em>path/to/updateInfo</em>.xml"
}
</pre>
<a name="H2-1"></a><h2>Field details</h2>
<p>
This section covers fields that aren't described in another page.
For a complete list of fields,
with links to where they're described in detail,
see the <a href="#overview">Field summary</a>.
</p>
<h3 id="app">app</h3>
<p>
Used by installable web apps,
including packaged apps,
to specify the URLs that the app uses.
Most important is the <em>launch page</em> for the app—the
page that the browser goes to when the user clicks the app's icon
in the New Tab page.
</p>
<p>
For details, see the documentation for
<a href="http://code.google.com/chrome/apps/docs/developers_guide.html">hosted apps</a> and
<a href="apps.html">packaged apps</a>.
</p>
<h3 id="default_locale">default_locale</h3>
<p>
Specifies the subdirectory of <code>_locales</code>
that contains the default strings for this extension.
This field is <b>required</b> in extensions
that have a <code>_locales</code> directory;
it <b>must be absent</b> in extensions
that have no <code>_locales</code> directory.
For details, see
<a href="i18n.html">Internationalization</a>.
</p>
<h3 id="description">description</h3>
<p>
A plain text string
(no HTML or other formatting;
no more than 132 characters)
that describes the extension.
The description should be suitable for both
the browser's extension management UI
and the <a href="https://chrome.google.com/webstore">Chrome Web Store</a>.
You can specify locale-specific strings for this field;
see <a href="i18n.html">Internationalization</a> for details.
</p>
<h3 id="content_security_policy">content_security_policy</h3>
<p>
A security policy to apply to resources in your extension.
You can use this policy to help prevent cross-site scripting
vulnerabilities in your extension.
To specify that your extension loads resources
only from its own package, use the following policy:
</p>
<pre>"content_security_policy": "default-src 'self' " </pre>
<p>
If you need to load resources from websites,
you can add them to the whitelist.
For example, if your extension uses Google Analytics,
you might use the following policy:
</p>
<pre>"content_security_policy": "default-src 'self' https://ssl.google-analytics.com"</pre>
<p>
For details, see the
<a href="http://dvcs.w3.org/hg/content-security-policy/raw-file/tip/csp-specification.dev.html">Content Security Policy specification</a>.
</p>
<h3 id="homepage_url">homepage_url</h3>
<p>
The URL of the homepage for this extension. The extensions management page (chrome://extensions)
will contain a link to this URL. This field is particularly useful if you
<a href="hosting.html">host the extension on your own site</a>. If you distribute your
extension using the <a href="https://chrome.google.com/webstore">Chrome Web Store</a>,
the homepage URL defaults to the extension's own page.
</p>
<h3 id="icons">icons</h3>
<p>
One or more icons that represent the extension, app, or theme.
You should always provide a 128x128 icon;
it's used during installation and by the Chrome Web Store.
Extensions should also provide a 48x48 icon,
which is used in the extensions management page
(chrome://extensions).
You can also specify a 16x16 icon to be used as the favicon
for an extension's pages.
The 16x16 icon is also displayed in the experimental extension
<a href="experimental.infobars.html">infobar</a>
feature.
</p>
<p>
Icons should generally be in PNG format,
because PNG has the best support for transparency.
They can, however, be in any format supported by WebKit,
including BMP, GIF, ICO, and JPEG.
Here's an example of specifying the icons:
</p>
<pre>"icons": { "16": "icon16.png",
"48": "icon48.png",
"128": "icon128.png" },
</pre>
<p class="note">
<b>Important:</b>
Use only the documented icon sizes.
<br><br>
You might notice that Chrome sometimes resizes these icons down to smaller
sizes. For example, the install dialog might shrink the 128-pixel
icon down to 69 pixels.
<br><br>
However, the details of
Chrome's UI may change between versions, and these changes assume that
developers are using the documented sizes. If you use other sizes,
your icon may look bad in future versions of the browser.
</p>
<p>
If you upload your extension, app, or theme using the
<a href="https://chrome.google.com/webstore/developer/dashboard">Chrome Developer Dashboard</a>,
you'll need to upload additional images,
including at least one screenshot of your extension.
For more information,
see the
<a href="http://code.google.com/chrome/webstore/">Chrome Web Store
developer documentation</a>.
</p>
<h3 id="incognito">incognito</h3>
<p>
Either "spanning" or "split", to specify how this extension will
behave if allowed to run in incognito mode.
</p>
<p>
The default for extensions is "spanning", which means that the extension
will run in a single shared process. Any events or messages from an incognito
tab will be sent to the shared process, with an <em>incognito</em> flag
indicating where it came from. Because incognito tabs cannot use this shared
process, an extension using the "spanning" incognito mode will not be able to
load pages from its extension package into the main frame of an incognito tab.
</p>
<p>
The default for installable web apps is "split",
which means that all app pages in
an incognito window will run in their own incognito process. If the app or extension contains a background page, that will also run in the incognito process.
This incognito process runs along side the regular process, but has a separate
memory-only cookie store. Each process sees events and messages only from its
own context (for example, the incognito process will see only incognito tab updates).
The processes are unable to communicate with each other.
</p>
<p>
As a rule of thumb, if your extension or app needs to load a tab in an incognito browser, use
<em>split</em> incognito behavior. If your extension or app needs to be logged
into a remote server or persist settings locally, use <em>spanning</em>
incognito behavior.
</p>
<h3 id="key">key</h3>
<p>
This value can be used to control
the unique ID of an extension, app, or theme when
it is loaded during development.
</p>
<p class="note">
<b>Note:</b> You don't usually need to
use this value. Instead, write your
code so that the key value doesn't matter
by using <a href="overview.html#relative-urls">relative paths</a>
and <a href="extension.html#method-getURL">chrome.extension.getURL()</a>.
</p>
<p>
To get a suitable key value, first
install your extension from a <code>.crx</code> file
(you may need to
<a href="https://chrome.google.com/webstore/developer/dashboard">upload your extension</a>
or <a href="packaging.html">package it manually</a>).
Then, in your
<a href="http://www.chromium.org/user-experience/user-data-directory">user
data directory</a>, look in the file
<code>Default/Extensions/<em><extensionId></em>/<em><versionString></em>/manifest.json</code>.
You will see the key value filled in there.
</p>
<h3 id="minimum_chrome_version">minimum_chrome_version</h3>
<p>
The version of Chrome that your extension, app, or theme requires, if any.
The format for this string is the same as for the
<a href="#version">version</a> field.
</p><h3 id="name">name</h3>
<p>
A short, plain text string
(no more than 45 characters)
that identifies the extension.
The name is used in the install dialog,
extension management UI,
and the <a href="https://chrome.google.com/webstore">store</a>.
You can specify locale-specific strings for this field;
see <a href="i18n.html">Internationalization</a> for details.
</p>
<h3 id="nacl_modules">nacl_modules</h3>
<p>
One or more mappings from MIME types to the Native Client module
that handles each type.
For example, the bold code in the following snippet
registers a Native Client module as the content handler
for the OpenOffice spreadsheet MIME type.
</p>
<pre>{
"name": "Native Client OpenOffice Spreadsheet Viewer",
"version": "0.1",
"description": "Open OpenOffice spreadsheets, right in your browser.",
<b>"nacl_modules": [{
"path": "OpenOfficeViewer.nmf",
"mime_type": "application/vnd.oasis.opendocument.spreadsheet"
}]</b>
}
</pre>
<p>
The value of "path" is the location of a Native Client manifest
(a <code>.nmf</code> file)
within the extension directory.
For more information on Native Client and <code>.nmf</code> files, see the
<a href="http://code.google.com/chrome/nativeclient/docs/technical_overview.html">Native Client Technical Overview</a>.
</p>
<p>
Each MIME type can be associated with only one <code>.nmf</code> file,
but a single <code>.nmf</code> file might handle multiple MIME types.
The following example shows an extension
with two <code>.nmf</code> files
that handle three MIME types.
</p>
<pre>{
"name": "Spreadsheet Viewer",
"version": "0.1",
"description": "Open OpenOffice and Excel spreadsheets, right in your browser.",
"nacl_modules": [{
"path": "OpenOfficeViewer.nmf",
"mime_type": "application/vnd.oasis.opendocument.spreadsheet"
},
{
"path": "OpenOfficeViewer.nmf",
"mime_type": "application/vnd.oasis.opendocument.spreadsheet-template"
},
{
"path": "ExcelViewer.nmf",
"mime_type": "application/excel"
}]
}
</pre>
<p class="note">
<strong>Note:</strong>
You can use Native Client modules in extensions
without specifying "nacl_modules".
Use "nacl_modules" only if you want the browser
to use your Native Client module
to display a particular type of content.
</p>
<h3 id="offline_enabled">offline_enabled</h3>
<p>
Whether the app or extension is expected to work offline. When Chrome detects
that it is offline, apps with this field set to true will be highlighted
on the New Tab page.
</p>
<h3 id="permissions">permissions</h3>
<p>
An array of permissions that the extension or app might use.
Each permission can be either one of a list of known strings
(such as "geolocation")
or a match pattern
that gives access to one or more hosts.
Permissions can help to limit damage
if your extension or app is attacked.
Some permissions are also displayed to users before installation,
as detailed in
<a href="permission_warnings.html">Permission Warnings</a>.
</p>
<p>
If an extension API requires you to declare a permission in the manifest,
then its documentation tells you how to do so.
For example,
the <a href="tabs.html">Tabs</a> page
shows you how to
declare the "tabs" permission.
</p>
<p class="note">
<b>Note:</b>
As of Chrome 16, some permissions can be optional.
For details, see
<a href="permissions.html">Optional Permissions</a>.
</p>
<p>
Here's an example of the permissions part of a manifest file
for an extension:
</p>
<pre>"permissions": [
"tabs",
"bookmarks",
"http://www.blogger.com/",
"http://*.google.com/",
"unlimitedStorage"
],
</pre>
<p>
The following table lists the permissions an extension
or packaged app can use.
</p>
<p class="note">
<strong>Note:</strong>
Hosted apps can use the
"background", "clipboardRead", "clipboardWrite", "geolocation", "notifications",
and "unlimitedStorage" permissions, but not any other permissions listed in this
table.
</p>
<table>
<tbody><tr>
<th> Permission </th> <th> Description </th>
</tr>
<tr>
<td> <em>match pattern</em> </td>
<td> Specifies a <em>host permission</em>.
Required if the extension wants to interact
with the code running on pages.
Many extension capabilities, such as
<a href="xhr.html">cross-origin XMLHttpRequests</a>,
<a href="content_scripts.html#pi">programmatically injected
content scripts</a>, and <a href="cookies.html">the cookies API</a>
require host permissions. For details on the syntax, see
<a href="match_patterns.html">Match Patterns</a>.
</td>
</tr>
<tr id="bg">
<td> "background" </td>
<td> <p>
Makes Chrome start up early and and shut down late,
so that apps and extensions can have a longer life.
</p>
<p>
When any installed hosted app, packaged app, or extension
has "background" permission, Chrome runs (invisibly)
as soon as the user logs into their computer—before
the user launches Chrome.
The "background" permission also makes Chrome continue running
(even after its last window is closed)
until the user explicitly quits Chrome.
</p>
<p class="note">
<b>Note:</b>
Disabled apps and extensions
are treated as if they aren't installed.
</p>
<p>
You typically use the "background" permission with a
<a href="background_pages.html">background page</a>
or (for hosted apps) a
<a href="http://code.google.com/chrome/apps/docs/background.html">background window</a>.
</p>
</td>
</tr>
<tr>
<td> "bookmarks" </td>
<td> Required if the extension uses the
<a href="bookmarks.html">chrome.bookmarks</a> module. </td>
</tr>
<tr>
<td> "chrome://favicon/" </td>
<td> Required if the extension uses the
"chrome://favicon/<em>url</em>" mechanism
to display the favicon of a page.
For example, to display the favicon of http://www.google.com/,
you declare the "chrome://favicon/" permission
and use HTML code like this:
<pre><img src="chrome://favicon/http://www.google.com/"></pre>
</td>
</tr>
<tr>
<td> "clipboardRead" </td>
<td> Required if the extension uses
<code>document.execCommand('paste')</code>. </td>
</tr>
<tr>
<td> "clipboardWrite" </td>
<td> Indicates the app or extension uses
<code>document.execCommand('copy')</code> or
<code>document.execCommand('cut')</code>. This permission is <b>required
for hosted apps</b>; it's recommended for extensions and packaged apps.
</td>
</tr>
<tr>
<td> "contentSettings" </td>
<td> Required if the extension uses the
<a href="contentSettings.html">chrome.contentSettings</a> module. </td>
</tr>
<tr>
<td> "contextMenus" </td>
<td> Required if the extension uses the
<a href="contextMenus.html">chrome.contextMenus</a> module. </td>
</tr>
<tr>
<td> "cookies" </td>
<td> Required if the extension uses the
<a href="cookies.html">chrome.cookies</a> module. </td>
</tr>
<tr>
<td> "experimental" </td>
<td> Required if the extension uses any
<a href="http://code.google.com/chrome/extensions/dev/experimental.html">chrome.experimental.* APIs</a>.</td>
</tr>
<tr>
<td id="fileBrowserHandler"> "fileBrowserHandler" </td>
<td> Required if the extension uses the
<a href="fileBrowserHandler.html">fileBrowserhandler</a> module. </td>
</tr>
<tr>
<td id="geolocation"> "geolocation" </td>
<td> Allows the extension to use the proposed HTML5
<a href="http://dev.w3.org/geo/api/spec-source.html">geolocation API</a>
without prompting the user for permission. </td>
</tr>
<tr>
<td> "history" </td>
<td> Required if the extension uses the
<a href="history.html">chrome.history</a> module. </td>
</tr>
<tr>
<td> "idle" </td>
<td> Required if the extension uses the
<a href="idle.html">chrome.idle</a> module. </td>
</tr>
<tr>
<td> "management" </td>
<td> Required if the extension uses the
<a href="management.html">chrome.management</a> module. </td>
</tr>
<tr>
<td> "notifications" </td>
<td> Allows the extension to use the proposed HTML5
<a href="http://www.chromium.org/developers/design-documents/desktop-notifications/api-specification">notification API</a>
without calling permission methods
(such as <code>checkPermission()</code>).
For more information see
<a href="notifications.html">Desktop Notifications</a>.</td>
</tr>
<tr>
<td> "proxy" </td>
<td> Required if the extension uses the
<a href="proxy.html">chrome.proxy</a> module. </td>
</tr>
<tr>
<td> "tabs" </td>
<td> Required if the extension uses the
<a href="tabs.html">chrome.tabs</a> or
<a href="windows.html">chrome.windows</a> module. </td>
</tr>
<tr>
<td> "tts" </td>
<td> Required if the extension uses the
<a href="tts.html">chrome.tts</a> module. </td>
</tr>
<tr>
<td> "ttsEngine" </td>
<td> Required if the extension uses the
<a href="ttsEngine.html">chrome.ttsEngine</a> module. </td>
</tr>
<tr>
<td> "unlimitedStorage"</td>
<td> Provides an unlimited quota for storing HTML5 client-side data,
such as databases and local storage files.
Without this permission, the extension is limited to
5 MB of local storage.
<p class="note">
<b>Note:</b>
This permission applies only to Web SQL Database and application cache
(see issue <a href="http://crbug.com/58985">58985</a>).
Also, it doesn't currently work with wildcard subdomains such as
<code>http://*.example.com</code>.
</p>
</td>
</tr><tr>
</tr><tr>
<td> "webNavigation" </td>
<td> Required if the extension uses the
<a href="webNavigation.html">chrome.webNavigation</a> module. </td>
</tr>
</tbody></table>
<h3 id="version">version</h3>
<p>
One to four dot-separated integers
identifying the version of this extension.
A couple of rules apply to the integers:
they must be between 0 and 65535, inclusive,
and non-zero integers can't start with 0.
For example, 99999 and 032 are both invalid.
</p>
<p>
Here are some examples of valid versions:
</p>
<ul>
<li> <code>"version": "1"</code> </li>
<li> <code>"version": "1.0"</code> </li>
<li> <code>"version": "2.10.2"</code> </li>
<li> <code>"version": "3.1.2.4567"</code> </li>
</ul>
<p>
The autoupdate system compares versions
to determine whether an installed extension
needs to be updated.
If the published extension has a newer version string
than the installed extension,
then the extension is automatically updated.
</p>
<p>
The comparison starts with the leftmost integers.
If those integers are equal,
the integers to the right are compared,
and so on.
For example, 1.2.0 is a newer version than 1.1.9.9999.
</p>
<p>
A missing integer is equal to zero.
For example, 1.1.9.9999 is newer than 1.1.
</p>
<p>
For more information, see
<a href="autoupdate.html">Autoupdating</a>.
</p>
<!-- [PENDING: Possibly: point to the store/dashboard and make a big deal of the fact that autoupdating is free if you use them.] -->
</div>
<!-- API PAGE -->
<div class="apiPage" style="display: none; ">
<a name="apiReference"></a>
<h2>API reference: chrome.apiname </h2>
<!-- PROPERTIES -->
<div class="apiGroup">
<a name="properties"></a>
<h3 id="properties">Properties</h3>
<div>
<a></a>
<h4>getLastError</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span>chrome.extension</span><span>lastError</span>
</div>
<div>
</div>
</div>
</div> <!-- /apiGroup -->
<!-- METHODS -->
<div id="methodsTemplate" class="apiGroup">
<a></a>
<h3>Methods</h3>
<!-- iterates over all functions -->
<div class="apiItem">
<a></a> <!-- method-anchor -->
<h4>method name</h4>
<div class="summary"><span>void</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.module.methodName</span>(<span><span>, </span><span></span>
<var><span></span></var></span>)</div>
<div class="description">
<p class="todo">Undocumented.</p>
<p>
A description from the json schema def of the function goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
<!-- RETURNS -->
<h4>Returns</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
<!-- CALLBACK -->
<div>
<div>
<h4>Callback function</h4>
<p>
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
<p>
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
</div>
<!-- MIN_VERSION -->
<p>
This function was added in version <b><span></span></b>.
If you require this function, the manifest key
<a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
can ensure that your extension won't be run in an earlier browser version.
</p>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<div id="eventsTemplate" class="apiGroup">
<a></a>
<h3>Events</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a></a>
<h4>event name</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_param2</span>);
</div>
<div class="description">
<p class="todo">Undocumented.</p>
<p>
A description from the json schema def of the event goes here.
</p>
<!-- LISTENER PARAMETERS -->
<div>
<h4>Listener parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- EXTRA PARAMETERS -->
<div>
<h4>Extra parameters to addListener</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- LISTENER RETURN VALUE -->
<h4>Listener returns</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- TYPES -->
<div class="apiGroup">
<a name="types"></a>
<h3 id="types">Types</h3>
<!-- iterates over all types -->
<div class="apiItem">
<a></a>
<h4>type name</h4>
<div>
</div>
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
</div> <!-- /apiPage -->
</div> <!-- /gc-pagecontent -->
</div> <!-- /g-section -->
</div> <!-- /codesiteContent -->
<div id="gc-footer" --="">
<div class="text">
<p>
Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
<p>
©2011 Google
</p>
<!-- begin analytics -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
<script type="text/javascript">
// chrome doc tracking
try {
var engdocs = _gat._getTracker("YT-10763712-2");
engdocs._trackPageview();
} catch(err) {}
// code.google.com site-wide tracking
try {
_uacct="UA-18071-1";
_uanchor=1;
_uff=0;
urchinTracker();
}
catch(e) {/* urchinTracker not available. */}
</script>
<!-- end analytics -->
</div>
</div> <!-- /gc-footer -->
</div> <!-- /gc-container -->
</body></html>
|
