Package google.apps.card.v1

색인

작업

양식 제출 시의 동작을 설명하는 작업입니다. 예를 들어 Apps Script 스크립트를 호출하여 양식을 처리할 수 있습니다. 작업이 트리거되면 양식 값이 서버로 전송됩니다.

필드
function

string

포함하는 요소를 클릭하거나 별도로 활성화할 때 호출할 맞춤 함수입니다.

사용 예는 양방향 카드 만들기를 참고하세요.
parameters[]

ActionParameter

작업 매개변수 목록입니다.
loadIndicator

LoadIndicator

작업을 호출하는 동안 작업이 표시하는 로드 표시기를 지정합니다.
persistValues

bool

작업 후에 양식 값이 지속되는지 여부를 나타냅니다. 기본값은 false입니다.

true인 경우 액션이 트리거된 후에도 양식 값이 유지됩니다. 작업이 처리되는 동안 사용자가 변경할 수 있도록 LoadIndicator를 NONE로 설정합니다. Chat 앱의 카드 메시지의 경우 작업의 ResponseType을 UPDATE_MESSAGE로 설정하고 작업이 포함된 카드에서 동일한 card_id를 사용해야 합니다.

false인 경우 작업이 트리거될 때 양식 값이 지워집니다. 작업이 처리되는 동안 사용자가 변경하지 못하도록 하려면 LoadIndicator를 SPINNER로 설정합니다.
interaction

Interaction

선택사항입니다. 대화상자를 열 때 필요합니다.

사용자와의 상호작용(예: 사용자가 카드 메시지의 버튼을 클릭하는 경우)에 대한 응답으로 해야 할 작업입니다.

지정하지 않으면 앱이 정상적으로 action을 실행하여 응답합니다(예: 링크 열기, 함수 실행).

interaction를 지정하면 앱이 특수한 대화형 방식으로 응답할 수 있습니다. 예를 들어 interaction를 OPEN_DIALOG로 설정하면 앱에서 대화상자를 열 수 있습니다. 지정하면 로드 표시기가 표시되지 않습니다.

채팅 앱에서는 지원되지만 Google Workspace 부가기능에서는 지원되지 않습니다. 부가기능에 지정된 경우 전체 카드가 제거되고 클라이언트에 아무것도 표시되지 않습니다.

ActionParameter(작업 매개변수)

작업 메서드가 호출될 때 제공할 문자열 매개변수의 목록입니다. 예를 들어 지금 다시 알림, 하루 다시 알림, 다음 주에 다시 알림 등 3개의 다시 알림 버튼을 사용할 수 있습니다. 문자열 매개변수 목록에서 다시 알림 유형과 다시 알림 시간을 전달하는 action method = snooze()를 사용할 수 있습니다.

자세한 내용은 CommonEventObject를 참고하세요.

필드
key

string

액션 스크립트의 매개변수 이름입니다.
value

string

매개변수 값입니다.

상호작용

선택사항입니다. 대화상자를 열 때 필요합니다.

사용자와의 상호작용(예: 사용자가 카드 메시지의 버튼을 클릭하는 경우)에 대한 응답으로 해야 할 작업입니다.

지정하지 않으면 앱이 정상적으로 action을 실행하여 응답합니다(예: 링크 열기, 함수 실행).

interaction를 지정하면 앱이 특수한 대화형 방식으로 응답할 수 있습니다. 예를 들어 interaction를 OPEN_DIALOG로 설정하면 앱에서 대화상자를 열 수 있습니다.

지정하면 로드 표시기가 표시되지 않습니다.

채팅 앱에서는 지원되지만 Google Workspace 부가기능에서는 지원되지 않습니다. 부가기능에 지정된 경우 전체 카드가 제거되고 클라이언트에 아무것도 표시되지 않습니다.

열거형
INTERACTION_UNSPECIFIED 기본값 action는 정상적으로 실행됩니다.
OPEN_DIALOG

채팅 앱이 사용자와 상호작용하는 데 사용하는 창 형식의 카드 기반 인터페이스인 대화상자를 엽니다.

채팅 앱에서 카드 메시지의 버튼 클릭에 대한 응답으로만 지원됩니다.

Google Workspace 부가기능에서는 지원되지 않습니다. 부가기능에 지정된 경우 전체 카드가 제거되고 클라이언트에 아무것도 표시되지 않습니다.

로드 표시기

작업을 호출하는 동안 작업이 표시하는 로드 표시기를 지정합니다.

열거형
SPINNER 콘텐츠가 로드 중임을 나타내는 스피너를 표시합니다.
NONE 아무것도 표시되지 않습니다.

테두리 스타일

카드 또는 위젯의 테두리 스타일 옵션입니다(테두리 유형 및 색상 포함).

필드
type

BorderType

테두리 유형입니다.
strokeColor

Color

유형이 BORDER_TYPE_STROKE인 경우 사용할 색상입니다.
cornerRadius

int32

테두리의 모서리 반경입니다.

테두리 유형

위젯에 적용되는 테두리 유형을 나타냅니다.

열거형
BORDER_TYPE_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
NO_BORDER 기본값 테두리가 없습니다.
STROKE 윤곽선

버튼

사용자가 클릭할 수 있는 텍스트, 아이콘 또는 텍스트 및 아이콘 버튼입니다. Google Chat 앱의 예는 버튼 목록을 참고하세요.

이미지를 클릭 가능한 버튼으로 만들려면 ImageComponent가 아닌 Image를 지정하고 onClick 작업을 설정합니다.

필드
text

string

버튼 안에 표시되는 텍스트입니다.
icon

Icon

아이콘 이미지입니다. icon와 text가 모두 설정되면 아이콘이 텍스트 앞에 표시됩니다.
color

Color

설정하면 버튼이 단색 배경 색상으로 채워지고 글꼴 색상이 변경되어 배경 색상과 대비가 유지됩니다. 예를 들어 파란색 배경을 설정하면 텍스트가 흰색이 될 수 있습니다.

설정하지 않으면 이미지 배경은 흰색, 글꼴 색상은 파란색입니다.

빨간색, 녹색, 파란색의 경우 각 필드의 값은 두 가지 방법 중 하나로 표현할 수 있는 float 숫자입니다. 0과 255를 255로 나눈 값 (153/255) 또는 0과 1 사이의 값 (0.6)으로 표현됩니다. 0은 색상이 없음을 나타내고 1 또는 255/255는 RGB 스케일에서 해당 색상이 완전히 존재함을 나타냅니다.

원하는 경우 alpha를 설정하면 다음 공식을 사용하여 투명도 수준을 설정할 수 있습니다.

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

alpha의 경우 1 값은 단색에 해당하고 0 값은 완전히 투명한 색상에 해당합니다.

예를 들어 다음 색상은 반투명 빨간색을 나타냅니다.

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
   "alpha": 0.5
}
onClick

OnClick

필수 항목입니다. 하이퍼링크 열기 또는 맞춤 함수 실행과 같이 사용자가 버튼을 클릭할 때 수행할 작업입니다.
disabled

bool

true인 경우 버튼이 비활성 상태로 표시되고 사용자 작업에 응답하지 않습니다.
altText

string

접근성에 사용되는 대체 텍스트입니다.

