홈페이지

홈페이지는 하나 이상의 맥락이 아닌 카드를 정의할 수 있는 새로운 Google Workspace 부가기능 기능입니다. 비문맥 카드는 사용자가 Gmail 받은편지함을 보고 있지만 메일이나 임시보관 메일을 열지 않은 경우와 같이 사용자가 특정 컨텍스트 밖에 있을 때 사용자 인터페이스를 표시하는 데 사용됩니다.

홈페이지를 사용하면 빠른 액세스 측면 패널 의 Google 앱(Keep, Calendar, Tasks)처럼 문맥에 맞지 않는 콘텐츠를 표시할 수 있습니다. 또한 홈페이지는 사용자가 부가기능을 처음 열 때 시작 지점이 될 수 있으며 신규 사용자에게 부가기능과 상호작용하는 방법을 안내하는 데 유용합니다.

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

부가기능이 확장하는 각 호스트 애플리케이션마다 하나씩 여러 개의 홈페이지를 만들 수 있습니다. 커스텀 홈페이지를 지정하지 않은 호스트에서 사용되는 공통 기본 홈페이지를 정의할 수도 있습니다.

다음 조건 중 하나가 충족되면 부가기능 홈페이지가 표시됩니다.

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

홈페이지 디자인은 필수는 아니지만 적극 권장됩니다. 홈페이지를 정의하지 않으면 사용자가 홈페이지로 이동할 때마다 부가기능 이름이 포함된 일반 카드가 사용됩니다.

홈페이지 구성

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

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

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

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

공통 구성 외에도 각 호스트 애플리케이션의 구성(addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger 등)에서 사용할 수 있는 동일하게 구조화된 호스트별 재정의도 있습니다.

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

이는 다음 매니페스트 발췌문과 같습니다.

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

homepageTrigger 섹션은 필요하지 않습니다. 그러나 특정 호스트 제품의 부가기능에 표시되는 UI는 상응하는 매니페스트 필드의 존재 여부와 연결된 homepageTrigger의 존재 여부에 따라 달라집니다. 다음 예에서는 다양한 매니페스트 구성을 위한 홈페이지 UI를 만들기 위해 실행되는 부가기능 트리거 함수 (있는 경우)를 보여줍니다.

홈페이지 흐름

홈페이지 이벤트 객체

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

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

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

기타 문맥이 아닌 카드

부가기능 UI에는 홈페이지가 아닌 컨텍스트 외의 추가 카드가 포함될 수 있습니다. 예를 들어 홈페이지에는 사용자가 부가기능 설정을 조정할 수 있는 '설정' 카드를 여는 버튼이 있을 수 있습니다. 이러한 설정은 대부분의 경우 컨텍스트와 관련이 없으므로 컨텍스트와 무관합니다.

비문맥 카드는 다른 카드처럼 빌드되며, 유일한 차이점은 작업 또는 이벤트가 카드를 생성하고 표시하는 것입니다. 카드 간 전환을 만드는 방법에 관한 자세한 내용은 탐색 메서드를 참고하세요.