홈페이지

홈페이지 는 하나 이상의 비컨텍스트 카드 를 정의할 수 있는 Google Workspace 부가기능 기능입니다. 비컨텍스트 카드는 사용자가 열려 있는 메일이나 초안 없이 Gmail 받은편지함을 보는 등 특정 컨텍스트 외부에 있을 때 사용자 인터페이스를 표시합니다.

홈페이지를 사용하면 빠른 액세스 측면 패널 (Google Keep, Google Calendar, Google Tasks)의 Google 앱과 유사한 비컨텍스트 콘텐츠를 표시할 수 있습니다. 홈페이지는 사용자가 부가기능을 처음 열 때 초기 시작 위치를 제공할 수도 있으며, 신규 사용자에게 부가기능과 상호작용하는 방법을 가르치는 데 유용합니다.

프로젝트 매니페스트에서 홈페이지를 지정하고 하나 이상의 homepageTrigger 함수를 구현하여 부가기능의 홈페이지를 정의합니다 (홈페이지 구성 참고).

부가기능이 확장하는 각 호스트 애플리케이션에 대해 홈페이지를 여러 개 사용할 수 있습니다. 맞춤 홈페이지를 지정하지 않은 호스트에서 사용되는 단일 공통 기본 홈페이지를 정의할 수도 있습니다.

부가기능 홈페이지는 다음과 같은 경우에 표시됩니다.

• 부가기능이 호스트에서 처음 열릴 때(승인 후)
• 부가기능이 열려 있는 동안 사용자가 컨텍스트 컨텍스트에서 비컨텍스트 컨텍스트로 전환할 때 예를 들어 Calendar 일정 수정에서 기본 Calendar로 전환하는 경우입니다.
• 사용자가 내부 스택에서 다른 모든 카드를 팝업할 수 있을 만큼 뒤로 버튼을 여러 번 클릭할 때
• 비컨텍스트 카드의 UI 상호작용으로 인해 Navigation.popToRoot 호출이 발생할 때

홈페이지를 디자인하는 것이 좋습니다. 홈페이지를 정의하지 않으면 사용자가 홈페이지로 이동할 때마다 부가기능 이름이 포함된 일반 카드가 사용됩니다.

홈페이지 구성

Google Workspace 부가기능은 addOns.common.homepageTrigger 필드를 사용하여 부가기능 매니페스트의 호스트 애플리케이션에 대한 기본 홈페이지 (비컨텍스트) 부가기능 콘텐츠를 구성합니다.

{
  "addOns": {
    "common": {
      "homepageTrigger": {
        "runFunction": "myFunction",
        "enabled": true
      }
    }
  }
}

• runFunction: Google Workspace 부가기능 프레임워크가 홈페이지 부가기능 카드를 렌더링하기 위해 호출하는 Google Apps Script 함수의 이름입니다. 이 함수는 홈페이지 트리거 함수 입니다. 이 함수는 홈페이지 UI를 구성하는 Card객체의 배열을 빌드하고 반환해야 합니다. 카드가 두 개 이상 반환되면 호스트 애플리케이션은 사용자가 선택할 수 있는 목록에 카드 헤더를 표시합니다 (여러 카드 반환 참고).

• enabled: 이 범위에 홈페이지 카드를 사용 설정해야 하는지 여부입니다. 이 필드는 선택사항이며 기본값은 true입니다. 이 값을 false로 설정하면 모든 호스트에 대해 홈페이지 카드가 사용 중지됩니다 (해당 호스트에 대해 재정의되지 않는 한, 호스트별 구성 참고).

호스트에서 공통 홈페이지를 사용하려면 부가기능 매니페스트에 addOns.common.homepageTrigger와 호스트의 최상위 리소스가 모두 있어야 합니다. 예를 들어 addOns.gmail이 매니페스트에 없으면 부가기능이 Gmail에서 사용 중지되고 해당 호스트에 홈페이지 또는 기타 기능이 표시되지 않습니다.

공통 구성 외에도 각 호스트 애플리케이션의 구성에서 addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger 및 기타 호스트별 트리거에 동일한 구조의 호스트별 재정의를 사용할 수 있습니다.

다음 예에서는 공통 홈페이지 트리거가 정의되어 있지만 Calendar 및 Drive의 맞춤 함수로 재정의되고 Gmail에서는 사용 중지된 매니페스트를 보여줍니다. 이 구성에서는 공통 buildHomePage 함수가 재정의되거나 호스트가 사용 중지되어 실행되지 않습니다.

{
  ...
  "addOns": {
    ...
    "common": {
      "homepageTrigger": { "runFunction": "buildHomePage" }
    },
    "calendar": {
      "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "buildDriveHomepage" }
    },
    "gmail": {
      "homepageTrigger": { "enabled": false }
    },
    ...
  }
}

다음 매니페스트 발췌문은 기본 homepageTrigger 및 Gmail 구성이 생략되어 있지만 이전 예와 동일합니다.

{
  "addOns": {
    "common": {},
    "calendar": {
      "homepageTrigger": { "runFunction": "myCalendarFunction" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "myDriveFunction" }
    },
    "gmail": {},
    ...
  }
}

homepageTrigger 섹션은 필수가 아닙니다. 호스트 제품의 부가기능에 표시되는 UI는 해당 매니페스트 필드의 존재 여부와 연결된 homepageTrigger가 있는지에 따라 다릅니다. 다음 예에서는 다양한 매니페스트 구성의 홈페이지 UI를 만들기 위해 실행되는 부가기능 트리거 함수를 보여줍니다.

홈페이지 이벤트 객체

이전에 설명한 홈페이지 트리거 함수 (runFunction)가 호출되면 호출 컨텍스트의 데이터가 포함된 이벤트 객체 가 전달됩니다.

홈페이지 이벤트 객체에는 위젯 또는 컨텍스트 정보가 포함되지 않습니다. 전달되는 정보는 다음과 같은 공통 이벤트 객체 필드로 제한됩니다.

• commonEventObject.clientPlatform
• commonEventObject.hostApp
• commonEventObject.userLocale 및 commonEventObject.userTimezone (제한 정보에 대한 사용자 언어 및 시간대 액세스 참고)

자세한 내용은 이벤트 객체를 참고하세요.

기타 비컨텍스트 카드

부가기능 UI에는 홈페이지가 아닌 추가 비컨텍스트 카드가 포함될 수 있습니다. 예를 들어 홈페이지에 부가기능 설정을 조정하는 '설정' 카드를 여는 버튼이 있을 수 있습니다 (이러한 설정은 일반적으로 컨텍스트와 무관함).

비컨텍스트 카드는 다른 카드와 마찬가지로 빌드됩니다. 유일한 차이점은 카드를 생성하고 표시하는 작업 또는 이벤트입니다. 카드 간 전환을 만드는 방법에 관한 자세한 내용은 탐색 메서드 를 참고하세요.