본문으로 건너뛰기

In Game Web URI 규약

위험

해당 규약은 드림에이지 플랫폼 SDK 연동 없이 개발 스튜디오에서 자체적으로 In Game Web View 공지 연동 시 필요한 규격이 포함되어있습니다.

1. 도메인

  • QA 환경: 담당 기술PM이 URL 전달
  • Prod 환경: 담당 기술PM이 URL 전달

2. URI 규약

규약)
/{lang}/{pjId}/{boardId}?layout={layout}&theme={theme}&appScheme={appScheme}&banner={banner}&platform={platform}


예시)
https://{InGameWeb도메인}/ko/1010/notice?layout=vertical&theme=dark&appScheme=custom&banner=on&platform=ALL

Parameter상세 설명
lang
  • 서비스 연동 관련 논의 시 합의된 지원 언어 코드를 입력합니다.
  • ISO 639-1 기준 문자열로 입력하며 중국어 같은 예외 코드는 국가코드와 함께 입력합니다.
  • 미입력된 URL로 호출 시 en을 기본 노출합니다.

예시) ko, ja, en, zh-tw

pjid
  • 플랫폼 연동 시 전달한 pjid를 입력합니다. pjid는 서비스별 고유 id입니다.
  • 관련하여 확인이 필요하다면 담당자에게 연락 부탁 드립니다.
boardid
  • In Game Web View 공지/게시판의 고유 게시판ID를 의미합니다.
  • 공지는 기본적으로 notice를 사용합니다.
  • 2024년 9월 기준 notice, event만 지원합니다.
layout(Option)
  • 가로, 세로 레이아웃 형태를 정의합니다.
  • vertical(세로), horizontal_banner(가로-배너형) , horizontal_board(가로-게시판형)을 지원합니다.
theme(Option)
  • In Game Web View의 테마를 정의합니다.
  • dark(어두움), light(밝음) 형태를 지원하며 기본값은 light입니다.
appScheme(Option)
  • Deep Link 또는 외부 브라우저로 연결할 사용합니다.
  • [Deep Link 구현 규약]을 참고하시기 바랍니다.
banner(Option)
  • on, off로 설정하며 off로 설정 시 배너를 노출하지 않습니다.
  • on으로 설정하더라도 노출할 배너가 등록되지 않으면 배너가 노출되지 않습니다.
  • 기본값은 off입니다.
platform(Option)
  • 콘텐츠의 플랫폼(스토어) 노출 위치를 분기할 때 사용합니다.
    예) Google Play Store에서만 노출하는 Web View
  • 다음 값을 입력하여 콘텐츠 노출 위치를 구분할 수 있습니다.

    • ALL
    • GOOGLE_PLAY
    • GOOGLE_PLAY_PC
    • APPLE_APP_STORE
    • STEAM
    • IM_LAUNCHER
    • GALAXY_STORE
    • ONE_STORE
  • 기본값은 ALL이며 ALL일 때 플랫폼을 구분하지 않습니다.
  • 대소문자를 구분하지 않습니다.