Cards v1

카드

카드는 텍스트, 이미지와 같은 UI 위젯을 포함할 수 있는 UI 요소입니다.

JSON 표현 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
필드
header

object (CardHeader)

카드의 헤더입니다. 헤더에는 일반적으로 제목과 이미지가 포함됩니다.

sections[]

object (Section)

섹션은 선 구분선으로 구분됩니다.

cardActions[]

object (CardAction)

이 카드의 작업입니다.

name

string

카드 이름입니다.

CardHeader

JSON 표현 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
필드
title

string

제목을 지정해야 합니다. 헤더의 높이는 고정되어 있습니다. 제목과 부제목이 모두 지정된 경우 각각 한 줄을 차지합니다. 제목만 지정하면 두 줄을 모두 차지합니다.

subtitle

string

카드 헤더의 부제목입니다.

imageStyle

enum (ImageStyle)

이미지의 유형입니다 (예: 정사각형 테두리 또는 원형 테두리).

imageUrl

string

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

ImageStyle

열거형
IMAGE_STYLE_UNSPECIFIED
IMAGE 사각형 테두리
AVATAR 원형 테두리

섹션

섹션에는 지정된 순서대로 렌더링되는 위젯 모음이 포함됩니다 (세로). 모든 플랫폼에서 카드의 고정 너비가 좁으므로 현재 레이아웃 속성 (예: float)이 필요하지 않습니다.

JSON 표현 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
필드
header

string

섹션의 헤더입니다. 형식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 대한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요.

widgets[]

object (WidgetMarkup)

섹션에는 위젯이 하나 이상 포함되어야 합니다.

WidgetMarkup

위젯은 텍스트와 이미지를 표시하는 UI 요소입니다.

JSON 표현 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
필드
buttons[]

object (Button)

버튼 목록입니다. 버튼도 oneof data이며 이러한 필드 중 하나만 설정해야 합니다.

WidgetMarkup에는 다음 항목 중 하나만 있을 수 있습니다. WidgetMarkup 필드를 여러 개 사용하여 항목을 더 많이 표시할 수 있습니다. 다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
textParagraph

object (TextParagraph)

이 위젯에 텍스트 단락을 표시합니다.

image

object (Image)

이 위젯에 이미지를 표시합니다.

keyValue

object (KeyValue)

이 위젯에 키 값 항목을 표시합니다.

상호 배타적 필드의 끝입니다.

TextParagraph

텍스트 단락 형식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 대한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요.

JSON 표현 
{
  "text": string
}
필드
text

string

이미지

URL로 지정되고 onclick 작업을 할 수 있는 이미지입니다.

JSON 표현 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
필드
imageUrl

string

이미지의 URL입니다.

onClick

object (OnClick)

onclick 작업을 사용하여 인텐트를 전송합니다.

aspectRatio

number

이 이미지의 가로세로 비율 (너비 및 높이)입니다. 이 필드를 사용하면 이미지가 로드되는 동안 이미지의 적절한 높이를 예약할 수 있습니다. 이미지의 내장 가로세로 비율을 재정의하기 위한 것이 아닙니다. 설정되지 않은 경우 서버는 이미지를 미리 가져와서 채웁니다.

OnClick

onclick 작업 (예: 링크 열기)

JSON 표현 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
필드
다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
action

object (FormAction)

지정된 경우 이 onclick 작업에 의해 양식 작업이 트리거됩니다.

상호 배타적 필드의 끝입니다.

FormAction

양식 작업은 양식이 제출될 때의 동작을 설명합니다. 예를 들어 Apps Script를 호출하여 양식을 처리할 수 있습니다.

JSON 표현 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
필드
actionMethodName

string

메서드 이름은 양식 제출을 트리거한 양식의 부분을 식별하는 데 사용됩니다. 이 정보는 카드 클릭 이벤트의 일부로 채팅 앱에 다시 에코됩니다. 공통 동작을 트리거하는 여러 요소에 동일한 메서드 이름을 사용할 수 있습니다.

parameters[]

object (ActionParameter)

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

ActionParameter

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

JSON 표현 
{
  "key": string,
  "value": string
}
필드
key

string

작업 스크립트의 매개변수 이름입니다.

value

string

매개변수의 값입니다.

KeyValue

UI 요소에는 키 (라벨)와 값 (콘텐츠)이 포함됩니다. 이 요소에는 onclick 버튼과 같은 일부 작업도 포함될 수 있습니다.

JSON 표현 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
필드
topLabel

string

상단 라벨의 텍스트입니다. 형식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 대한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요.

content

string

콘텐츠의 텍스트입니다. 형식이 지정된 텍스트가 지원되며 항상 필요합니다. 텍스트 서식 지정에 대한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요.

contentMultiline

boolean

콘텐츠가 여러 줄로 표시되어야 하는지 여부입니다.

bottomLabel

string

하단 라벨의 텍스트입니다. 형식이 지정된 텍스트가 지원됩니다. 텍스트 서식 지정에 대한 자세한 내용은 Google Chat 앱에서 텍스트 서식 지정하기 및 Google Workspace 부가기능에서 텍스트 서식 지정하기를 참고하세요.

onClick

object (OnClick)

onclick 작업을 사용하여 인텐트를 전송합니다. 상단 라벨, 하단 라벨, 콘텐츠 영역만 클릭할 수 있습니다.

아이콘, top_label, bottom_label 중 하나 이상을 정의해야 합니다. 다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
icon

enum (Icon)

Chat API에서 해당 아이콘 이미지로 대체되는 enum 값입니다.

iconUrl

string

URL로 지정된 아이콘입니다.

상호 배타적 필드의 끝입니다.
제어 위젯입니다. button 또는 switch_widget 중 하나를 설정할 수 있지만 둘 다 설정할 수는 없습니다. 다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
button

object (Button)

클릭하여 작업을 트리거할 수 있는 버튼

상호 배타적 필드의 끝입니다.

아이콘

지원되는 아이콘 집합입니다.

열거형
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

버튼

버튼입니다. 텍스트 버튼 또는 이미지 버튼일 수 있습니다.

JSON 표현 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
필드
다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
textButton

object (TextButton)

텍스트와 onclick 작업이 있는 버튼

imageButton

object (ImageButton)

이미지와 onclick 작업이 있는 버튼

상호 배타적 필드의 끝입니다.

TextButton

텍스트와 onclick 작업이 있는 버튼

JSON 표현 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
필드
text

string

버튼의 텍스트입니다.

onClick

object (OnClick)

버튼의 onclick 작업입니다.

ImageButton

onclick 작업이 있는 이미지 버튼

JSON 표현 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
필드
onClick

object (OnClick)

onclick 작업을 사용하여 인텐트를 전송합니다.

name

string

접근성에 사용되는 이 imageButton의 이름입니다. 이름이 지정되지 않은 경우 기본값이 제공됩니다.

아이콘은 Icon, enum 또는 URL로 지정할 수 있습니다. 다음은 상호 배타적인 필드 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
icon

enum (Icon)

Chat API에서 제공하는 아이콘을 색인화하는 enum에 의해 지정된 아이콘

iconUrl

string

URL로 지정된 아이콘입니다.

상호 배타적 필드의 끝입니다.

CardAction

카드 작업은 카드와 연결된 작업입니다. 인보이스 카드의 경우 일반적인 작업은 인보이스 삭제, 인보이스 이메일 전송, 브라우저에서 인보이스 열기입니다.

Google Chat 앱에서 지원되지 않습니다.

JSON 표현 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
필드
actionLabel

string

이 라벨은 작업 메뉴 항목에 표시되었습니다.

onClick

object (OnClick)

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