사용자가 버튼의 기능을 알 수 있도록 설명 텍스트를 설정합니다. 예를 들어 버튼이 하이퍼링크를 여는 경우 '새 브라우저 탭을 열고 Google Chat 개발자 문서(https://developers.google.com/chat)로 이동합니다.'라고 쓸 수 있습니다.

버튼 목록

가로로 배치된 버튼 목록. Google Chat 앱의 예는 버튼 목록을 참고하세요.

필드
buttons[]

Button

버튼 배열입니다.

Card(카드)

Google Chat 메시지 또는 Google Workspace 부가기능에 표시되는 카드 인터페이스

카드는 정의된 레이아웃, 대화형 UI 요소(예: 버튼), 리치 미디어(예: 이미지)를 지원합니다. 카드를 사용하여 자세한 정보를 표시하고 사용자로부터 정보를 수집하며 사용자에게 다음 단계를 안내하세요.

카드를 빌드하는 방법을 알아보려면 다음 문서를 참고하세요.

예: Google Chat 앱의 카드 메시지

연락처 카드 예

Google Chat에서 샘플 카드 메시지를 만들려면 다음 JSON을 사용합니다.

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
          "title": "Sasha",
          "subtitle": "Software Engineer",
          "imageUrl":
          "https://developers.google.com/chat/images/quickstart-app-avatar.png",
          "imageType": "CIRCLE",
          "imageAltText": "Avatar for Sasha",
        },
        "sections": [
          {
            "header": "Contact Info",
            "collapsible": true,
            "uncollapsibleWidgetsCount": 1,
            "widgets": [
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "EMAIL",
                  },
                  "text": "sasha@example.com",
                }
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PERSON",
                  },
                  "text": "<font color=\"#80e27e\">Online</font>",
                },
              },
              {
                "decoratedText": {
                  "startIcon": {
                    "knownIcon": "PHONE",
                  },
                  "text": "+1 (555) 555-1234",
                }
              },
              {
                "buttonList": {
                  "buttons": [
                    {
                      "text": "Share",
                      "onClick": {
                        "openLink": {
                          "url": "https://example.com/share",
                        }
                      }
                    },
                    {
                      "text": "Edit",
                      "onClick": {
                        "action": {
                          "function": "goToView",
                          "parameters": [
                            {
                              "key": "viewType",
                              "value": "EDIT",
                            }
                          ],
                        }
                      }
                    },
                  ],
                }
              },
            ],
          },
        ],
      },
    }
  ],
}
필드
header

CardHeader

카드의 헤더입니다. 헤더에는 일반적으로 선행 이미지와 제목이 포함됩니다. 헤더는 항상 카드 상단에 표시됩니다.
sections[]

Section

위젯 컬렉션을 포함합니다. 각 섹션에는 고유한 선택적 헤더가 있습니다. 섹션은 구분선으로 시각적으로 구분됩니다. Google Chat 앱의 예는 카드 섹션을 참고하세요.
sectionDividerStyle

DividerStyle

섹션 간 구분선 스타일입니다.
cardActions[]

CardAction

카드의 작업 작업이 카드의 툴바 메뉴에 추가됩니다.

채팅 앱 카드에는 툴바가 없으므로 채팅 앱에서 cardActions[]이(가) 지원되지 않습니다.

예를 들어 다음 JSON은 Settings 및 Send Feedback 옵션이 있는 카드 작업 메뉴를 구성합니다.

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

카드 이름입니다. 카드 탐색에서 카드 식별자로 사용됩니다.

채팅 앱은 카드 탐색을 지원하지 않으므로 이 필드를 무시합니다.
fixedFooter

CardFixedFooter

카드 하단에 표시되는 고정된 바닥글입니다.

primaryButton 또는 secondaryButton를 지정하지 않고 fixedFooter를 설정하면 오류가 발생합니다.

Google Workspace 부가기능 및 Chat 앱에서 지원됩니다. Chat 앱의 경우 대화상자에서 고정된 바닥글을 사용할 수 있지만 카드 메시지에서는 사용할 수 없습니다.
displayStyle

DisplayStyle

Google Workspace 부가기능에서 peekCardHeader의 표시 속성을 설정합니다.

채팅 앱에서 지원되지 않습니다.
peekCardHeader

CardHeader

문맥 콘텐츠를 표시할 때 미리보기 카드 헤더는 사용자가 홈페이지 카드와 문맥 카드 사이를 앞으로 이동할 수 있도록 자리표시자 역할을 합니다.

채팅 앱에서 지원되지 않습니다.

카드 작업

카드 작업은 카드와 관련된 작업입니다. 예를 들어 인보이스 카드에는 인보이스 삭제, 이메일 인보이스 삭제 또는 브라우저에서 인보이스 열기와 같은 작업이 포함될 수 있습니다.

채팅 앱에서 지원되지 않습니다.

필드
actionLabel

string

작업 메뉴 항목으로 표시되는 라벨입니다.
onClick

OnClick

이 작업 항목의 onClick 작업입니다.

CardFixedFooter

카드 하단에 표시되는 영구 (고정) 바닥글 Google Chat 앱의 예는 카드 바닥글을 참고하세요.

primaryButton 또는 secondaryButton를 지정하지 않고 fixedFooter를 설정하면 오류가 발생합니다.

Google Workspace 부가기능 및 Chat 앱에서 지원됩니다. Chat 앱의 경우 대화상자에서 고정된 바닥글을 사용할 수 있지만 카드 메시지에서는 사용할 수 없습니다.

필드
primaryButton

Button

고정된 바닥글의 기본 버튼입니다. 버튼은 텍스트와 색상이 설정된 텍스트 버튼이어야 합니다.
secondaryButton

Button

고정된 바닥글의 보조 버튼입니다. 버튼은 텍스트와 색상이 설정된 텍스트 버튼이어야 합니다. secondaryButton가 설정되어 있으면 primaryButton도 설정해야 합니다.

카드헤더

카드 헤더를 나타냅니다. Google Chat 앱의 예는 카드 헤더를 참고하세요.

필드
title

string

필수 항목입니다. 카드 헤더의 제목입니다. 헤더의 높이는 고정되어 있습니다. 제목과 부제를 모두 지정하면 각각 한 줄을 차지합니다. 제목만 지정된 경우 두 줄을 모두 사용합니다.
subtitle

string

카드 헤더의 부제목입니다. 지정된 경우 title 아래의 자체 줄에 표시됩니다.
imageType

ImageType

이미지를 자르는 데 사용되는 도형입니다.
imageUrl

string

카드 헤더에 있는 이미지의 HTTPS URL입니다.
imageAltText

string

접근성에 사용되는 이 이미지의 대체 텍스트입니다.

표시 스타일

Google Workspace 부가기능에서 카드가 표시되는 방식을 결정합니다.

채팅 앱에서 지원되지 않습니다.

열거형
DISPLAY_STYLE_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
PEEK 카드 헤더는 사이드바 하단에 표시되며 스택의 현재 상단 카드를 부분적으로 덮습니다. 헤더를 클릭하면 카드가 카드 스택에 표시됩니다. 카드에 헤더가 없으면 생성된 헤더가 대신 사용됩니다.
REPLACE 기본값 카드 스택에서 상단 카드 뷰가 바뀌면서 카드가 표시됩니다.

