Firebase 동적 링크 짧은 링크 API 참조

이 REST API를 사용하여 짧은 동적 링크를 생성할 수 있습니다. 시작하려면 개발자 가이드를 참조하세요.

HTTP 요청

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

request_body

요청 본문

요청 본문은 동적 링크 매개변수를 긴 동적 링크로 지정할지 아니면 JSON 객체로 지정할지에 따라 다음 중 하나와 같습니다.

동적 링크 매개변수를 긴 동적 링크로 지정하려면:

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

동적 링크 매개변수를 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 프로젝트의 동적 링크 도메인입니다. Firebase 콘솔 의 동적 링크 섹션에서 이 값을 찾을 수 있습니다.
링크 longDynamicLink 매개변수의 값을 설정하지 않은 경우 필수입니다.

앱이 열리는 링크입니다. 앱에서 처리할 수 있는 URL(일반적으로 앱의 콘텐츠 또는 페이로드)을 지정하여 앱별 로직(예: 사용자에게 쿠폰을 제공하거나 시작 화면 표시)을 시작합니다. 이 링크는 올바른 형식의 URL이어야 하고, URL이 올바르게 인코딩되어야 하며, HTTP 또는 HTTPS를 사용해야 하며, 다른 동적 링크일 수 없습니다.

접미사

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

고유해야 하는 길이(최소 4자)의 경로 문자열을 생성하려면 매개변수를 { "option": "SHORT" } 로 설정합니다. 짧은 동적 링크 URL을 추측해도 민감한 정보가 노출되지 않는 경우 이 방법을 사용하세요.

이 매개변수를 생략하거나 매개변수를 { "option": "UNGUESSABLE" } 로 설정하여 경로를 추측할 수 없는 문자열로 줄이세요. 이러한 문자열은 무작위로 생성된 96비트 숫자를 base62 인코딩하여 생성되며 17개의 영숫자 문자로 구성됩니다. 민감한 정보가 노출될 수 있는 동적 링크가 크롤링되는 것을 방지하려면 추측할 수 없는 문자열을 사용하세요.

안드로이드 매개변수
android패키지 이름 링크를 여는 데 사용할 Android 앱의 패키지 이름입니다. 앱은 Firebase 콘솔의 개요 페이지에서 프로젝트에 연결되어야 합니다. Android 앱을 열려면 동적 링크에 필요합니다.
android폴백링크 앱이 설치되지 않았을 때 열리는 링크입니다. 앱이 설치되지 않은 경우 Play 스토어에서 앱을 설치하는 것 외에 콘텐츠의 모바일 웹 버전을 열거나 앱 홍보 페이지를 표시하는 등 다른 작업을 수행하려면 이를 지정하세요.
androidMinPackageVersionCode 링크를 열 수 있는 앱의 최소 버전에 대한 versionCode . 설치된 앱이 이전 버전인 경우 사용자는 앱을 업그레이드하기 위해 Play 스토어로 이동됩니다.
iOS 매개변수
iOS번들 ID 링크를 여는 데 사용할 iOS 앱의 번들 ID입니다. 앱은 Firebase 콘솔의 개요 페이지에서 프로젝트에 연결되어야 합니다. iOS 앱을 열려면 동적 링크에 필요합니다.
iOS폴백링크 앱이 설치되지 않았을 때 열리는 링크입니다. 앱이 설치되지 않은 경우 App Store에서 앱을 설치하는 것 이외의 작업(예: 콘텐츠의 모바일 웹 버전 열기 또는 앱 홍보 페이지 표시)을 수행하려면 이를 지정합니다.
iOSCustomScheme 앱의 번들 ID가 아닌 것으로 정의된 경우 앱의 맞춤 URL 구성표
iOSIpad대체링크 앱이 설치되지 않은 경우 iPad에서 열리는 링크입니다. 앱이 설치되지 않은 경우 App Store에서 앱을 설치하는 것 이외의 작업(예: 콘텐츠의 웹 버전 열기 또는 앱 홍보 페이지 표시)을 수행하려면 이를 지정합니다.
iOSIpad번들 ID iPad에서 링크를 여는 데 사용할 iOS 앱의 번들 ID입니다. 앱은 Firebase 콘솔의 개요 페이지에서 프로젝트에 연결되어야 합니다.
iOSAppStoreId 앱이 설치되지 않은 경우 사용자를 App Store로 보내는 데 사용되는 앱의 App Store ID
탐색 매개변수
강제 리디렉션 활성화 '1'로 설정하면 동적 링크가 열릴 때 앱 미리보기 페이지를 건너뛰고 대신 앱이나 스토어로 리디렉션됩니다. 앱 미리보기 페이지(기본적으로 활성화됨)는 사용자가 앱에서 동적 링크를 열 때 가장 적합한 대상으로 보다 안정적으로 보낼 수 있습니다. 그러나 이 페이지 없이 동적 링크를 안정적으로 열 수 있는 앱에서만 동적 링크가 열릴 것으로 예상되는 경우 이 매개변수를 사용하여 비활성화할 수 있습니다. 이 매개변수는 iOS에서만 동적 링크의 동작에 영향을 미칩니다.
소셜 메타태그 매개변수
소셜타이틀 동적 링크를 소셜 게시물에 공유할 때 사용할 제목입니다.
소셜 설명 동적 링크를 소셜 게시물에 공유할 때 사용할 설명입니다.
소셜이미지링크 이 링크와 관련된 이미지의 URL입니다.
분석 매개변수
UTM소스
utmMedium
utm캠페인
UTMTerm
utm콘텐츠
Google Play 분석 매개변수.
~에
코네티컷

태평양 표준시
iTunes Connect 분석 매개변수.

응답 본문

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

{
  "shortLink": string,
  "previewLink": string
}
응답 필드
짧은링크 생성된 짧은 동적 링크입니다.
미리보기링크 동적 링크 동작의 흐름도에 대한 링크입니다.