콘솔로 이동

Remote Config REST API 사용

English Context Link

이 문서에서는 Remote Config REST API를 사용하여 원격 구성 템플릿이라고 하는 JSON 형식의 매개변수 및 조건 집합을 읽고 수정하는 방법을 설명합니다. 프로그래매틱 방식으로 템플릿을 관리할 수 있으므로 백엔드에서 템플릿을 변경하고 클라이언트 앱에서 클라이언트 라이브러리를 사용하여 가져올 수 있습니다.

이를 통해 원격 구성 콘솔의 템플릿 관리를 건너뛰고 자체 프로세스에 원격 구성 변경사항을 바로 통합할 수 있습니다. 다음과 같은 작업이 가능합니다.

  • 원격 구성 업데이트 예약: 크론 작업과 함께 REST API를 사용하면 정기적으로 원격 구성 값을 변경할 수 있습니다.
  • 구성 값 일괄 가져오기: 자체 독점 시스템에서 Firebase 원격 구성으로 효율적으로 전환할 수 있습니다.
  • Firebase용 Cloud Functions으로 원격 구성 사용: 서버 측에 발생한 이벤트를 기준으로 앱의 값을 변경합니다. 예를 들어 원격 구성을 사용하여 앱의 새 기능을 홍보한 후 충분한 인원이 새 기능을 이용한 것이 감지되면 자동으로 프로모션을 사용 중지합니다.

이 가이드의 다음 섹션에서는 Remote Config REST API를 시작하는 데 필요한 단계에 대해 자세히 설명합니다. 만약 코드를 실행해서 확인만 해 보려면 다음의 Remote Config REST API 시연 샘플 앱 중 하나를 참조하세요.

Remote Config REST API 사용 시작하기

이 섹션에서는 API를 사용하여 원격 구성 템플릿을 가져오고 수정하는 방법을 설명합니다.

1단계: Firebase Console에서 값 설정하기

보통은 Firebase Console에서 값을 먼저 설정합니다. 이 가이드에서는 iOS 또는 Android용으로 원격 구성 빠른 시작 샘플 앱을 설정했다고 가정해 보겠습니다. 이 앱의 경우 Firebase Console에 다음 매개변수 2개만 추가하면 됩니다.

매개변수 키 기본값 참고사항
welcome_message 샘플 앱에 오신 것을 환영합니다. 환영 메시지를 변경합니다.
welcome_message_caps False 환영 메시지가 모두 대문자로 표시되도록 하려면 true로 설정합니다.

2단계: API 요청을 인증하고 승인하는 액세스 토큰 가져오기

Firebase 프로젝트는 앱 서버 또는 신뢰할 수 있는 환경에서 Firebase 서버 API를 호출하는 데 사용할 수 있는 Google 서비스 계정을 지원합니다. 로컬에서 코드를 개발하거나 온프레미스에 애플리케이션을 배포하는 경우 이 서비스 계정을 통해 가져온 사용자 인증 정보를 사용하여 서버 요청을 승인할 수 있습니다.

서비스 계정을 인증하고 Firebase 서비스에 액세스하도록 승인하려면 JSON 형식의 비공개 키 파일을 생성해야 합니다.

서비스 계정에 비공개 키 파일을 생성하려면 다음 안내를 따르세요.

  1. Firebase Console에서 설정 > 서비스 계정을 엽니다.

  2. 새 비공개 키 생성을 클릭하고 키 생성을 클릭하여 확인합니다.

  3. 키가 들어있는 JSON 파일을 안전하게 저장합니다.

서비스 계정을 통한 승인 시 애플리케이션에 사용자 인증 정보 제공에는 두 가지 방법이 있습니다. GOOGLE_APPLICATION_CREDENTIALS 환경 변수를 설정하거나 코드에서 서비스 계정 키에 경로를 명시적으로 전달하는 방법입니다. 그러나 보안성 측면에서 첫 번째 방법을 권장합니다.

환경 변수를 설정하는 방법은 다음과 같습니다.

GOOGLE_APPLICATION_CREDENTIALS 환경 변수를 서비스 계정 키가 포함된 JSON 파일의 파일 경로로 설정합니다. 이 변수는 현재 셸 세션에만 적용되므로 새 세션을 열면 변수를 다시 설정합니다.

Linux 또는 macOS

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

위 단계를 완료하고 나면 애플리케이션 기본 사용자 인증 정보(ADC)가 암묵적으로 사용자 인증 정보를 확인할 수 있으므로 Google 이외의 환경에서 테스트하거나 실행할 때 서비스 계정 사용자 인증 정보를 사용할 수 있습니다.

원하는 언어의 Google API 클라이언트 라이브러리와 함께 Firebase 사용자 인증 정보를 사용하여 수명이 짧은 OAuth 2.0 액세스 토큰을 검색합니다.