구분선 스타일

카드의 구분선 스타일입니다. 현재는 카드 섹션 사이의 구분선에만 사용됩니다.

열거형
DIVIDER_STYLE_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
SOLID_DIVIDER 기본 옵션입니다. 섹션 사이에 실선 구분선을 렌더링합니다.
NO_DIVIDER 설정하면 섹션 사이에 구분선이 렌더링되지 않습니다.

섹션

섹션에는 지정된 순서대로 세로로 렌더링된 위젯 모음이 포함됩니다.

필드
header

string

섹션 상단에 표시되는 텍스트입니다. 간단한 HTML 형식의 텍스트를 지원합니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.
widgets[]

Widget

섹션의 모든 위젯 위젯을 1개 이상 포함해야 합니다.
collapsible

bool

이 섹션을 접을 수 있는지 여부를 나타냅니다.

접을 수 있는 섹션은 일부 또는 모든 위젯을 숨기지만 사용자는 더보기를 클릭하여 섹션을 펼쳐 숨겨진 위젯을 표시할 수 있습니다. 사용자는 간략히 보기를 클릭하여 위젯을 다시 숨길 수 있습니다.

숨겨진 위젯을 확인하려면 uncollapsibleWidgetsCount를 지정합니다.
uncollapsibleWidgetsCount

int32

섹션을 접어도 계속 표시되는 비축소형 위젯의 수입니다.

예를 들어 섹션에 5개의 위젯이 포함되어 있고 uncollapsibleWidgetsCount가 2로 설정된 경우 처음 두 개의 위젯은 항상 표시되고 마지막 세 개는 기본적으로 축소됩니다. uncollapsibleWidgetsCount는 collapsible가 true인 경우에만 고려됩니다.

열

Columns 위젯은 카드 메시지 또는 대화상자에 최대 2개의 열을 표시합니다. 각 열에 위젯을 추가할 수 있습니다. 위젯은 지정된 순서대로 표시됩니다. Google Chat 앱의 예는 열을 참고하세요.

각 열의 높이는 더 큰 열에 의해 결정됩니다. 예를 들어 첫 번째 열의 높이가 두 번째 열보다 크면 두 열 모두 첫 번째 열의 높이가 같습니다. 각 열에는 서로 다른 수의 위젯이 포함될 수 있으므로 행을 정의하거나 열 간에 위젯을 정렬할 수 없습니다.

열은 나란히 표시됩니다. HorizontalSizeStyle 필드를 사용하여 각 열의 너비를 맞춤설정할 수 있습니다. 사용자의 화면 너비가 너무 좁은 경우 두 번째 열이 첫 번째 열 아래로 줄바꿈됩니다.

  • 웹에서 화면 너비가 480픽셀 이하인 경우 두 번째 열이 래핑됩니다.
  • iOS 기기에서는 화면 너비가 300pt 이하인 경우 두 번째 열이 래핑됩니다.
  • Android 기기에서는 화면 너비가 320dp 이하이면 두 번째 열이 래핑됩니다.

3개 이상의 열을 포함하거나 행을 사용하려면 Grid 위젯을 사용합니다.

채팅 앱에서는 지원되지만 Google Workspace 부가기능에서는 지원되지 않습니다.

필드
columnItems[]

Column

열의 배열입니다. 카드 또는 대화상자에 최대 2개의 열을 포함할 수 있습니다.

열

열

필드
horizontalSizeStyle

HorizontalSizeStyle

열이 카드 너비를 채우는 방식을 지정합니다.
horizontalAlignment

HorizontalAlignment

위젯을 열의 왼쪽, 오른쪽 또는 가운데에 정렬할지 지정합니다.
verticalAlignment

VerticalAlignment

위젯을 열의 상단, 하단 또는 중앙에 정렬할지 여부를 지정합니다.
widgets[]

Widgets

열에 포함된 위젯 배열입니다. 위젯은 지정된 순서대로 표시됩니다.

가로 크기 스타일

열이 카드 너비를 채우는 방식을 지정합니다. 각 열의 너비는 HorizontalSizeStyle와 열 내의 위젯 너비에 따라 달라집니다.

열거형
HORIZONTAL_SIZE_STYLE_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
FILL_AVAILABLE_SPACE 기본값 열은 카드 너비의 최대 70% 까지 사용 가능한 공간을 채웁니다. 두 열이 모두 FILL_AVAILABLE_SPACE로 설정되어 있으면 각 열이 공간의 50% 를 채웁니다.
FILL_MINIMUM_SPACE 열은 최소한의 여백으로 카드 너비의 30% 를 넘지 않도록 해야 합니다.

세로 정렬

위젯을 열의 상단, 하단 또는 중앙에 정렬할지 여부를 지정합니다.

열거형
VERTICAL_ALIGNMENT_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
CENTER 기본값 위젯을 열 중앙에 정렬합니다.
TOP 위젯을 열 상단에 정렬합니다.
BOTTOM 위젯을 열 하단에 정렬합니다.

위젯

열에 포함할 수 있는 지원되는 위젯입니다.

필드

통합 필드 data.

data는 다음 중 하나여야 합니다.
textParagraph

TextParagraph

TextParagraph 위젯
image

Image

Image 위젯
decoratedText

DecoratedText

DecoratedText 위젯
buttonList

ButtonList

ButtonList 위젯
textInput

TextInput

TextInput 위젯
selectionInput

SelectionInput

SelectionInput 위젯
dateTimePicker

DateTimePicker

DateTimePicker 위젯

날짜 시간 선택 도구

사용자가 날짜, 시간 또는 날짜와 시간을 모두 입력할 수 있습니다. Google Chat 앱의 예는 날짜 시간 선택 도구를 참고하세요.

사용자는 텍스트를 입력하거나 선택 도구를 사용하여 날짜와 시간을 선택할 수 있습니다. 사용자가 잘못된 날짜나 시간을 입력하면 선택 도구에 오류가 표시되어 정보를 올바르게 입력하라는 메시지가 표시됩니다.

필드
name

string

양식 입력 이벤트에서 DateTimePicker가 식별되는 이름입니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
label

string

사용자에게 날짜, 시간 또는 날짜 및 시간을 입력하도록 요청하는 텍스트입니다. 예를 들어 사용자가 약속을 예약하는 경우 Appointment date 또는 Appointment date and time와 같은 라벨을 사용합니다.
type

DateTimePickerType

위젯이 날짜, 시간 또는 날짜 및 시간 입력을 지원하는지 여부
valueMsEpoch

int64

위젯에 표시되는 기본값(Unix 에포크 시간 이후 밀리초 단위)입니다.

선택 도구 유형에 따라 값을 지정합니다 (DateTimePickerType).

  • DATE_AND_TIME: UTC 기준의 캘린더 날짜 및 시간. 예를 들어 2023년 1월 1일 오후 12시(UTC)를 나타내려면 1672574400000를 사용합니다.
  • DATE_ONLY: UTC 00:00:00의 캘린더 날짜입니다. 예를 들어 2023년 1월 1일을 나타내려면 1672531200000를 사용합니다.
  • TIME_ONLY: UTC 기준의 시간입니다. 예를 들어 오후 12시를 나타내려면 43200000 (또는 12 * 60 * 60 * 1000)를 사용합니다.
