getAppsInTossGlobals

미니앱 배포와 연결된 글로벌 메타데이터를 반환합니다. 배포 ID, 브랜드 표시명, 아이콘 URL, 브랜드 주색상을 담은 객체를 동기적으로 반환합니다.

시그니처

import { getAppsInTossGlobals } from '@apps-in-toss/web-framework';

interface AppsInTossGlobals {
  deploymentId: string;
  brandDisplayName: string;
  brandIcon: string;
  brandPrimaryColor: string;
}

declare function getAppsInTossGlobals(): AppsInTossGlobals;

파라미터

없음.

반환값

AppsInTossGlobals 객체를 반환합니다.

필드	타입	설명
deploymentId	string	현재 배포의 고유 식별자. env.getDeploymentId()와 동일한 값입니다.
brandDisplayName	string	브랜드 표시명 문자열입니다.
brandIcon	string	브랜드 아이콘 URL 또는 식별자입니다.
brandPrimaryColor	string	브랜드 주색상 값입니다 (예: #3182F6).

권한

권한이 필요하지 않습니다 — getAppsInTossGlobals는 별도의 PermissionName에 바인딩되지 않습니다. 권한이 필요한 다른 네임스페이스의 일반적인 처리 흐름은 Guides — 권한 처리 패턴을 참고하세요.

예제

최소 예제

import { getAppsInTossGlobals } from '@apps-in-toss/web-framework';

const globals = getAppsInTossGlobals();
console.log(globals.brandDisplayName);
console.log(globals.brandPrimaryColor);

실전 예제 — 브랜드 색상을 CSS 변수에 적용하기

import { getAppsInTossGlobals } from '@apps-in-toss/web-framework';
import { useEffect } from 'react';

function BrandThemeProvider({ children }: { children: React.ReactNode }) {
  useEffect(() => {
    const { brandPrimaryColor, brandDisplayName } = getAppsInTossGlobals();

    // 브랜드 색상을 CSS 커스텀 프로퍼티로 주입합니다.
    document.documentElement.style.setProperty('--brand-primary', brandPrimaryColor);
    document.title = brandDisplayName;
  }, []);

  return <>{children}</>;
}

직접 실행해 보기

sdk-example의 Environment 페이지에서 getAppsInTossGlobals 카드를 실행해 결과를 확인할 수 있습니다.

→sdk-example에서 실행해 보기

관련 API

• env.getDeploymentId — deploymentId만 필요하다면 env.getDeploymentId()가 더 간결합니다.
• getOperationalEnvironment — 현재 실행 환경(toss / sandbox)을 반환합니다.
• getPlatformOS — 현재 플랫폼 OS를 반환합니다.

관련 가이드

• Guides — 권한 처리 패턴 — 다른 네임스페이스의 권한 흐름 (참고용; getAppsInTossGlobals는 권한이 필요하지 않습니다).
• Recipes — 브랜드 테마 동적 적용 패턴

외부 참조

• @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.
• 표준 Web API 대응: 없음 — 브랜드/배포 메타데이터는 미니앱 플랫폼 고유 개념입니다.