모든 확장 프로그램의 루트 디렉터리에는 확장 프로그램의 구조와 동작에 관한 중요한 정보가 나열된 manifest.json 파일이 있어야 합니다.
이 페이지에서는 확장 프로그램 매니페스트의 구조와 매니페스트가 포함할 수 있는 기능을 설명합니다.
예
다음 예시 매니페스트는 기본 매니페스트 구조와 흔히 사용되는 일부 기능을 자체 매니페스트를 만들기 위한 시작점으로 보여줍니다.
최소 매니페스트
{
"manifest_version": 3,
"name": "Minimal Manifest",
"version": "1.0.0",
"description": "A basic example extension with only required keys",
"icons": {
"48": "images/icon-48.png",
"128": "images/icon-128.png"
},
}
콘텐츠 스크립트 등록
{
"manifest_version": 3,
"name": "Run script automatically",
"description": "Runs a script on www.example.com automatically when user installs the extension",
"version": "1.0",
"icons": {
"16": "images/icon-16.png",
"32": "images/icon-32.png",
"48": "images/icon-48.png",
"128": "images/icon-128.png"
},
"content_scripts": [
{
"js": [
"content-script.js"
],
"matches": [
"http://*.example.com//"
]
}
]
}
콘텐츠 스크립트 삽입
{
"manifest_version": 3,
"name": "Click to run",
"description": "Runs a script when the user clicks the action toolbar icon.",
"version": "1.0",
"icons": {
"16": "images/icon-16.png",
"32": "images/icon-32.png",
"48": "images/icon-48.png",
"128": "images/icon-128.png"
},
"background": {
"service_worker": "service-worker.js"
},
"action": {
"default_icon": {
"16": "images/icon-16.png",
"32": "images/icon-32.png",
"48": "images/icon-48.png",
"128": "images/icon-128.png"
}
},
"permissions": ["scripting", "activeTab"]
}
권한이 있는 팝업
{
"manifest_version": 3,
"name": "Popup extension that requests permissions",
"description": "Extension that includes a popup and requests host permissions and storage permissions .",
"version": "1.0",
"icons": {
"16": "images/icon-16.png",
"32": "images/icon-32.png",
"48": "images/icon-48.png",
"128": "images/icon-128.png"
},
"action": {
"default_popup": "popup.html"
},
"host_permissions": [
"https://*.example.com/"
],
"permissions": [
"storage"
]
}
측면 패널
{
"manifest_version": 3,
"name": "Side panel extension",
"version": "1.0",
"description": "Extension with a default side panel.",
"icons": {
"16": "images/icon-16.png",
"48": "images/icon-48.png",
"128": "images/icon-128.png"
},
"side_panel": {
"default_path": "sidepanel.html"
},
"permissions": ["sidePanel"]
}
매니페스트 키
다음은 지원되는 모든 매니페스트 키 목록입니다.
확장 프로그램 플랫폼에 필요한 키
"manifest_version"- 확장 프로그램이 사용하는 매니페스트 파일 형식의 버전을 지정하는 정수입니다. 유일하게 지원되는 값은
3입니다. "name"- Chrome 웹 스토어, 설치 대화상자, 사용자의 Chrome 확장 프로그램 페이지(
chrome://extensions)에서 확장 프로그램을 식별하는 문자열입니다. 최대 길이는 75자(영문 기준)입니다. 언어별 이름 사용에 관한 자세한 내용은 다국어 지원을 참고하세요. "version"- 확장 프로그램의 버전 번호를 식별하는 문자열입니다. 버전 번호 형식에 대한 자세한 내용은 버전을 참조하세요.
Chrome 웹 스토어에서 필요한 키
"description"- Chrome 웹 스토어와 사용자의 확장 프로그램 관리 페이지 모두의 확장 프로그램을 설명하는 문자열입니다. 최대 길이는 132자(영문 기준)입니다. 현지화에 관한 자세한 내용은 다국어 지원을 참고하세요.
"icons"- 확장 프로그램을 나타내는 하나 이상의 아이콘입니다. 권장사항에 관한 자세한 내용은 아이콘을 참고하세요.
선택적 키
"action"- Google 툴바에서 확장 프로그램 아이콘의 모양과 동작을 정의합니다. 자세한 내용은
chrome.action를 참조하세요. "author"- 확장 프로그램을 만드는 데 사용된 계정의 이메일 주소를 지정합니다.
"background"- 이벤트 핸들러 역할을 하는 확장 프로그램의 서비스 워커가 포함된 자바스크립트 파일을 지정합니다. 자세한 내용은 확장 프로그램 서비스 워커 정보를 참조하세요.
"chrome_settings_overrides"- 선택한 Chrome 설정에 대한 재정의를 정의합니다. 자세한 내용은 Chrome 설정 재정의를 참고하세요.
"chrome_url_overrides"- 기본 Chrome 페이지의 재정의를 정의합니다. 자세한 내용은 Chrome 페이지 재정의하기를 참고하세요.
"commands"- 확장 프로그램 내에 단축키를 정의합니다. 자세한 내용은 chrome.commands를 참고하세요.
"content_scripts"- 사용자가 특정 웹페이지를 열 때 사용할 JavaScript 또는 CSS 파일을 지정합니다. 자세한 내용은 콘텐츠 스크립트를 참고하세요.
"content_security_policy"- 확장 프로그램에서 사용할 수 있는 스크립트, 스타일, 기타 리소스에 대한 제한사항을 정의합니다. 자세한 내용은 콘텐츠 보안 정책을 참고하세요.
"cross_origin_embedder_policy"- 확장 프로그램 페이지에 교차 출처 리소스 삽입을 구성하는 Cross-Origin-Embedder-Policy HTTP 헤더의 값을 지정합니다.
"cross_origin_opener_policy"- Cross-Origin-Opener-Policy HTTP 헤더의 값을 지정합니다. 이를 통해 최상위 확장 프로그램 페이지가 교차 출처 문서와 탐색 컨텍스트 그룹을 공유하지 않도록 할 수 있습니다.
"declarative_net_request"- 네트워크 요청의 차단 및 수정을 허용하는 declarativeNetRequest API의 정적 규칙을 정의합니다.
"default_locale"- 여러 언어를 지원하는 확장 프로그램의 기본 언어를 정의하는 문자열입니다. 'en', 'pt_BR' 등을 예로 들 수 있습니다. 이 키는 현지화된 확장 프로그램에 필요하며 현지화되지 않은 확장 프로그램에 사용하면 안 됩니다. 자세한 내용은 다국어 지원을 참고하세요.
"devtools_page"- DevTools API를 사용하는 페이지를 정의합니다.
"export"- 확장 프로그램에서 리소스를 내보내도록 허용합니다. 자세한 내용은 내보내기를 참조하세요.
"externally_connectable"- 확장 프로그램에 연결할 수 있는 다른 페이지 및 확장 프로그램을 지정합니다. 자세한 내용은
"externally_connectable"를 참고하세요. "homepage_url"- 확장 프로그램의 홈페이지의 URL을 지정하는 문자열입니다. 정의되지 않은 경우 홈페이지는 기본적으로 확장 프로그램의 Chrome 웹 스토어 페이지로 설정됩니다. 이 필드는 자체 사이트에서 확장 프로그램을 호스팅하는 경우에 특히 유용합니다.
"host_permissions"- 확장 프로그램이 상호작용할 수 있는 웹페이지를 나열하며, URL 일치 패턴을 사용하여 정의됩니다. 이러한 사이트에 대한 사용자 권한은 설치 시 요청됩니다. 자세한 내용은 호스트 권한을 참고하세요.
"import"- 리소스를 확장 프로그램으로 가져올 수 있습니다. 자세한 내용은 가져오기를 참조하세요.
"incognito"- 시크릿 모드에서 확장 프로그램이 작동하는 방식을 정의합니다. 지원되는 값은
"spanning","split","not_allowed"입니다. 자세한 내용은 시크릿 모드를 참고하세요. "key"- 다양한 개발 사용 사례에 맞게 확장 프로그램의 ID를 지정합니다. 자세한 내용은 키를 참조하세요.
"minimum_chrome_version"- 확장 프로그램을 설치할 수 있는 가장 오래된 Chrome 버전을 정의합니다. 이 값은 기존 Chrome 브라우저 버전 문자열의 하위 문자열(예:
"107"또는"107.0.5304.87")이어야 합니다. 최소 버전보다 오래된 Chrome 버전을 사용하는 사용자에게는 Chrome 웹 스토어에 '호환되지 않음' 경고가 표시되고 확장 프로그램을 설치할 수 없습니다. 기존 확장 프로그램에 이 확장 프로그램을 추가하면 Chrome 버전이 이전 버전인 사용자는 확장 프로그램이 자동 업데이트되지 않습니다. 여기에는 임시 모드의 비즈니스 사용자가 포함됩니다. "oauth2"- OAuth 2.0 보안 ID 사용을 허용합니다. 이 키의 값은
"client_id"및"scopes"속성이 있는 객체여야 합니다. 자세한 내용은 OAuth 2.0 튜토리얼을 참고하세요. "omnibox"- 확장 프로그램이 Chrome 주소 표시줄에 키워드를 등록하도록 허용합니다. 자세한 내용은 검색주소창을 참고하세요.
"optional_host_permissions"- 확장 프로그램의 선택적 호스트 권한을 선언합니다.
"optional_permissions"- 확장 프로그램의 선택적 권한을 선언합니다.
"options_page"- 확장 프로그램이 옵션 페이지로 사용할 options.html 파일 경로를 지정합니다. 자세한 내용은 사용자에게 옵션 제공을 참고하세요.
"options_ui"- 사용자가 Chrome 확장 프로그램 페이지에서 확장 프로그램 옵션을 변경할 수 있는 HTML 파일의 경로를 지정합니다. 자세한 내용은 삽입된 옵션을 참고하세요.
"permissions"- 특정 확장 프로그램 API를 사용할 수 있습니다. 일반적인 설명은 권한을 참조하세요. 개별 API의 참조 페이지에는 필요한 권한이 나와 있습니다.
"requirements"- 확장 프로그램을 사용하는 데 필요한 기술을 나열합니다. 지원되는 요구사항 목록은 요구사항을 참고하세요.
"sandbox"- 확장 프로그램 API에 액세스할 수 없거나 샌드박스 처리되지 않은 페이지에 직접 액세스할 수 없는 확장 프로그램 페이지 집합을 정의합니다. 자세한 내용은 샌드박스를 참고하세요.
"short_name"- 문자 공간이 제한될 때 사용할 확장 프로그램 이름의 짧은 버전이 포함된 문자열입니다. 최대 길이는 12자(영문 기준)입니다. 정의되지 않은 경우 'name' 키의 잘린 버전이 대신 표시됩니다.
"side_panel"- sidePanel에 표시할 HTML 파일을 식별합니다.
"storage"- 관리형 스토리지 영역의 JSON 스키마를 선언합니다. 자세한 내용은 저장소 영역의 매니페스트를 참고하세요.
"tts_engine"- 확장 프로그램을 TTS(텍스트 음성 변환) 엔진으로 등록합니다. 자세한 내용은 ttsEngine API를 참조하세요.
"update_url"- 확장 프로그램의 업데이트 페이지 URL이 포함된 문자열입니다. Chrome 웹 스토어 외부에서 확장 프로그램을 호스팅하는 경우 이 키를 사용합니다.
"version_name"- 확장 프로그램의 버전을 설명하는 문자열입니다. 예를 들어
"1.0 beta","build rc2"가 있습니다. 지정하지 않으면 '버전' 값이 확장 프로그램 관리 페이지에 대신 표시됩니다. "web_accessible_resources"- 웹페이지 또는 다른 확장 프로그램에서 액세스할 수 있는 확장 프로그램 내에 파일을 정의합니다. 자세한 내용은 웹 액세스 가능 리소스를 참고하세요.
선택적 ChromeOS 키
"file_browser_handlers"- 확장 프로그램이 ChromeOS 파일 브라우저에 액세스할 수 있도록
fileBrowserHandlerAPI에 대한 액세스 권한을 제공합니다. "file_handlers"- ChromeOS 확장 프로그램에서 처리할 파일 형식을 지정합니다. 자세한 내용은
file_handlers을 참고하세요. "file_system_provider_capabilities"fileSystemProviderAPI 액세스를 허용합니다. 그러면 확장 프로그램에서 ChromeOS가 사용할 수 있는 파일 시스템을 만들 수 있습니다."input_components"- Input Method Editor API를 사용하도록 허용합니다. 자세한 내용은
input_components를 참고하세요.