- 리소스: 배포
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint를 추가합니다.
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- 메서드
리소스: 배포
Google Workspace 부가기능 배포
JSON 표현 |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
필드 | |
---|---|
name |
배포 리소스 이름입니다. 예: |
oauth |
부가기능 엔드포인트를 실행하기 전에 최종 사용자의 동의를 요청해야 하는 Google OAuth 범위 목록입니다. |
add |
Google Workspace 부가기능 구성 |
etag |
이 값은 저장소의 배포 버전을 기준으로 서버에서 계산되며, 처리 전 클라이언트에 최신 값이 적용되도록 업데이트 및 삭제 요청이 있을 때 전송될 수 있습니다. |
부가기능
Google Workspace 부가기능 구성
JSON 표현 |
---|
{ "common": { object ( |
필드 | |
---|---|
common |
모든 Google Workspace 부가기능에 공통적으로 적용되는 구성입니다. |
gmail |
Gmail 부가기능 구성 |
drive |
Drive 부가기능 구성 |
calendar |
캘린더 부가기능 구성 |
docs |
문서 부가기능 구성 |
sheets |
Sheets 부가기능 구성 |
slides |
Slides 부가기능 구성 |
http |
부가기능 HTTP 엔드포인트에 요청을 전송하는 옵션 |
CommonAddOnManifest
모든 부가기능 호스트 애플리케이션에서 공유되는 부가기능 구성입니다.
JSON 표현 |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
필드 | |
---|---|
name |
필수 항목입니다. 부가기능의 표시 이름입니다. |
logo |
필수 항목입니다. 부가기능 툴바에 표시되는 로고 이미지의 URL입니다. |
layout |
부가기능 카드의 공통 레이아웃 속성입니다. |
add |
부가기능에서 사용되는 위젯입니다. 이 필드를 지정하지 않으면 기본 세트가 사용됩니다. |
use |
호스트 앱의 언어 정보를 전달할지 여부입니다. |
homepage |
모든 컨텍스트와 호스트에서 실행될 엔드포인트를 정의합니다. 이 함수로 생성된 카드는 항상 사용자에게 제공되지만 이 부가기능에서 더 타겟팅된 트리거를 선언하면 문맥 콘텐츠에 가려질 수 있습니다. |
universal |
부가기능의 설정 메뉴 역할을 하는 범용 작업 메뉴에서 확장 지점 목록을 정의합니다. 확장 지점은 열려는 링크 URL이거나 양식 제출로 실행할 엔드포인트일 수 있습니다. |
open |
OpenLink 작업은 |
LayoutProperties
모든 부가기능 호스트 애플리케이션에서 공유되는 카드 레이아웃 속성입니다.
JSON 표현 |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
필드 | |
---|---|
primary |
부가기능의 기본 색상입니다. 툴바의 색상을 설정합니다. 기본 색상이 설정되지 않은 경우 프레임워크에서 제공하는 기본값이 사용됩니다. |
secondary |
부가기능의 보조 색상입니다. 버튼의 색상을 설정합니다. 기본 색상은 설정되어 있지만 보조 색상은 설정되지 않은 경우 보조 색상은 기본 색상과 동일합니다. 기본 색상과 보조 색상 중 어느 것도 설정되지 않은 경우 프레임워크에서 제공하는 기본값이 사용됩니다. |
use |
카드에 Material Design을 사용 설정합니다. |
AddOnWidgetSet
부가기능에서 사용하는 위젯 하위 집합입니다.
JSON 표현 |
---|
{
"usedWidgets": [
enum ( |
필드 | |
---|---|
used |
부가기능에 사용되는 위젯 목록입니다. |
WidgetType
위젯 유형입니다. WIDGET_TYPE_UNSPECIFIED
는 기본 위젯 집합입니다.
열거형 | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
기본 위젯 설정 |
DATE_PICKER |
날짜 선택 도구 |
STYLED_BUTTONS |
스타일이 지정된 버튼에는 색이 채워진 버튼과 비활성화된 버튼이 포함됩니다. |
PERSISTENT_FORMS |
영구 양식을 사용하면 작업 중에 양식 값을 유지할 수 있습니다. |
FIXED_FOOTER |
카드의 바닥글 고정 |
UPDATE_SUBJECT_AND_RECIPIENTS |
임시보관 메일의 제목과 수신자를 업데이트합니다. |
GRID_WIDGET |
그리드 위젯 |
ADDON_COMPOSE_UI_ACTION |
부가기능 편지쓰기 UI에 적용되는 Gmail 부가기능 작업입니다. |
HomepageExtensionPoint
부가기능의 홈페이지 뷰를 선언하는 일반적인 형식입니다.
JSON 표현 |
---|
{ "runFunction": string, "enabled": boolean } |
필드 | |
---|---|
run |
필수 항목입니다. 이 확장 포인트가 활성화될 때 실행할 엔드포인트입니다. |
enabled |
선택사항입니다. 설정하지 않으면 기본값은 부가기능의 맞춤 홈페이지 보기가 사용 중지된 경우 사용자에게 일반 개요 카드가 대신 제공됩니다. |
UniversalActionExtensionPoint
범용 작업 메뉴 항목 확장 포인트를 선언하는 형식입니다.
JSON 표현 |
---|
{ "label": string, // Union field |
필드 | |
---|---|
label |
필수 항목입니다. 이 확장 지점을 활성화하여 수행한 작업을 설명하는 사용자 표시 텍스트입니다(예: '새 연락처 추가'). |
통합 필드 action_type . 필수 항목입니다. 범용 작업 메뉴 항목에서 지원되는 작업 유형입니다. 이는 열 링크이거나 실행할 엔드포인트일 수 있습니다. action_type 은 다음 중 하나여야 합니다. |
|
open |
UniversalAction에서 열 URL입니다. |
run |
UniversalAction에서 실행할 엔드포인트입니다. |
GmailAddOnManifest
Gmail 부가기능의 모양과 실행을 맞춤설정하는 속성입니다.
JSON 표현 |
---|
{ "homepageTrigger": { object ( |
필드 | |
---|---|
homepage |
선언된 문맥 트리거와 일치하지 않는 컨텍스트에서 실행될 엔드포인트를 정의합니다. 이 함수로 생성된 카드는 사용자가 항상 사용할 수 있지만, 이 부가기능이 더 많이 타겟팅된 트리거를 선언하면 문맥 콘텐츠에 의해 가려질 수 있습니다. 있는 경우 |
contextual |
부가기능을 트리거하는 조건 집합을 정의합니다. |
universal |
부가기능의 범용 작업 집합을 정의합니다. 사용자가 부가기능 툴바 메뉴에서 범용 작업을 트리거합니다. |
compose |
작성 시간 부가기능의 작성 시간 트리거를 정의합니다. 이 트리거는 사용자가 이메일을 작성할 때 부가기능이 작업을 실행하도록 합니다. 모든 편지쓰기 시간 부가기능에는 초안을 수정할 수 없더라도 |
authorization |
서드 파티 API를 조사하여 부가기능에 필요한 모든 서드 파티 승인이 있는지 확인하는 엔드포인트의 이름입니다. 프로브가 실패하면 함수에서 승인 흐름을 시작하는 예외를 발생시켜야 합니다. 이 함수는 원활한 사용자 환경을 보장하기 위해 부가기능을 호출할 때마다 호출됩니다. |
ContextualTrigger
열린 이메일이 특정 기준을 충족할 때 실행되는 트리거를 정의합니다. 트리거가 실행되면 일반적으로 새 카드를 만들고 UI를 업데이트하기 위해 특정 엔드포인트를 실행합니다.
JSON 표현 |
---|
{ "onTriggerFunction": string, // Union field |
필드 | |
---|---|
on |
필수 항목입니다. 메시지가 트리거와 일치할 때 호출할 엔드포인트의 이름입니다. |
통합 필드 trigger . 트리거 유형에 따라 Gmail에서 부가기능을 표시하는 데 사용하는 조건이 결정됩니다. trigger 은 다음 중 하나여야 합니다. |
|
unconditional |
비조건부 트리거는 메일 메시지가 열릴 때 실행됩니다. |
UnconditionalTrigger
이 유형에는 필드가 없습니다.
이메일 메일이 열릴 때 실행되는 트리거입니다.
UniversalAction
메시지 컨텍스트와 관계없이 부가기능 툴바 메뉴에서 항상 사용할 수 있는 작업입니다.
JSON 표현 |
---|
{ "text": string, // Union field |
필드 | |
---|---|
text |
필수 항목입니다. 사용자에게 표시되는 작업을 설명하는 텍스트입니다(예: '새 연락처 추가'). |
통합 필드 action_type . 작업 유형에 따라 사용자가 작업을 호출할 때 Gmail의 동작이 결정됩니다. action_type 은 다음 중 하나여야 합니다. |
|
open |
사용자가 작업을 트리거할 때 Gmail에서 열리는 링크입니다. |
run |
사용자가 작업을 트리거할 때 호출되는 엔드포인트입니다. 자세한 내용은 범용 작업 가이드를 참고하세요. |
ComposeTrigger
사용자가 이메일을 작성할 때 활성화되는 트리거입니다.
JSON 표현 |
---|
{ "actions": [ { object ( |
필드 | |
---|---|
actions[] |
작성 시간 부가기능의 작업 집합을 정의합니다. 사용자가 편지쓰기 시간 부가기능에서 트리거할 수 있는 작업입니다. |
draft |
편지쓰기 시간 부가기능이 트리거될 때의 데이터 액세스 수준을 정의합니다. |
MenuItemExtensionPoint
호스트 앱 내에 표시되는 메뉴 항목 또는 버튼을 선언하는 일반적인 형식입니다.
JSON 표현 |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
필드 | |
---|---|
run |
필수 항목입니다. 이 확장 포인트가 활성화될 때 실행할 엔드포인트입니다. |
label |
필수 항목입니다. 이 확장 지점을 활성화하여 실행된 작업을 설명하는, 사용자에게 표시되는 텍스트입니다. 예: '인보이스 삽입' |
logo |
부가기능 툴바에 표시되는 로고 이미지의 URL입니다. 설정하지 않으면 기본값은 부가기능의 기본 로고 URL입니다. |
DraftAccess
Compose 트리거에 필요한 데이터 액세스 수준을 정의하는 열거형입니다.
열거형 | |
---|---|
UNSPECIFIED |
Draftaccess에 아무것도 설정되지 않았을 때의 기본값입니다. |
NONE |
Compose 트리거는 Compose 부가기능이 트리거될 때 초안의 어떠한 데이터에도 액세스할 수 없습니다. |
METADATA |
Compose 부가기능이 트리거될 때 초안의 메타데이터에 액세스할 수 있는 권한을 Compose 트리거에 부여합니다. 여기에는 초안 메일의 참조 및 참조 대상자 목록과 같은 수신자 목록이 포함됩니다. |
DriveAddOnManifest
Drive 부가기능의 모양과 실행을 맞춤설정하는 속성입니다.
JSON 표현 |
---|
{ "homepageTrigger": { object ( |
필드 | |
---|---|
homepage |
있는 경우 |
on |
내 드라이브 문서 목록과 같은 관련 Drive 보기에서 항목을 선택할 때 실행되는 동작에 해당합니다. |
DriveExtensionPoint
Drive 부가기능의 트리거를 선언하는 일반적인 형식입니다.
JSON 표현 |
---|
{ "runFunction": string } |
필드 | |
---|---|
run |
필수 항목입니다. 확장 포인트가 활성화될 때 실행할 엔드포인트입니다. |
CalendarAddOnManifest
Calendar 부가기능의 모양과 실행을 맞춤설정하는 속성입니다.
JSON 표현 |
---|
{ "homepageTrigger": { object ( |
필드 | |
---|---|
homepage |
선언된 문맥 트리거와 일치하지 않는 컨텍스트에서 실행되는 엔드포인트를 정의합니다. 이 함수로 생성된 카드는 항상 사용자에게 제공되지만 이 부가기능에서 더 타겟팅된 트리거를 선언하면 문맥 콘텐츠에 가려질 수 있습니다. 있는 경우 |
conference |
이 부가기능에서 제공하는 회의 솔루션을 정의합니다. 서드 파티 회의 부가기능은 Apps Script에서만 만들 수 있습니다. |
create |
부가기능의 설정 페이지로 연결되는 URL을 만드는 엔드포인트입니다. |
event |
보거나 수정할 수 있도록 이벤트가 열릴 때 트리거되는 엔드포인트입니다. |
event |
개방 이벤트가 업데이트될 때 트리거되는 엔드포인트입니다. |
event |
사용자가 Calendar 드롭다운 메뉴에서 부가기능 첨부파일 제공업체를 클릭할 때 실행되는 문맥 트리거의 구성입니다. |
current |
이벤트 부가기능이 트리거될 때의 데이터 액세스 수준을 정의합니다. |
ConferenceSolution
회의 관련 값을 정의합니다. 서드 파티 회의 부가기능은 Apps Script에서만 만들 수 있습니다.
JSON 표현 |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
필드 | |
---|---|
on |
필수 항목입니다. 회의 데이터를 만들어야 할 때 호출할 엔드포인트입니다. |
id |
필수 항목입니다. ID는 하나의 부가기능 내에서 회의 솔루션 전체에 고유하게 할당되어야 합니다. 그러지 않으면 부가기능이 트리거될 때 잘못된 회의 솔루션이 사용될 수 있습니다. 부가기능의 표시 이름은 변경할 수 있지만 ID는 변경해서는 안 됩니다. |
name |
필수 항목입니다. 회의 솔루션의 표시 이름입니다. |
logo |
필수 항목입니다. 회의 솔루션의 로고 이미지 URL입니다. |
CalendarExtensionPoint
캘린더 부가기능의 트리거를 선언하는 일반적인 형식입니다.
JSON 표현 |
---|
{ "runFunction": string } |
필드 | |
---|---|
run |
필수 항목입니다. 이 확장 포인트가 활성화될 때 실행할 엔드포인트입니다. |
EventAccess
데이터 액세스 이벤트 트리거에 필요한 수준을 정의하는 enum입니다.
열거형 | |
---|---|
UNSPECIFIED |
eventAccess에 아무것도 설정되지 않은 경우의 기본값입니다. |
METADATA |
이벤트 트리거에 이벤트 ID 및 캘린더 ID와 같은 이벤트 메타데이터에 액세스할 수 있는 권한을 부여합니다. |
READ |
이벤트 트리거에 메타데이터, 참석자, 회의 데이터 등 제공된 모든 이벤트 필드에 대한 액세스 권한을 부여합니다. |
WRITE |
이벤트 트리거에 이벤트의 메타데이터에 대한 액세스 권한과 참석자 추가, 회의 데이터 설정을 비롯한 모든 작업을 실행할 수 있는 기능을 부여합니다. |
READ_WRITE |
이벤트 트리거에 메타데이터, 참석자, 회의 데이터를 비롯한 제공된 모든 이벤트 필드에 대한 액세스 권한과 모든 작업을 실행할 수 있는 기능을 부여합니다. |
DocsAddOnManifest
Google Docs 부가기능의 모양과 실행을 맞춤설정하는 속성입니다.
JSON 표현 |
---|
{ "homepageTrigger": { object ( |
필드 | |
---|---|
homepage |
있는 경우 |
on |
이 문서/사용자 쌍에 대한 파일 범위 승인이 부여될 때 실행할 엔드포인트입니다. |
link |
Google Docs 문서에서 링크를 미리 볼 수 있는 확장 포인트 목록입니다. 자세한 내용은 스마트 칩을 사용한 미리보기 링크를 참고하세요. |
create |
Google Workspace 애플리케이션 내에서 서드 파티 리소스를 만들기 위한 확장 포인트 목록입니다. 자세한 내용은 @ 메뉴에서 서드 파티 리소스 만들기를 참고하세요. |
DocsExtensionPoint
문서 부가기능의 트리거를 선언하는 일반적인 형식입니다.
JSON 표현 |
---|
{ "runFunction": string } |
필드 | |
---|---|
run |
필수 항목입니다. 이 확장 포인트가 활성화될 때 실행할 엔드포인트입니다. |
LinkPreviewExtensionPoint
사용자가 서드 파티 또는 Google 이외의 서비스의 링크를 Google Docs, Sheets 또는 Slides 파일에 입력하거나 붙여넣을 때 실행되는 트리거의 구성입니다.
JSON 표현 |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
필드 | |
---|---|
label |
필수 항목입니다. 사용자에게 링크를 미리 보도록 메시지를 표시하는 스마트 칩 예시의 텍스트입니다(예: |
localized |
선택사항입니다. 다른 언어로 현지화하는 사용자의 언어가 지도 키에 있는 경우 사용자에게 현지화된 버전의
|
patterns[] |
필수 항목입니다. 링크 미리보기 부가기능을 트리거하는 URL 패턴 배열입니다. |
run |
필수 항목입니다. 링크 미리보기가 트리거될 때 실행할 엔드포인트입니다. |
logo |
선택사항입니다. 스마트 칩 및 미리보기 카드에 표시되는 아이콘 생략하면 부가기능의 툴바 아이콘인 |
UriPattern
링크 미리보기를 트리거하는 각 URL 패턴의 구성입니다.
JSON 표현 |
---|
{ "hostPattern": string, "pathPrefix": string } |
필드 | |
---|---|
host |
미리보기를 위해 각 URL 패턴에 필요합니다. URL 패턴의 도메인입니다. 부가기능은 URL에 이 도메인이 포함된 링크를 미리 봅니다. 특정 하위 도메인(예: 예를 들어 |
path |
선택사항입니다. 예를 들어 URL 호스트 패턴이 호스트 패턴 도메인의 모든 URL과 일치시키려면 |
CreateActionExtensionPoint
사용자가 Google Workspace 애플리케이션에서 리소스 생성 워크플로를 호출할 때 실행되는 트리거의 구성입니다. 자세한 내용은 @ 메뉴에서 서드 파티 리소스 만들기를 참고하세요.
JSON 표현 |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
필드 | |
---|---|
id |
필수 항목입니다. 이 확장 지점을 구분하기 위한 고유 ID입니다. ID는 최대 64자(영문 기준)까지 허용되며 |
label |
필수 항목입니다. 리소스 생성 진입점의 아이콘(예: |
localized |
선택사항입니다. 다른 언어로 현지화할 사용자의 언어가 지도 키에 있는 경우 사용자에게 현지화된 버전의
|
run |
필수 항목입니다. 리소스 생성 워크플로가 트리거되어 링크를 만들 때 실행할 엔드포인트입니다. |
logo |
선택사항입니다. 리소스 생성 진입점에 표시되는 아이콘입니다. 생략하면 메뉴에 부가기능의 툴바 아이콘( |
SheetsAddOnManifest
Google Sheets 부가기능의 모양과 실행을 맞춤설정하는 속성입니다.
JSON 표현 |
---|
{ "homepageTrigger": { object ( |
필드 | |
---|---|
homepage |
있는 경우 |
on |
이 문서/사용자 쌍에 파일 범위 승인이 부여되면 실행할 엔드포인트입니다. |
link |
Google Sheets 문서에서 링크를 미리 볼 수 있는 확장 포인트 목록입니다. 자세한 내용은 스마트 칩으로 링크 미리보기를 참고하세요. |
SheetsExtensionPoint
Sheets 부가기능의 트리거를 선언하는 일반적인 형식입니다.
JSON 표현 |
---|
{ "runFunction": string } |
필드 | |
---|---|
run |
필수 항목입니다. 이 확장 포인트가 활성화될 때 실행할 엔드포인트입니다. |
SlidesAddOnManifest
Google Slides 부가기능의 모양과 실행을 맞춤설정하는 속성입니다.
JSON 표현 |
---|
{ "homepageTrigger": { object ( |
필드 | |
---|---|
homepage |
있는 경우 |
on |
이 문서/사용자 쌍에 대한 파일 범위 승인이 부여될 때 실행할 엔드포인트입니다. |
link |
Google Slides 문서에서 링크를 미리 보기 위한 확장 지점 목록입니다. 자세한 내용은 스마트 칩으로 링크 미리보기를 참고하세요. |
SlidesExtensionPoint
Slides 부가기능의 트리거를 선언하는 일반적인 형식입니다.
JSON 표현 |
---|
{ "runFunction": string } |
필드 | |
---|---|
run |
필수 항목입니다. 이 확장 포인트가 활성화될 때 실행할 엔드포인트입니다. |
HttpOptions
부가기능 HTTP
엔드포인트에 요청을 전송하는 옵션입니다.
JSON 표현 |
---|
{
"authorizationHeader": enum ( |
필드 | |
---|---|
authorization |
|
HttpAuthorizationHeader
부가기능 HTTP
요청에서 전송된 승인 헤더입니다.
열거형 | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
기본값은 SYSTEM_ID_TOKEN 입니다. |
SYSTEM_ID_TOKEN |
프로젝트별 Google Workspace 부가기능의 시스템 서비스 계정(기본값)의 ID 토큰을 전송합니다. |
USER_ID_TOKEN |
최종 사용자의 ID 토큰을 전송합니다. |
NONE |
인증 헤더를 전송하지 않습니다. |
메서드 |
|
---|---|
|
지정된 이름과 구성으로 배포를 만듭니다. |
|
지정된 이름의 배포를 삭제합니다. |
|
지정된 이름의 배포를 가져옵니다. |
|
테스트 배포의 설치 상태를 가져옵니다. |
|
테스트를 위해 계정에 배포를 설치합니다. |
|
특정 프로젝트의 모든 배포를 나열합니다. |
|
지정된 이름으로 배포를 만들거나 대체합니다. |
|
사용자 계정에서 테스트 배포를 제거합니다. |