timezoneOffsetDate

int32

UTC로부터의 시간대 오프셋을 나타내는 숫자(분)입니다. 설정하면 value_ms_epoch이 지정된 시간대로 표시됩니다. 설정하지 않으면 사용자의 시간대 설정으로 기본 설정됩니다.
onChangeAction

Action

사용자가 DateTimePicker 인터페이스에서 저장 또는 지우기를 클릭할 때 트리거됩니다.

DateTimePickerType

DateTimePicker 위젯의 날짜 및 시간 형식입니다. 사용자가 날짜, 시간 또는 날짜 및 시간 모두를 입력할 수 있는지 여부를 결정합니다.

열거형
DATE_AND_TIME 사용자가 날짜와 시간을 입력합니다.
DATE_ONLY 사용자가 날짜를 입력합니다.
TIME_ONLY 사용자가 시간을 입력합니다.

DecoratedText

텍스트 위 또는 아래의 라벨, 텍스트 앞에 있는 아이콘, 선택 위젯 또는 텍스트 뒤의 버튼과 같은 선택적 장식과 함께 텍스트를 표시하는 위젯입니다. Google Chat 앱의 예는 텍스트 장식을 참고하세요.

필드
icon
(deprecated)

Icon

지원 중단되고 startIcon로 대체되었습니다.
startIcon

Icon

텍스트 앞에 표시되는 아이콘입니다.
topLabel

string

text 위에 표시되는 텍스트 잘라냅니다.
text

string

필수 항목입니다. 기본 텍스트입니다.

간단한 형식을 지원합니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.
wrapText

bool

줄바꿈 설정입니다. true인 경우 텍스트가 줄바꿈되어 여러 줄로 표시됩니다. 그렇지 않으면 텍스트가 잘립니다.

text에만 적용되며 topLabel 및 bottomLabel에는 적용되지 않습니다.
bottomLabel

string

text 아래에 표시되는 텍스트입니다. 항상 래핑합니다.
onClick

OnClick

이 작업은 사용자가 topLabel 또는 bottomLabel를 클릭하면 트리거됩니다.
통합 필드 control. decoratedText 위젯에서 텍스트 오른쪽에 표시되는 버튼, 스위치, 체크박스 또는 이미지 control은 다음 중 하나여야 합니다.
button

Button

사용자가 클릭하여 작업을 트리거할 수 있는 버튼입니다.
switchControl

SwitchControl

사용자가 클릭하여 상태를 변경하고 작업을 트리거할 수 있는 스위치 위젯입니다.
endIcon

Icon

텍스트 다음에 표시되는 아이콘입니다.

내장 및 맞춤 아이콘을 지원합니다.

SwitchControl

전환 스타일 스위치 또는 decoratedText 위젯 내부의 체크박스

decoratedText 위젯에서만 지원됩니다.

필드
name

string

양식 입력 이벤트에서 스위치 위젯이 식별되는 이름입니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
value

string

사용자가 입력한 값으로, 양식 입력 이벤트의 일부로 반환됩니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
selected

bool

true인 경우 스위치가 선택됩니다.
onChangeAction

Action

실행할 함수와 같이 스위치 상태가 변경될 때 실행할 작업입니다.
controlType

ControlType

스위치가 사용자 인터페이스에 표시되는 방식입니다.

컨트롤 유형

스위치가 사용자 인터페이스에 표시되는 방식입니다.

열거형
SWITCH 전환 스위치 스타일 스위치
CHECKBOX 지원 중단되고 CHECK_BOX로 대체되었습니다.
CHECK_BOX 체크박스

구분선

이 유형에는 필드가 없습니다.

위젯 사이의 구분선을 가로선으로 표시합니다. Google Chat 앱의 예는 구분선을 참고하세요.

예를 들어 다음 JSON은 구분선을 만듭니다.

"divider": {}

GetAutocompletionResponse

텍스트 필드의 자동 완성 항목을 표시하는 데 필요한 요소가 포함된 자동 완성 컨테이너 가져오기에 대한 응답입니다. 예를 들면 다음과 같습니다.

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
필드
autoComplete

Suggestions
schema

string

이는 구문 검사를 위해 마크업에 표시될 수 있는 노옵스(no-ops) 스키마 필드입니다.

그리드

항목 컬렉션이 있는 그리드를 표시합니다. 항목에는 텍스트 또는 이미지만 포함할 수 있습니다. 반응형 열의 경우, 텍스트 또는 이미지 이상을 포함하려면 Columns를 사용합니다. Google Chat 앱의 예는 그리드를 참고하세요.

그리드에는 원하는 수의 열과 항목이 지원됩니다. 행 수는 항목을 열로 나눈 값으로 결정됩니다. 10개 항목과 2개의 열이 있는 그리드에는 5개의 행이 있습니다. 11개 항목과 2개의 열이 있는 그리드에는 6개의 행이 있습니다.

예를 들어 다음 JSON은 단일 항목이 있는 2개의 열 그리드를 만듭니다.

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
필드
title

string

그리드 헤더에 표시되는 텍스트입니다.
items[]

GridItem

그리드에 표시할 항목입니다.
borderStyle

BorderStyle

각 그리드 항목에 적용할 테두리 스타일입니다.
columnCount

int32

그리드에 표시할 열의 수입니다. 이 필드가 지정되지 않은 경우 기본값이 사용되며 해당 기본값은 그리드가 표시되는 위치 (대화상자 또는 컴패니언)에 따라 다릅니다.
onClick

OnClick

이 콜백은 개별 그리드 항목에서 재사용되지만 콜백의 매개변수에 추가된 항목 목록의 항목 식별자 및 색인을 사용합니다.

그리드 항목

그리드 레이아웃의 항목을 나타냅니다. 항목에는 텍스트나 이미지 또는 텍스트와 이미지가 모두 포함될 수 있습니다.

필드
id

string

이 그리드 항목의 사용자 지정 식별자입니다. 이 식별자는 상위 그리드의 onClick 콜백 매개변수로 반환됩니다.
image

ImageComponent

그리드 항목에 표시되는 이미지입니다.
title

string

그리드 항목의 제목입니다.
subtitle

string

그리드 항목의 부제목
layout

GridItemLayout

그리드 항목에 사용할 레이아웃입니다.

GridItemLayout

그리드 항목에 사용할 수 있는 다양한 레이아웃 옵션을 나타냅니다.

열거형
GRID_ITEM_LAYOUT_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
TEXT_BELOW 제목과 부제목은 그리드 항목의 이미지 아래에 표시됩니다.
TEXT_ABOVE 제목과 부제목은 그리드 항목의 이미지 위에 표시됩니다.

icon

카드의 위젯에 표시되는 아이콘입니다. Google Chat 앱의 예는 아이콘을 참고하세요.

내장 및 맞춤 아이콘을 지원합니다.

필드
altText

string

선택사항입니다. 접근성에 사용되는 아이콘에 대한 설명입니다. 지정하지 않으면 기본값 Button이 제공됩니다. 아이콘의 표시 내용과 아이콘의 기능에 대한 유용한 설명을 설정하는 것이 좋습니다(해당하는 경우). 예를 들면 A user's account portrait 또는 Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat입니다.

