본문으로 건너뛰기

env.getDeploymentId

현재 미니앱 배포의 고유 식별자를 반환합니다. 배포 식별자는 미니앱 빌드마다 발급되며, 로깅·디버깅·A/B 테스트 컨텍스트 추적에 활용할 수 있습니다. getAppsInTossGlobals().deploymentId와 동일한 값을 반환합니다.

시그니처​

getDeploymentId는 env 네임스페이스 객체의 멤버로 노출됩니다. 함수 자체를 단독으로 import하지 않습니다.

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

declare const env: {
  getDeploymentId(): string;
};

파라미터​

없음.

반환값​

  • string — 현재 배포의 고유 식별자 문자열.

권한​

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

예제​

최소 예제​

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

const deploymentId = env.getDeploymentId();
console.log('Deployment ID:', deploymentId);

실전 예제 — 에러 로그에 배포 ID 포함하기​

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

function App() {
  useEffect(() => {
    const deploymentId = env.getDeploymentId();

    window.addEventListener('unhandledrejection', (event) => {
      // 에러 리포트에 배포 ID를 포함해 어느 빌드에서 발생했는지 추적합니다.
      console.error('[error]', {
        deploymentId,
        reason: event.reason,
      });
    });
  }, []);

  return <main>{/* 앱 콘텐츠 */}</main>;
}

직접 실행해 보기​

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

sdk-example에서 실행해 보기

관련 API​

관련 가이드​

외부 참조​

  • @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.
  • 표준 Web API 대응: 없음 — 배포 ID는 미니앱 플랫폼 고유 개념으로 표준 Web API에 직접 대응하는 항목이 없습니다.