이 페이지에서는 Google Docs 사용자가 서드 파티 서비스의 링크를 미리 볼 수 있도록 Google Workspace 부가기능을 빌드하는 방법을 설명합니다.
Google Workspace 부가기능은 서비스 링크를 감지하고 Google Docs 사용자에게 이를 미리 보라는 메시지를 표시할 수 있습니다. 지원 케이스, 영업 리드, 직원 프로필과 같은 여러 URL 패턴을 미리 보도록 부가기능을 구성할 수 있습니다.
사용자가 링크를 미리 보는 방법
Google Docs 문서의 링크를 미리 보기 위해 사용자는 스마트 칩 및 카드와 상호작용합니다.
사용자가 문서에 URL을 입력하거나 붙여넣으면 Google Docs에서 링크를 스마트 칩으로 대체하라는 메시지를 표시합니다. 스마트 칩에는 링크 콘텐츠의 아이콘과 짧은 제목 또는 설명이 표시됩니다. 사용자가 칩 위로 마우스를 가져가면 파일 또는 링크에 관한 자세한 정보를 미리 볼 수 있는 카드 인터페이스가 표시됩니다.
다음 동영상은 사용자가 링크를 스마트 칩으로 변환하고 카드를 미리 보는 방법을 보여줍니다.
기본 요건
Apps Script
- Google Workspace 계정
- Google Workspace 부가기능 부가기능을 빌드하려면 이 빠른 시작을 따르세요.
Node.js
- Google Workspace 계정
- Google Workspace 부가기능 부가기능을 빌드하려면 이 빠른 시작을 따르세요.
Python
- Google Workspace 계정
- Google Workspace 부가기능 부가기능을 빌드하려면 이 빠른 시작을 따르세요.
자바
- Google Workspace 계정
- Google Workspace 부가기능 부가기능을 빌드하려면 이 빠른 시작을 따르세요.
선택사항: 서드 파티 서비스에 대한 인증 설정
부가기능이 승인이 필요한 서비스에 연결되는 경우 사용자가 서비스에 액세스하려면 링크를 미리 확인해야 합니다. 즉, 사용자가 서비스에서 Google Docs 문서에 처음으로 링크를 붙여넣으면 부가기능에서 승인 흐름을 호출해야 합니다.
OAuth 서비스 또는 커스텀 승인 메시지를 설정하려면 다음 가이드 중 하나를 참조하세요.
Apps Script를 사용하여 부가기능을 빌드한 경우 Google Workspace 부가기능에서 Google 이외의 서비스에 연결을 참조하세요.
부가기능을 다른 런타임을 사용하여 빌드한 경우 서드 파티 서비스에 부가기능 연결을 참고하세요.
부가기능의 링크 미리보기 설정하기
이 섹션에서는 다음 단계에 따라 부가기능의 링크 미리보기를 설정하는 방법을 설명합니다.
- 부가기능의 배포 리소스 또는 매니페스트 파일에서 링크 미리보기를 구성합니다.
- 링크의 스마트 칩 및 카드 인터페이스를 빌드합니다.
링크 미리보기 구성
링크 미리보기를 구성하려면 부가기능의 배포 리소스 또는 매니페스트 파일에 다음 섹션과 필드를 지정합니다.
addOns
섹션에서docs
필드를 추가하여 Google Docs를 확장합니다.docs
필드에runFunction
가 포함된linkPreviewTriggers
트리거를 구현합니다 (이 함수는 다음 섹션인 스마트 칩 및 카드 빌드에서 정의함).linkPreviewTriggers
트리거에서 지정할 수 있는 필드에 관한 자세한 내용은 Apps Script 매니페스트 파일 또는 다른 런타임용 배포 리소스 참조 문서를 확인하세요.사용자가 대신 링크를 미리 볼 수 있도록 부가기능을 승인할 수 있도록
oauthScopes
필드에https://www.googleapis.com/auth/workspace.linkpreview
를 추가합니다.
예를 들어 지원 케이스 서비스의 링크 미리보기를 구성하는 배포 리소스의 oauthScopes
및 addons
섹션을 참고하세요.
{
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://www.example.com/images/company-logo.png",
"layoutProperties": {
"primaryColor": "#dd4b39"
}
},
"docs": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"logoUrl": "https://www.example.com/images/support-icon.png",
"localizedLabelText": {
"es": "Caso de soporte"
}
}
]
}
}
}
이 예에서 Google Workspace 부가기능 미리보기는 회사의 지원 케이스 서비스에 대한 링크입니다. 부가기능은 링크 미리보기를 위한 세 가지 URL 패턴을 지정합니다. 링크가 Google Docs 문서의 URL 패턴 중 하나와 일치할 때마다 콜백 함수인 caseLinkPreview
가 스마트 칩과 카드를 빌드하여 표시합니다.
스마트 칩 및 카드 빌드
링크의 스마트 칩과 카드를 반환하려면 linkPreviewTriggers
객체에 지정한 모든 함수를 구현해야 합니다.
사용자가 지정된 URL 패턴과 일치하는 링크와 상호작용하면 linkPreviewTriggers
트리거가 실행되고 콜백 함수가 이벤트 객체 docs.matchedUrl.url
를 인수로 전달합니다. 이 이벤트 객체의 페이로드를 사용하여 링크 미리보기를 위한 스마트 칩과 카드를 빌드합니다.
예를 들어 URL 패턴 example.com/cases
를 지정하는 부가기능의 경우 사용자가 링크 https://www.example.com/cases/123456
를 미리 보면 다음 이벤트 페이로드가 반환됩니다.
JSON
{ "docs": { "matchedUrl": { "url": "https://www.example.com/support/cases/123456" } } }
카드 인터페이스를 만들려면 위젯을 사용하여 링크에 관한 정보를 표시합니다. 사용자가 링크를 열거나 콘텐츠를 수정할 수 있는 작업을 빌드할 수도 있습니다. 사용 가능한 위젯 및 작업 목록은 미리보기 카드에 지원되는 구성요소를 참고하세요.
링크 미리보기를 위한 스마트 칩 및 카드를 빌드하는 방법은 다음과 같습니다.
- 부가기능 배포 리소스 또는 매니페스트 파일의
linkPreviewTriggers
섹션에 지정한 함수를 구현합니다.- 함수는
docs.matchedUrl.url
를 인수로 포함하는 이벤트 객체를 인수로 허용하고 단일Card
객체를 반환해야 합니다. - 서비스에 승인이 필요한 경우 함수는 승인 흐름도 호출해야 합니다.
- 함수는
- 각 미리보기 카드에 인터페이스의 위젯 상호작용을 제공하는 데 사용되는 콜백 함수를 구현합니다. 예를 들어 인터페이스에 버튼을 포함하는 경우 연결된
Action
와 버튼을 클릭할 때 실행되는 구현 콜백 함수가 있어야 합니다.
다음 코드는 콜백 함수 caseLinkPreview
를 만듭니다.
Apps Script
Node.js
Python
자바
미리보기 카드에 지원되는 구성요소
Google Workspace 부가기능은 링크 미리보기 카드에 다음과 같은 위젯과 작업을 지원합니다.
Apps Script
Card Service 필드 | 유형 |
---|---|
TextParagraph |
위젯 |
DecoratedText |
위젯 |
Image |
위젯 |
IconImage |
위젯 |
ButtonSet |
위젯 |
TextButton |
위젯 |
ImageButton |
위젯 |
Grid |
위젯 |
Divider |
위젯 |
OpenLink |
작업 |
Navigation |
작업 updateCard 메서드만 지원됩니다. |
JSON
카드 (google.apps.card.v1 ) 입력란 |
유형 |
---|---|
TextParagraph |
위젯 |
DecoratedText |
위젯 |
Image |
위젯 |
Icon |
위젯 |
ButtonList |
위젯 |
Button |
위젯 |
Grid |
위젯 |
Divider |
위젯 |
OpenLink |
작업 |
Navigation |
작업 updateCard 메서드만 지원됩니다. |
전체 예: 지원 케이스 부가기능
다음 예는 회사의 지원 케이스와 직원 프로필로 연결되는 링크를 미리 보는 Google Workspace 부가기능을 보여줍니다.
이 예시는 다음을 수행합니다.
- 미리보기는
https://www.example.com/support/cases/1234
와 같은 지원 케이스에 연결됩니다. 스마트 칩에 지원 아이콘이 표시되고 미리보기 카드에 케이스 ID와 설명이 포함됩니다. https://www.example.com/people/rosario-cruz
와 같은 지원 케이스 에이전트의 링크를 미리 봅니다. 스마트 칩에는 사람 아이콘이 표시되고 미리보기 카드에는 직원 이름, 이메일, 직책, 프로필 사진이 포함되어 있습니다.- 사용자의 언어가 스페인어로 설정된 경우 스마트 칩은
labelText
를 스페인어로 현지화합니다.
배포 리소스
Apps Script
{
"timeZone": "America/New_York",
"exceptionLogging": "STACKDRIVER",
"runtimeVersion": "V8",
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://developers.google.com/workspace/add-ons/images/link-icon.png",
"layoutProperties": {
"primaryColor": "#dd4b39"
}
},
"docs": {
"linkPreviewTriggers": [
{
"runFunction": "caseLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"localizedLabelText": {
"es": "Caso de soporte"
},
"logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png"
},
{
"runFunction": "peopleLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "people"
}
],
"labelText": "People",
"localizedLabelText": {
"es": "Personas"
},
"logoUrl": "https://developers.google.com/workspace/add-ons/images/person-icon.png"
}
]
}
}
}
JSON
{
"oauthScopes": [
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"addOns": {
"common": {
"name": "Preview support cases",
"logoUrl": "https://developers.google.com/workspace/add-ons/images/link-icon.png",
"layoutProperties": {
"primaryColor": "#dd4b39"
}
},
"docs": {
"linkPreviewTriggers": [
{
"runFunction": "URL",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "support/cases"
},
{
"hostPattern": "*.example.com",
"pathPrefix": "cases"
},
{
"hostPattern": "cases.example.com"
}
],
"labelText": "Support case",
"localizedLabelText": {
"es": "Caso de soporte"
},
"logoUrl": "https://developers.google.com/workspace/add-ons/images/support-icon.png"
},
{
"runFunction": "URL",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "people"
}
],
"labelText": "People",
"localizedLabelText": {
"es": "Personas"
},
"logoUrl": "https://developers.google.com/workspace/add-ons/images/person-icon.png"
}
]
}
}
}