아이콘이 Button에 설정된 경우 사용자가 버튼 위로 마우스를 가져가면 altText가 도우미 텍스트로 표시됩니다. 그러나 버튼이 text도 설정하면 아이콘의 altText이 무시됩니다.
imageType

ImageType

이미지에 적용된 자르기 스타일 경우에 따라 CIRCLE 자르기를 적용하면 이미지가 기본 제공 아이콘보다 크게 그려질 수 있습니다.
통합 필드 icons. 카드의 위젯에 표시되는 아이콘입니다. icons은 다음 중 하나여야 합니다.
knownIcon

string

Google Workspace에서 제공하는 기본 제공 아이콘 중 하나를 표시합니다.

예를 들어 비행기 아이콘을 표시하려면 AIRPLANE를 지정합니다. 버스의 경우 BUS를 지정합니다.

지원되는 아이콘의 전체 목록은 내장 아이콘을 참고하세요.
iconUrl

string

HTTPS URL에서 호스팅되는 맞춤 아이콘을 표시합니다.

예를 들면 다음과 같습니다.

"iconUrl":
"https://developers.google.com/chat/images/quickstart-app-avatar.png"

지원되는 파일 형식은 .png 및 .jpg입니다.

이미지

URL로 지정되고 onClick 작업을 포함할 수 있는 이미지입니다. 예는 이미지를 참고하세요.

필드
imageUrl

string

이미지를 호스팅하는 HTTPS URL입니다.

예를 들면 다음과 같습니다.

https://developers.google.com/chat/images/quickstart-app-avatar.png
onClick

OnClick

사용자가 이미지를 클릭하면 클릭이 이 액션을 트리거합니다.
altText

string

접근성에 사용되는 이 이미지의 대체 텍스트입니다.

ImageComponent

이미지를 나타냅니다.

필드
imageUri

string

이미지 URL입니다.
altText

string

이미지의 접근성 라벨입니다.
cropStyle

ImageCropStyle

이미지에 적용할 자르기 스타일입니다.
borderStyle

BorderStyle

이미지에 적용할 테두리 스타일입니다.

이미지 자르기 스타일

이미지에 적용된 자르기 스타일을 나타냅니다.

예를 들어 16:9 가로세로 비율을 적용하는 방법은 다음과 같습니다.

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
필드
type

ImageCropType

자르기 유형입니다.
aspectRatio

double

자르기 유형이 RECTANGLE_CUSTOM인 경우 사용할 가로세로 비율입니다.

예를 들어 16:9 가로세로 비율을 적용하는 방법은 다음과 같습니다.

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

이미지 자르기 유형

이미지에 적용된 자르기 스타일을 나타냅니다.

열거형
IMAGE_CROP_TYPE_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
SQUARE 기본값 정사각형 자르기를 적용합니다.
CIRCLE 원형 자르기를 적용합니다.
RECTANGLE_CUSTOM 맞춤 가로세로 비율로 직사각형 자르기를 적용합니다. aspectRatio를 사용하여 맞춤 가로세로 비율을 설정합니다.
RECTANGLE_4_3 가로세로 비율이 4:3인 직사각형 자르기를 적용합니다.

링크 미리보기

카드와 스마트 칩을 표시하여 서드 파티 링크를 미리 보는 카드 작업입니다. 자세한 내용은 스마트 칩으로 링크 미리보기를 참고하세요.

예를 들어 다음 JSON은 링크 미리보기와 해당 스마트 칩의 고유한 제목과 헤더와 텍스트 설명이 포함된 미리보기 카드의 고유한 제목을 반환합니다.

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

이 예에서는 다음과 같은 링크 미리보기를 반환합니다.

링크 미리보기 예시

필드
previewCard

Card

서드 파티 서비스의 링크에 관한 정보가 표시된 카드입니다.
title

string

링크 미리보기의 스마트 칩에 표시되는 제목입니다. 설정되지 않으면 스마트 칩에 preview_card의 헤더가 표시됩니다.
linkPreviewTitle

string

링크 미리보기에 표시되는 제목입니다. 설정하지 않으면 링크 미리보기에 preview_card의 헤더가 표시됩니다.

카드 스택을 조작하는 카드 작업입니다. 예를 들면 다음과 같습니다.

1) 스택에 새 카드를 추가합니다 (앞으로 이동).

 navigations : {
    pushCard : CARD
  }

2) 스택 맨 위에 있는 카드를 업데이트합니다 (위치 업데이트).

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) 업데이트하지 않고 한 단계 뒤로 이동합니다.

  navigations : {
    popCard : true,
  }

4) 여러 단계로 돌아가 해당 카드를 업데이트합니다.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) 정의된 CARD_NAME로 여러 단계로 돌아갑니다.

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) 루트로 돌아가서 카드를 업데이트합니다.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) 지정된 카드로 이동하여 해당 카드를 엽니다.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) 상단 카드를 새 카드로 교체합니다.

  navigations : {
    updateCard : CARD
  }
필드

통합 필드 navigate_action.

navigate_action는 다음 중 하나여야 합니다.
popToRoot

bool

카드 스택에서 루트 카드를 제외한 모든 카드를 꺼냅니다.
pop

bool

카드 스택에서 카드 하나를 꺼냅니다.
popToCard

string

카드 스택은 지정된 카드 위에 주어진 카드 이름의 모든 카드를 표시합니다.
pushCard

Card

카드 스택은 카드를 카드 스택으로 밀어냅니다.
updateCard

Card

카드 스택은 상단 카드를 새 카드로 업데이트하고 채워진 양식 입력란 값을 유지합니다. 동일하지 않은 필드의 경우 값이 삭제됩니다.

알림

호스트 앱에 알림을 표시하는 카드 작업

필드
text

string

HTML 태그 없이 알림에 표시할 일반 텍스트입니다.

클릭 시

사용자가 버튼과 같은 카드의 상호작용 요소를 클릭할 때 응답하는 방법을 나타냅니다.

필드

통합 필드 data.

data는 다음 중 하나여야 합니다.
action

Action

지정하면 이 onClick에 의해 작업이 트리거됩니다.
openDynamicLinkAction

Action

부가기능은 작업에서 링크를 열어야 할 때 이 작업을 트리거합니다. 이 방법은 링크를 가져오려면 서버와 통신해야 한다는 점에서 위의 open_link와 다릅니다. 따라서 링크 열기 작업 응답이 반환되기 전에 웹 클라이언트에서 해야 할 준비 작업이 필요합니다. Google Workspace 부가기능에서는 지원되지만 Google Chat 앱에서는 지원되지 않습니다.
card

Card

지정된 경우 새 카드를 클릭한 후에 카드 스택으로 새 카드가 푸시됩니다.

Google Workspace 부가기능에서는 지원되지만 Google Chat 앱에서는 지원되지 않습니다.

OnClose

OnClick 작업으로 열린 링크가 닫힐 때 클라이언트가 하는 작업

구현은 클라이언트 플랫폼 기능에 따라 다릅니다. 예를 들어 웹브라우저에서 OnClose 핸들러를 사용하여 팝업 창에서 링크를 열 수 있습니다.