node.js

 function getAccessToken() {
  return new Promise(function(resolve, reject) {
    var key = require('./service-account.json');
    var jwtClient = new google.auth.JWT(
      key.client_email,
      null,
      key.private_key,
      SCOPES,
      null
    );
    jwtClient.authorize(function(err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token

자바

private static String getAccessToken() throws IOException {
  GoogleCredential googleCredential = GoogleCredential
      .fromStream(new FileInputStream("service-account.json"))
      .createScoped(Arrays.asList(SCOPES));
  googleCredential.refreshToken();
  return googleCredential.getAccessToken();
}

액세스 토큰이 만료되면 토큰 새로고침 메소드가 자동으로 호출되어 업데이트된 액세스 토큰이 발급됩니다.

원격 구성에 대한 액세스를 승인하려면 https://www.googleapis.com/auth/firebase.remoteconfig 범위를 요청합니다.

3단계: API를 사용해 원격 구성 서비스에서 JSON 가져오기

이제 API를 사용하여 원격 구성 템플릿의 현재 활성 버전을 JSON 형식으로 가져올 수 있습니다. <my-project-id> 대신 내 프로젝트 ID를 입력하여 다음 명령어를 사용하면 됩니다. 프로젝트 ID는 Firebase Console 설정 창에서 확인할 수 있습니다.

curl 명령어:

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -o filename

이 명령어는 JSON 페이로드를 파일 하나에 출력하고, 헤더(Etag 포함)를 별도의 파일에 출력합니다.

원시 HTTP 요청:

Host: firebaseremoteconfig.googleapis.com

GET /v1/projects/my-project-id/remoteConfig HTTP/1.1
Authorization: Bearer token
Accept-Encoding: gzip

이 API 호출은 이후의 요청에 사용되는 ETag를 포함한 별도의 헤더와 함께 다음 JSON을 반환합니다. 다음 예에서는 반환된 JSON을 보여줍니다.

{
  "parameters":[
    {
      "key":"welcome_message",
      "value_options":[
        {
          "value":"Welcome to this sample app"
        }
      ]
    },
    {
      "key":"welcome_message_caps",
      "value_options":[
        {
          "value":"false"
        }
      ]
    }
  ],
  "version":{
    "version_number": "42",
    "update_time":"2018-05-11T18:46:40Z",
    "update_user":{
      "name":"Jane Developer",
      "email":"jane@developer.org",
      "imageUrl":"http://image.google.com/path-to-profile-photo-for-jane"
    },
    "description":"Adding welcome messages",
    "update_origin":"CONSOLE",
    "update_type":"INCREMENTAL_UPDATE"
  }
}

4단계: JSON 데이터에 조건 추가하기

몇 가지 조건과 조건부 값을 추가하여 샘플 앱이 다음과 같이 업데이트되도록 합니다.

  • 10%의 사용자에게 'new'라는 단어가 추가된 약간의 다른 메시지가 표시됩니다.
  • 미국 또는 영국 사용자의 경우 메시지를 모두 대문자로 표시합니다.

이와 같이 JSON을 확장하려면 다음을 포함하는 파일을 만듭니다.

{
  "conditions": [{
    "name": "android_english",
    "expression": "device.os == 'android' && device.country in ['us', 'uk']",
    "tagColor": "BLUE"
  }, {
    "name": "tenPercent",
    "expression": "percent <= 10",
    "tagColor": "BROWN"
  }],
  "parameters": {
    "welcome_message": {
      "defaultValue": {
        "value": "Welcome to this sample app"
      },
      "conditionalValues": {
        "tenPercent": {
          "value": "Welcome to this new sample app"
        }
      },
      "description": "The sample app's welcome message"
    },
    "welcome_message_caps": {
      "defaultValue": {
        "value": "false"
      },
      "conditionalValues": {
        "android_english": {
          "value": "true"
        }
      },
      "description": "Whether the welcome message should be displayed in all capital letters."
    }
  }
}

위에 나온 JSON은 먼저 조건 집합을 정의한 후 각 매개변수의 기본값 및 조건 기반 매개변수(조건부 값) 값을 정의합니다. 또한 각 요소에 대한 설명을 선택사항으로 추가합니다. 이러한 설명은 코드 주석과 같이 개발자가 참조할 용도이며 앱에서 표시되지 않습니다. 버전 제어 용도로 별도의 헤더로 ETag도 제공됩니다.

Remote Config REST API는 앱의 동작과 모양을 변경하는 데 사용할 수 있는 여러 조건 및 비교 연산자를 제공합니다. 이러한 조건에 지원되는 조건과 연산자에 대한 자세한 내용은 조건식 참조를 확인하세요.

5단계: JSON 데이터를 게시해 원격 구성 서비스의 데이터 대체하기

원격 구성 템플릿을 업데이트할 JSON 파일을 만들었다면 이번에는 위에 나온 JSON을 다음 명령어에 추가하고 기본 구성을 대신 입력해 이를 게시하면 됩니다. 이 작업은 기존 구성 템플릿 전체를 업데이트된 파일로 대체합니다. 그러면 대체된 기존 템플릿보다 버전 번호가 1이 높은 버전 번호가 새 활성 템플릿에 지정됩니다.

curl 명령어의 경우 파일 이름 앞에 '@' 문자를 사용하여 콘텐츠를 지정할 수 있습니다.

필요한 경우 이전 버전으로 롤백할 수 있습니다. 업데이트 시 오류 발생 위험을 줄이기 위해 게시 전 유효성 검사를 시행할 수 있습니다.

curl 명령어:

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -d @filename

원시 HTTP 요청:

Host: firebaseremoteconfig.googleapis.com
PUT /v1/projects/my-project-id/remoteConfig HTTP/1.1
Content-Length: size
Content-Type: application/json; UTF8
Authorization: Bearer token
If-Match: expected ETag
Accept-Encoding: gzip
JSON_HERE

쓰기 요청이므로 이 명령어로 ETag가 수정되며 다음 번 PUT 명령어의 응답 헤더에서 업데이트된 ETag를 제공합니다.

게시 전 유효성 검사

필요에 따라 게시 요청에 URL 매개변수 ?validate_only=true를 추가하여 업데이트 게시 전에 유효성을 검사할 수 있습니다. 응답에 상태 코드 200과 접미사가 -0인 업데이트된 etag가 있으면 업데이트가 유효성 검사를 통해 확인되었음을 나타냅니다. 상태 코드가 200이 아닌 응답은 JSON 데이터에 게시하기 전에 수정해야 하는 오류가 있음을 나타냅니다.

오류 코드

상태 코드 의미
200 업데이트되었습니다.
400 유효성 검사 오류가 발생했습니다. 예를 들어 허용 개수 2,000개를 초과하는 키가 포함된 요청은 Param count too large 오류 메시지와 함께 400(잘못된 요청)을 반환합니다.
401 승인 오류가 발생했습니다. 액세스 토큰이 제공되지 않았거나 Firebase Remote Config REST API가 Cloud 개발자 콘솔의 프로젝트에 추가되지 않았습니다.
403 인증 오류가 발생했습니다(잘못된 액세스 토큰이 제공됨).
409 이 HTTPS 상태 코드는 두 가지 상황에서 발생할 수 있습니다.
  • 마지막으로 ETag 값을 가져온 후에 값 및 조건 집합이 업데이트되어 버전 불일치 오류가 발생했습니다. 이 문제를 해결하려면 GET 명령으로 새 템플릿과 ETag 값을 가져와 템플릿을 업데이트한 후 해당 템플릿과 새 ETag 값을 사용해 제출해야 합니다.
  • If-Match 헤더를 지정하지 않고 PUT 명령(원격 구성 템플릿 요청 업데이트)을 작성했습니다.
500 내부 오류가 발생했습니다. 이 오류가 발생하면 Firebase 지원 티켓을 제출하세요.

상태 코드 200은 원격 구성 템플릿(프로젝트의 매개변수, 값, 조건)이 업데이트되어 현재 이 프로젝트를 사용하는 앱에서 사용할 수 있다는 의미입니다. 다른 상태 코드는 이전에 존재하던 원격 구성 템플릿이 여전히 유효하다는 의미입니다.

템플릿 업데이트를 제출한 후 Firebase Console로 이동하여 변경사항이 예상대로 표시되는지 확인하세요. 조건의 순서가 판정(true로 판정된 첫 번째 조건이 적용됨)에 영향을 미치므로 이를 꼭 확인해야 합니다.

ETag 사용 및 강제 업데이트

Remote Config REST API에서는 경합 상태 및 리소스에 대한 중복 업데이트를 막기 위해 엔티티 태그(ETag)를 사용합니다. ETag에 관한 자세한 내용은 ETag - HTTP를 참조하세요.

가장 최근의 GET 명령어에서 제공하는 ETag를 캐시하고 PUT 명령어를 만들 때 If-Match 요청 헤더에서 이 ETag 값을 사용하는 것이 좋습니다. PUT 명령어로 HTTPS 상태 코드 409가 반환되면 GET 명령어를 새로 실행하여 다음 번 PUT 명령어에 사용할 새 ETag 및 템플릿을 확보해야 합니다.

다음과 같이 원격 구성 템플릿을 강제로 업데이트하면 ETag 및 관련 보호 조치를 우회할 수 있습니다. If-Match: * 하지만 이 방법은 여러 클라이언트에서 원격 구성 템플릿을 업데이트할 경우 업데이트가 손실 가능성이 있어 권장되지 않습니다. 이 같은 유형의 충돌은 여러 클라이언트가 API를 사용하거나 API 클라이언트 및 Firebase Console 사용자의 업데이트가 충돌할 경우 발생할 수 있습니다.

원격 구성 템플릿의 버전 관리에 대해 알아보려면 원격 구성 템플릿 및 버전 관리를 참조하세요.