Firebase Dynamic Links Short Links API 참조

이 REST API를 사용하여 짧은 Dynamic Links를 생성할 수 있습니다. 개발자 가이드를 참고하세요. 시작할 수 있습니다.

HTTP 요청

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

request_body

요청 본문

요청 본문은 원하는지 여부에 따라 다음 중 하나와 같이 표시됩니다. Dynamic Link 매개변수를 긴 Dynamic Link 또는 JSON 객체로 지정합니다.

Dynamic Link 매개변수를 긴 Dynamic Link로 지정하려면 다음 안내를 따르세요.

{
  "longDynamicLink": string,
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

Dynamic Link 매개변수를 JSON 객체로 지정하려면 다음 안내를 따르세요.

{
  "dynamicLinkInfo": {
    "domainUriPrefix": string,
    "link": string,
    "androidInfo": {
      "androidPackageName": string,
      "androidFallbackLink": string,
      "androidMinPackageVersionCode": string
    },
    "iosInfo": {
      "iosBundleId": string,
      "iosFallbackLink": string,
      "iosCustomScheme": string,
      "iosIpadFallbackLink": string,
      "iosIpadBundleId": string,
      "iosAppStoreId": string
    },
    "navigationInfo": {
      "enableForcedRedirect": boolean,
    },
    "analyticsInfo": {
      "googlePlayAnalytics": {
        "utmSource": string,
        "utmMedium": string,
        "utmCampaign": string,
        "utmTerm": string,
        "utmContent": string
      },
      "itunesConnectAnalytics": {
        "at": string,
        "ct": string,
        "mt": string,
        "pt": string
      }
    },
    "socialMetaTagInfo": {
      "socialTitle": string,
      "socialDescription": string,
      "socialImageLink": string
    }
  },
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

매개변수

달리 지정되지 않는 한 모든 매개변수는 선택사항입니다.

일반 매개변수
도메인 URI 프리픽스 longDynamicLink 값을 설정하지 않은 경우 필수 매개변수 값으로 사용됩니다. Firebase 프로젝트의 Dynamic Links 도메인 이 값은 Firebase 콘솔Dynamic Links 섹션에서 찾을 수 있습니다.
link longDynamicLink 값을 설정하지 않은 경우 필수 매개변수 값으로 사용됩니다.

앱에서 열리는 링크입니다. 앱이 처리할 수 있는 URL(일반적으로 앱의 콘텐츠 또는 페이로드)을 지정할 수 있으며, 이를 통해 사용자에게 쿠폰을 지급하거나 시작 화면을 표시하는 등 앱의 특정 로직을 시작할 수 있습니다. 이 링크는 올바른 형식의 URL이어야 하며 적절한 URL 인코딩을 적용해야 합니다. HTTP 또는 HTTPS를 사용해야 하며 다른 동적 링크가 아니어야 합니다.

접미사

짧은 Dynamic Link의 경로 구성요소를 만드는 방법을 지정합니다. 작성자: 기본적으로 Firebase Dynamic Links는 17자 문자열 접미사를 생성합니다.

매개변수를 { "option": "SHORT" }로 설정하여 생성합니다. 경로 문자열을 지정할 수 있습니다. 4자 이상이어야 합니다. 이 방법은 민감한 정보가 있을 때 단축 Dynamic Link URL이 추측되는 경우에도 노출되지 않습니다.

이 매개변수를 생략하거나 다음으로 설정 { "option": "UNGUESSABLE" }: 경로를 추측할 수 없는 문자열입니다. 이러한 문자열은 base62 인코딩을 통해 무작위로 생성됩니다. 96비트 숫자를 생성하며 17자리 영숫자 문자로 구성됩니다. 사용 추측할 수 없는 문자열로 Dynamic Links이(가) 크롤링되지 않도록 합니다. 민감한 정보가 노출될 수 있습니다

Android 매개변수
Android 패키지 이름 링크를 여는 데 사용할 Android 앱의 패키지 이름입니다. Firebase 콘솔의 개요 페이지에서 앱을 프로젝트에 연결해야 합니다. Dynamic Link에서 Android 앱을 여는 데 필요합니다.
Android 대체 링크 앱이 설치되지 않은 경우에 열리는 링크입니다. 앱이 설치되지 않았을 때 Play 스토어에서 앱을 설치하는 것 이외에 콘텐츠의 모바일 웹 버전 열기, 앱 홍보 페이지 표시 등의 다른 작업을 수행하려는 경우 이 매개변수를 지정합니다.
Android최소 패키지 버전 코드 링크를 열 수 있는 앱의 최소 버전 versionCode입니다. 설치된 앱이 이전 버전이라면 앱을 업그레이드하기 위해 Play 스토어로 이동합니다.
iOS 매개변수
iOS 번들 ID 링크를 여는 데 사용할 iOS 앱의 번들 ID입니다. Firebase 콘솔의 개요 페이지에서 앱을 프로젝트에 연결해야 합니다. Dynamic Link에서 iOS 앱을 여는 데 필요합니다.
iOS 대체 링크 앱이 설치되지 않은 경우에 열리는 링크입니다. 앱이 설치되지 않았을 때 App Store에서 앱을 설치하는 것 이외에 콘텐츠의 모바일 웹 버전 열기, 앱 홍보 페이지 표시 등의 다른 작업을 수행하려는 경우 이 매개변수를 지정합니다.
iOSCustomScheme 앱의 번들 ID와 다른 값으로 정의하면 앱의 맞춤 URL 스키마로 사용됩니다.
iOSIpadFallbackLink 앱이 설치되지 않은 경우 iPad에서 열리는 링크입니다. 앱이 설치되지 않았을 때 App Store에서 앱을 설치하는 것 이외에 콘텐츠의 웹 버전 열기, 앱 홍보 페이지 표시 등의 다른 작업을 수행하려는 경우 이 매개변수를 지정합니다.
iOSIpadBundleId iPad에서 링크를 여는 데 사용할 iOS 앱의 번들 ID입니다. Firebase 콘솔의 개요 페이지에서 앱을 프로젝트에 연결해야 합니다.
iOS AppStoreId 앱이 설치되지 않은 경우 사용자를 앱 스토어로 보내는 데 사용되는 앱의 앱 스토어 ID입니다.
탐색 매개변수
enableForcedRedirect '1'로 설정하면 Dynamic Link가 열릴 때 앱 미리보기 페이지를 건너뛰고 앱 또는 스토어로 리디렉션합니다. 앱 미리보기 페이지 (기본적으로 사용 설정됨)는 사용자가 앱에서 Dynamic Links를 열 때 보다 안정적으로 사용자를 가장 적절한 대상으로 안내합니다. 그러나 이 페이지 없이 Dynamic Links를 안정적으로 열 수 있는 앱에서만 Dynamic Link이 열릴 것으로 예상되는 경우 이 매개변수를 사용하여 사용 중지할 수 있습니다. 이 매개변수는 iOS에서만 Dynamic Link의 동작에 영향을 미칩니다.
소셜 메타 태그 매개변수
소셜 제목 Dynamic Link이(가) 소셜 게시물에서 공유될 때 사용할 제목입니다.
소셜 설명 Dynamic Link이 소셜 게시물에서 공유될 때 사용할 설명입니다.
소셜 이미지 링크 이 링크와 관련된 이미지의 URL입니다.
애널리틱스 매개변수
utmSource
utmMedium
utmCampaign
utmTerm
utmContent
Google Play 애널리틱스 매개변수입니다.
at
ct
mt
pt
iTunes Connect 애널리틱스 매개변수입니다.

응답 본문

요청에 대한 응답은 다음과 같은 형식의 JSON 객체입니다.

{
  "shortLink": string,
  "previewLink": string
}
응답 필드
짧은 링크 생성된 짧은 Dynamic Link입니다.
미리보기 링크 Dynamic Link 동작의 플로우 차트 링크