OnOpen 핸들러와 OnClose 핸들러가 모두 설정되어 있고 클라이언트 플랫폼에서 두 값을 모두 지원할 수 없는 경우 OnClose가 우선 적용됩니다.

Google Workspace 부가기능에서는 지원되지만 Google Chat 앱에서는 지원되지 않습니다.

열거형
NOTHING 기본값 카드가 새로고침되지 않고 아무 일도 일어나지 않습니다.
RELOAD

하위 창이 닫힌 후 카드를 새로고침합니다.

OpenAs.OVERLAY와 함께 사용하는 경우 하위 창이 모달 대화상자 역할을 하며 하위 창이 닫힐 때까지 상위 카드가 차단됩니다.

OpenAs

OnClick 작업이 링크를 열면 클라이언트는 전체 크기 창 (클라이언트에서 사용하는 프레임인 경우) 또는 오버레이 (예: 팝업)로 링크를 열 수 있습니다. 구현은 클라이언트 플랫폼 기능에 따라 다르며 클라이언트에서 지원하지 않는 경우 선택된 값은 무시될 수 있습니다. FULL_SIZE는 모든 클라이언트에서 지원됩니다.

Google Workspace 부가기능에서는 지원되지만 Google Chat 앱에서는 지원되지 않습니다.

열거형
FULL_SIZE 링크가 전체 크기 창으로 열립니다 (클라이언트가 사용하는 프레임인 경우).
OVERLAY 링크가 팝업과 같은 오버레이로 열립니다.

RenderActions

카드에 작업을 실행하도록 지시하거나 부가기능 호스트 앱에 앱별 작업을 실행하도록 지시하는 렌더링 명령 집합입니다.

필드
action

Action
hostAppAction

HostAppActionMarkup

개별 호스트 앱에서 처리하는 작업
schema

string

이는 구문 검사를 위해 마크업에 표시될 수 있는 노옵스(no-ops) 스키마 필드입니다.

작업

필드
navigations[]

Navigation

표시된 카드를 푸시하거나 팝하거나 업데이트합니다.
notification

Notification

최종 사용자에게 알림을 표시합니다.
linkPreview

LinkPreview

최종 사용자에게 링크 미리보기를 표시합니다.

선택 입력

사용자가 선택할 수 있는 하나 이상의 UI 항목을 만드는 위젯입니다. 예를 들어 드롭다운 메뉴나 체크박스 등이 있습니다. 이 위젯을 사용하여 예측하거나 열거할 수 있는 데이터를 수집할 수 있습니다. Google Chat 앱의 예는 선택 입력을 참고하세요.

채팅 앱은 사용자가 선택하거나 입력한 항목의 값을 처리할 수 있습니다. 양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.

사용자로부터 정의되지 않았거나 추상적인 데이터를 수집하려면 TextInput 위젯을 사용합니다.

필드
name

string

양식 입력 이벤트에서 선택 입력을 식별하는 이름입니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
label

string

사용자 인터페이스의 선택 입력란 위에 표시되는 텍스트입니다.

사용자가 앱에 필요한 정보를 입력하는 데 도움이 되는 텍스트를 지정합니다. 예를 들어 사용자가 드롭다운 메뉴에서 직장 티켓의 긴급도를 선택하는 경우 라벨은 '긴급' 또는 '긴급한 정도 선택'이 될 수 있습니다.
type

SelectionType

SelectionInput 위젯에서 사용자에게 표시되는 항목 유형입니다. 선택 유형은 다양한 유형의 상호작용을 지원합니다. 예를 들어 사용자는 하나 이상의 체크박스를 선택할 수 있지만 드롭다운 메뉴에서 하나의 값만 선택할 수 있습니다.
items[]

SelectionItem

선택 가능한 항목의 배열입니다. 예를 들어 라디오 버튼 또는 체크박스의 배열이 있습니다. 최대 100개의 항목을 지원합니다.
onChangeAction

Action

지정하면 선택 항목이 변경될 때 양식이 제출됩니다. 지정하지 않으면 양식을 제출하는 별도의 버튼을 지정해야 합니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
multiSelectMaxSelectedItems

int32

다중 선택 메뉴의 경우 사용자가 선택할 수 있는 최대 항목 수입니다. 최솟값은 항목 1개입니다. 지정하지 않으면 항목 3개로 설정합니다.

multiSelectMinQueryLength

int32

다중 선택 메뉴의 경우 채팅 앱 쿼리 전에 사용자가 입력하는 텍스트 문자의 수가 자동 완성되고 카드에 추천 항목이 표시됩니다.

지정하지 않는 경우 정적 데이터 소스는 0자로, 외부 데이터 소스는 3자로 설정합니다.

통합 필드 multi_select_data_source. 채팅 앱만 해당. 다중 선택 메뉴의 경우 데이터 소스 유형입니다. multi_select_data_source는 다음 중 하나여야 합니다.
externalDataSource

Action

외부 데이터 소스(예: 관계형 데이터 베이스)

platformDataSource

PlatformDataSource

Google Workspace 호스트 애플리케이션의 데이터 소스

플랫폼 데이터 소스

채팅 앱만 해당. 다중 선택 메뉴를 사용하는 SelectionInput 위젯의 경우 Google Workspace 호스트 애플리케이션의 데이터 다중 선택 메뉴의 항목을 채우는 데 사용됩니다.

필드
통합 필드 data_source. 데이터 소스 data_source는 다음 중 하나여야 합니다.
commonDataSource

CommonDataSource

다중 선택 메뉴를 사용하는 SelectionInput 위젯의 경우 모든 Google Workspace 호스트 애플리케이션(예: Google Workspace 조직의 사용자)에서 공유하는 데이터 소스입니다.

hostAppDataSource

HostAppDataSourceMarkup

Gmail 이메일, Google Calendar 일정, Google Chat 메시지와 같은 Google Workspace 호스트 애플리케이션의 고유한 데이터 소스입니다.

CommonDataSource

채팅 앱만 해당. 모든 Google Workspace 호스트 애플리케이션에서 공유하는 데이터 소스

열거형
UNKNOWN 기본값 사용하지 마세요.
USER

Google Workspace 호스트 애플리케이션에서 제공하는 사용자 목록입니다. 예를 들어 Google Chat에서 사용자를 가져오려면 user의 리소스 이름을 사용합니다.

형식: users/{user}

선택 항목

체크박스 또는 스위치와 같은 선택 입력에서 사용자가 선택할 수 있는 항목입니다.

필드
text

string

사용자에게 상품을 식별하거나 설명하는 텍스트입니다.
value

string

이 상품과 연결된 값입니다. 클라이언트는 이 값을 양식 입력 값으로 사용해야 합니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
selected

bool

항목이 기본으로 선택되는지 여부입니다. 선택 입력에 하나의 값만 허용하는 경우 (예: 라디오 버튼 또는 드롭다운 메뉴) 이 필드를 하나의 항목에만 설정하세요.
startIconUri

string

다중 선택 메뉴의 경우 항목의 text 필드 옆에 표시되는 아이콘의 URL입니다. PNG 및 JPEG 파일을 지원합니다. HTTPS URL이어야 합니다. https://developers.google.com/chat/images/quickstart-app-avatar.png를 예로 들 수 있습니다.

