이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Class Chip

아이콘과 텍스트 라벨이 있는 Chip 필요한 경우 칩을 비활성화할 수 있습니다.

Google Chat 앱에서 사용할 수 있습니다. Google Workspace 부가기능 개발자 프리뷰에서

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

메서드

메서드	반환 유형	간략한 설명
`setAltText(altText)`	`Chip`	접근성을 위해 칩의 대체 텍스트를 설정합니다.
`setAuthorizationAction(action)`	`Chip`	객체가 클릭될 때 승인 흐름의 URL을 여는 승인 작업을 설정합니다.
`setComposeAction(action, composedEmailType)`	`Chip`	객체를 클릭할 때 이메일 초안을 작성하는 작업을 설정합니다.
`setDisabled(disabled)`	`Chip`	칩이 사용 중지되었는지 여부를 설정합니다.
`setIcon(icon)`	`Chip`	칩으로 사용할 아이콘을 설정합니다.
`setLabel(label)`	`Chip`	칩의 제목을 설정합니다.
`setOnClickAction(action)`	`Chip`	객체가 클릭될 때 실행되는 작업을 설정합니다.
`setOnClickOpenLinkAction(action)`	`Chip`	객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다.
`setOpenLink(openLink)`	`Chip`	객체를 클릭할 때 열릴 URL을 설정합니다.

자세한 문서

`setAltText(altText)`

접근성을 위해 칩의 대체 텍스트를 설정합니다. 설정하지 않으면 기본값은 칩에 표시되는 텍스트입니다.

매개변수

이름	유형	설명
`altText`	`String`	이 칩에 할당할 대체 텍스트입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setAuthorizationAction(action)`

객체가 클릭될 때 승인 흐름의 URL을 여는 승인 작업을 설정합니다. 그러면 URL이 새 창에서 열립니다. 사용자가 승인 흐름을 완료하고 애플리케이션으로 돌아오면 부가기능이 새로고침됩니다.

UI 객체는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

매개변수

이름	유형	설명
`action`	`AuthorizationAction`	이 요소가 클릭될 때 취할 승인 작업을 지정하는 객체입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setComposeAction(action, composedEmailType)`

객체를 클릭할 때 이메일 초안을 작성하는 작업을 설정합니다. UI 객체는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ComposeActionResponseBuilder.setGmailDraft(draft)를 사용하여 구성된 ComposeActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

참고: 이 메서드는 Compose UI를 확장하는 데 사용되는 Compose 작업을 설정하지 않습니다. 이 메서드는 이 UI 요소를 Apps Script에서 메일 초안을 작성하고 작업이 완료되면 Gmail에서 열리는 Action에 연결합니다.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

매개변수

이름	유형	설명
`action`	`Action`	이 요소가 클릭될 때 실행할 작성 작업을 지정하는 객체입니다.
`composedEmailType`	`ComposedEmailType`	작성된 초안이 독립형 초안인지 답장 초안인지 지정하는 enum 값입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setDisabled(disabled)`

칩이 사용 중지되었는지 여부를 설정합니다. 사용 중지된 칩은 비활성화되어 클릭할 수 없습니다.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

매개변수

이름	유형	설명
`disabled`	`Boolean`	사용 중지된 상태입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setIcon(icon)`

칩으로 사용할 아이콘을 설정합니다.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

매개변수

이름	유형	설명
`icon`	`IconImage`	사전 정의된 `IconImage` 값 중 하나입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setLabel(label)`

칩의 제목을 설정합니다. 필수 항목입니다.

const chip = CardService.newChip().setLabel('bug Report');

매개변수

이름	유형	설명
`label`	`String`	표시할 텍스트입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setOnClickAction(action)`

객체가 클릭될 때 실행되는 작업을 설정합니다. UI 객체는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

매개변수

이름	유형	설명
`action`	`Action`	이 요소를 클릭할 때 취할 작업입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setOnClickOpenLinkAction(action)`

객체를 클릭할 때 탭에서 URL을 여는 작업을 설정합니다. URL을 빌드해야 하거나 OpenLink 객체를 만드는 것 외에도 다른 작업을 실행해야 하는 경우 이 함수를 사용하세요. UI 객체는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

Action 매개변수는 ActionResponseBuilder.setOpenLink(openLink)를 사용하여 구성된 ActionResponse 객체를 반환하는 콜백 함수를 지정해야 합니다.

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

매개변수

이름	유형	설명
`action`	`Action`	이 요소가 클릭될 때 실행할 링크 열기 작업을 지정하는 객체입니다.

리턴

Chip: 연결을 위한 객체입니다.

`setOpenLink(openLink)`

객체를 클릭할 때 열릴 URL을 설정합니다. URL이 이미 알려져 있고 열기만 하면 되는 경우에 이 함수를 사용하세요. UI 객체는 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) 또는 setComposeAction(action, composedEmailType) 중 하나만 설정할 수 있습니다.

매개변수

이름	유형	설명
`openLink`	`OpenLink`	열려는 URL을 설명하는 `OpenLink` 객체입니다.

리턴

Chip: 연결을 위한 객체입니다.