bottomText

string

다중 선택 메뉴의 경우, 항목의 text 입력란 아래에 표시되는 텍스트 설명 또는 라벨입니다.

선택 유형

사용자가 선택할 수 있는 항목의 형식입니다. 옵션마다 지원하는 상호작용 유형이 다릅니다. 예를 들어 사용자는 여러 체크박스를 선택할 수 있지만 드롭다운 메뉴에서는 하나의 항목만 선택할 수 있습니다.

각 선택 입력은 한 가지 선택 유형을 지원합니다. 예를 들어 체크박스와 스위치를 함께 사용하는 것은 지원되지 않습니다.

열거형
CHECK_BOX 체크박스 세트입니다. 사용자는 체크박스를 하나 이상 선택할 수 있습니다.
RADIO_BUTTON 라디오 버튼 집합입니다. 사용자는 하나의 라디오 버튼을 선택할 수 있습니다.
SWITCH 스위치 집합입니다. 사용자는 하나 이상의 스위치를 사용 설정할 수 있습니다.
DROPDOWN 드롭다운 메뉴 사용자는 메뉴에서 항목 1개를 선택할 수 있습니다.
MULTI_SELECT

채팅 앱에서는 지원되지만 Google Workspace 부가기능에서는 지원되지 않습니다.

정적 또는 동적 데이터에 대한 다중 선택 메뉴 메뉴 바에서 하나 이상의 항목을 선택합니다. 사용자는 값을 입력하여 동적 데이터를 채울 수도 있습니다. 예를 들어 사용자가 Google Chat 스페이스 이름을 입력하기 시작하면 위젯에서 스페이스를 자동으로 추천합니다.

다중 선택 메뉴의 항목을 채우려면 다음 데이터 소스 유형 중 하나를 사용하면 됩니다.

  • 정적 데이터: 항목은 위젯에서 SelectionItem 객체로 지정됩니다. 최대 100개 항목
  • Google Workspace 데이터: Google Chat 사용자 또는 스페이스와 같은 Google Workspace 애플리케이션의 데이터를 사용하여 항목이 채워집니다.
  • 외부 데이터: 항목이 동적 외부 데이터 소스에서 채워집니다.

다중 선택 메뉴를 구현하는 방법의 예는 SelectionInput 위젯 페이지를 참고하세요.

양식 응답 제출

자동 완성 컨테이너를 가져오는 것 외에 양식 제출에 대한 응답으로, 카드가 실행해야 하는 작업 또는 부가기능 호스트 앱이 실행해야 하는 작업과 카드 상태가 변경되었는지 여부가 포함됩니다. 예를 들면 다음과 같습니다.

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
필드
renderActions

RenderActions

카드에 작업을 실행하도록 지시하거나 부가기능 호스트 앱에 앱별 작업을 실행하도록 지시하는 렌더링 명령 집합입니다.
stateChanged

bool

카드 상태가 변경되었고 기존 카드의 데이터가 비활성 상태인지 여부
schema

string

이는 구문 검사를 위해 마크업에 표시될 수 있는 노옵스(no-ops) 스키마 필드입니다.

제안

사용자가 입력할 수 있는 추천 값입니다. 이 값은 사용자가 텍스트 입력란 내부를 클릭하면 표시됩니다. 사용자가 입력할 때 추천 값은 사용자가 입력한 내용과 일치하도록 동적으로 필터링됩니다.

예를 들어 프로그래밍 언어의 텍스트 입력란에는 자바, 자바스크립트, Python, C++를 추천할 수 있습니다. 사용자가 Jav을 입력하기 시작하면 추천 검색어 목록이 필터링되어 Java 및 JavaScript가 표시됩니다.

추천 값은 사용자가 앱에서 이해할 수 있는 값을 입력하는 데 도움이 됩니다. JavaScript를 언급할 때 어떤 사용자는 javascript를 입력하고 다른 사용자는 java script를 입력할 수 있습니다. JavaScript 추천을 통해 사용자가 앱과 상호작용하는 방식을 표준화할 수 있습니다.

TextInput.type을 지정하면 MULTIPLE_LINE로 설정되더라도 항상 SINGLE_LINE입니다.

필드
items[]

SuggestionItem

텍스트 입력란의 자동 완성 추천에 사용되는 추천 검색어 목록입니다.

추천 항목

사용자가 텍스트 입력란에 입력할 수 있는 추천 값입니다.

필드

통합 필드 content.

content는 다음 중 하나여야 합니다.
text

string

텍스트 입력란에 표시되는 추천 입력 값입니다. 사용자가 직접 입력하는 것과 같습니다.

TextInput

사용자가 텍스트를 입력할 수 있는 입력란입니다. 추천 및 변경 시 작업을 지원합니다. Google Chat 앱의 예는 텍스트 입력을 참고하세요.

채팅 앱은 양식 입력 이벤트 중에 입력된 텍스트의 값을 수신하고 처리할 수 있습니다. 양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.

사용자로부터 정의되지 않았거나 추상화된 데이터를 수집해야 하는 경우 텍스트 입력을 사용하세요. 사용자로부터 정의되거나 열거된 데이터를 수집하려면 SelectionInput 위젯을 사용합니다.

필드
name

string

양식 입력 이벤트에서 텍스트 입력이 식별되는 이름입니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
label

string

사용자 인터페이스의 텍스트 입력란 위에 표시되는 텍스트입니다.

사용자가 앱에 필요한 정보를 입력하는 데 도움이 되는 텍스트를 지정합니다. 예를 들어, 누군가의 이름을 묻고 있지만 구체적으로 성이 필요한 경우 name 대신 surname라고 입력합니다.

hintText가 지정되지 않은 경우 필수입니다. 그렇지 않은 경우에는 선택사항입니다.
hintText

string

텍스트 입력란 아래에 표시되는 텍스트로, 사용자에게 특정 값을 입력하라는 메시지를 표시하여 도움을 줍니다. 이 텍스트는 항상 표시됩니다.

label가 지정되지 않은 경우 필수입니다. 그렇지 않은 경우에는 선택사항입니다.
value

string

사용자가 입력한 값으로, 양식 입력 이벤트의 일부로 반환됩니다.

양식 입력 작업에 대한 자세한 내용은 양식 데이터 수신을 참고하세요.
type

Type

사용자 인터페이스에 텍스트 입력란이 표시되는 방식입니다. 예를 들어 필드가 단선형인지 또는 여러 줄인지 여부입니다.
onChangeAction

Action

텍스트 입력란에 변경사항이 발생하면 해야 할 일 예를 들어 사용자가 입력란에 내용을 추가하거나 텍스트를 삭제합니다.

실행할 작업의 예로는 맞춤 함수를 실행하거나 Google Chat에서 대화상자를 여는 작업이 있습니다.
initialSuggestions

Suggestions

사용자가 입력할 수 있는 추천 값입니다. 이 값은 사용자가 텍스트 입력란 내부를 클릭하면 표시됩니다. 사용자가 입력할 때 추천 값은 사용자가 입력한 내용과 일치하도록 동적으로 필터링됩니다.

예를 들어 프로그래밍 언어의 텍스트 입력란에는 자바, 자바스크립트, Python, C++를 추천할 수 있습니다. 사용자가 Jav을 입력하기 시작하면 추천 검색어 목록이 필터링되어 Java와 JavaScript만 표시됩니다.

추천 값은 사용자가 앱에서 이해할 수 있는 값을 입력하는 데 도움이 됩니다. JavaScript를 언급할 때 어떤 사용자는 javascript를 입력하고 다른 사용자는 java script를 입력할 수 있습니다. JavaScript 추천을 통해 사용자가 앱과 상호작용하는 방식을 표준화할 수 있습니다.

TextInput.type을 지정하면 MULTIPLE_LINE로 설정되더라도 항상 SINGLE_LINE입니다.
autoCompleteAction

Action

선택사항입니다. 텍스트 입력란이 상호작용하는 사용자에게 제안사항이 표시될 때 실행할 작업을 지정합니다.

지정하지 않으면 추천 항목이 initialSuggestions에 의해 설정되고 클라이언트에서 처리됩니다.

지정하면 앱이 여기에 지정된 작업을 수행합니다(예: 맞춤 함수 실행).

Google Workspace 부가기능에서는 지원되지만 Google Chat 앱에서는 지원되지 않습니다.
placeholderText

string

필드가 비어 있을 때 텍스트 입력란에 표시되는 텍스트입니다. 이 텍스트를 사용하여 사용자에게 값을 입력하라는 메시지를 표시합니다. 예를 들면 Enter a number from 0 to 100입니다.

Google Chat 앱에서는 지원되지만 Google Workspace 부가기능에서는 지원되지 않습니다.

유형

사용자 인터페이스에 텍스트 입력란이 표시되는 방식입니다. 예를 들어 단일 줄 입력 필드인지 또는 여러 줄 입력인지를 지정할 수 있습니다.

initialSuggestions가 지정되면 type는 MULTIPLE_LINE로 설정되더라도 항상 SINGLE_LINE입니다.

열거형
SINGLE_LINE 텍스트 입력란의 높이는 한 줄로 고정되어 있습니다.
MULTIPLE_LINE 텍스트 입력란의 높이는 여러 줄로 고정되어 있습니다.

TextParagraph

서식을 지원하는 텍스트 단락입니다. Google Chat 앱의 예는 텍스트 단락을 참고하세요. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.

필드
text

string

위젯에 표시되는 텍스트입니다.

위젯

각 카드는 위젯으로 구성됩니다.

위젯은 텍스트, 이미지, 버튼 및 기타 객체 유형 중 하나를 나타낼 수 있는 복합 객체입니다.

필드
horizontalAlignment

HorizontalAlignment

위젯을 열의 왼쪽, 오른쪽 또는 가운데에 정렬할지 지정합니다.
통합 필드 data. 위젯에는 다음 항목 중 하나만 있을 수 있습니다. 여러 위젯 필드를 사용하여 더 많은 항목을 표시할 수 있습니다. data은 다음 중 하나여야 합니다.
textParagraph

TextParagraph

텍스트 단락을 표시합니다. 간단한 HTML 형식의 텍스트를 지원합니다. 텍스트 서식 지정에 관한 자세한 내용은 Google Chat 앱의 텍스트 서식 지정 및 Google Workspace 부가기능에서 텍스트 서식 지정을 참고하세요.

예를 들어 다음 JSON은 굵은 텍스트를 만듭니다.

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

Image

이미지를 표시합니다.

예를 들어 다음 JSON은 대체 텍스트를 사용하여 이미지를 만듭니다.

"image": {
  "imageUrl":
  "https://developers.google.com/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

DecoratedText

데코레이트된 텍스트 항목을 표시합니다.

예를 들어 다음 JSON은 이메일 주소를 표시하는 데코레이션된 텍스트 위젯을 만듭니다.

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

ButtonList

버튼 목록.

예를 들어 다음 JSON은 버튼 두 개를 만듭니다. 첫 번째는 파란색 텍스트 버튼, 두 번째는 링크를 여는 이미지 버튼입니다.

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
        "alpha": 1
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

TextInput

사용자가 입력할 수 있는 텍스트 상자를 표시합니다.

예를 들어 다음 JSON은 이메일 주소에 대한 텍스트 입력을 만듭니다.

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

또 다른 예로, 다음 JSON은 정적 제안을 사용하여 프로그래밍 언어에 대한 텍스트 입력을 만듭니다.

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

SelectionInput

사용자가 항목을 선택할 수 있는 선택 컨트롤을 표시합니다. 선택 컨트롤은 체크박스, 라디오 버튼, 스위치 또는 드롭다운 메뉴일 수 있습니다.

예를 들어 다음 JSON에서는 사용자가 크기를 선택할 수 있는 드롭다운 메뉴를 만듭니다.

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

DateTimePicker

사용자가 날짜, 시간 또는 날짜 및 시간을 입력할 수 있는 위젯을 표시합니다.

예를 들어 다음 JSON은 약속을 예약하기 위한 날짜 시간 선택 도구를 만듭니다.

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}
divider

Divider

위젯 사이에 가로 줄 구분선을 표시합니다.

예를 들어 다음 JSON은 구분선을 만듭니다.

"divider": {
}
grid

Grid

항목 컬렉션이 있는 그리드를 표시합니다.

그리드에는 원하는 수의 열과 항목이 지원됩니다. 행 수는 항목 수의 상한값을 열 수로 나눈 값으로 결정됩니다. 10개 항목과 2개의 열이 있는 그리드에는 5개의 행이 있습니다. 11개 항목과 2개의 열이 있는 그리드에는 6개의 행이 있습니다.

예를 들어 다음 JSON은 단일 항목이 있는 2개의 열 그리드를 만듭니다.

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

Columns

최대 2개의 열을 표시합니다.

3개 이상의 열을 포함하거나 행을 사용하려면 Grid 위젯을 사용합니다.

예를 들어 다음 JSON은 각각 텍스트 단락을 포함하는 2개의 열을 만듭니다.

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

가로 정렬

위젯을 열의 왼쪽, 오른쪽 또는 가운데에 정렬할지 지정합니다.

열거형
HORIZONTAL_ALIGNMENT_UNSPECIFIED 사용하지 마세요. 지정되지 않았습니다.
START 기본값 위젯을 열의 시작 위치에 정렬합니다. 왼쪽에서 오른쪽 레이아웃인 경우 왼쪽으로 정렬됩니다. 오른쪽에서 왼쪽 레이아웃의 경우 오른쪽으로 정렬됩니다.
CENTER 위젯을 열 중앙에 정렬합니다.
END 위젯을 열의 끝 위치에 정렬합니다. 왼쪽에서 오른쪽 레이아웃의 경우 위젯을 오른쪽으로 정렬합니다. 오른쪽에서 왼쪽 레이아웃의 경우 위젯을 왼쪽으로 정렬합니다.

이미지 유형

이미지를 자르는 데 사용되는 도형입니다.

열거형
SQUARE 기본값 이미지에 정사각형 마스크를 적용합니다. 예를 들어 4x3 이미지는 3x3이 됩니다.
CIRCLE 이미지에 원형 마스크를 적용합니다. 예를 들어 4x3 이미지는 지름이 3인 원이 됩니다.