서버 참조

서버 구현은 선택사항입니다. 다음 작업을 실행하려면 인스턴스 ID 서비스를 사용하세요.

앱 인스턴스 정보 가져오기

앱 인스턴스에 관한 정보를 가져오려면 이 엔드포인트에서 Instance ID 서비스를 호출하여 다음과 같이 앱 인스턴스의 토큰을 제공합니다.

 https://iid.googleapis.com/iid/info/IID_TOKEN

매개변수

  • Authorization: Bearer <access_token>. 헤더에서 이 매개변수를 설정합니다. 단기 OAuth2 토큰을 Authorization 헤더의 값으로 추가합니다. 이 토큰을 가져오는 방법에 관한 자세한 내용은 수동으로 사용자 인증 정보 제공을 참고하세요.
  • access_token_auth: true. 헤더에서 이 매개변수를 설정합니다.
  • [선택사항] 불리언 details: 이 쿼리 매개변수를 true로 설정하여 이 토큰과 연결된 FCM 주제 구독 정보 (있는 경우)를 가져옵니다. 지정하지 않으면 기본값은 false입니다.

결과

성공하면 호출은 HTTP 상태 200과 다음을 포함하는 JSON 객체를 반환합니다.

  • application - 토큰과 연결된 패키지 이름입니다.
  • authorizedEntity - 토큰으로 전송하도록 승인된 projectId입니다.
  • applicationVersion - 애플리케이션 버전입니다.
  • platform - 토큰이 속한 기기 플랫폼을 나타내기 위해 ANDROID, IOS 또는 CHROME를 반환합니다.

details 플래그가 설정된 경우:

  • rel - 토큰과 연결된 관계입니다. 예를 들어 주제 구독 목록이 있습니다.

GET 요청 예시

https://iid.googleapis.com/iid/info/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true

결과 예

HTTP 200 OK
{
  "application":"com.iid.example",
  "authorizedEntity":"123456782354",
  "platform":"Android",
  "rel":{
    "topics":{
      "topicname1":{"addDate":"2015-07-30"},
      "topicname2":{"addDate":"2015-07-30"},
      "topicname3":{"addDate":"2015-07-30"},
      "topicname4":{"addDate":"2015-07-30"}
    }
  }
}

앱 인스턴스의 관계 매핑 만들기

Instance ID API를 사용하면 앱 인스턴스의 관계 매핑을 만들 수 있습니다. 예를 들어 등록 토큰을 FCM 주제에 매핑하여 앱 인스턴스를 주제에 구독할 수 있습니다. 이 API는 이러한 관계를 개별적으로 또는 일괄적으로 만드는 메서드를 제공합니다.

앱 인스턴스의 관계 매핑 만들기

등록 토큰과 지원되는 관계가 있으면 매핑을 만들 수 있습니다. 예를 들어 이 엔드포인트에서 Instance ID 서비스를 호출하여 앱 인스턴스의 토큰을 제공하면 다음과 같이 앱 인스턴스를 FCM 주제에 구독할 수 있습니다.

 https://iid.googleapis.com/iid/v1/IID_TOKEN/rel/topics/TOPIC_NAME

매개변수

  • Authorization: Bearer <access_token>. 헤더에서 이 매개변수를 설정합니다. 단기 OAuth2 토큰을 Authorization 헤더의 값으로 추가합니다. 이 토큰을 가져오는 방법에 관한 자세한 내용은 수동으로 사용자 인증 정보 제공을 참고하세요.
  • access_token_auth: true. 헤더에서 이 매개변수를 설정합니다.

결과

성공하면 호출은 HTTP 상태 200을 반환합니다.

POST 요청 예시

https://iid.googleapis.com/iid/v1/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA/rel/topics/movies
Content-Type:application/json
Content-Length: 0
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true

결과 예

HTTP 200 OK
{}

여러 앱 인스턴스의 관계 매핑 관리

인스턴스 ID 서비스의 일괄 메서드를 사용하여 앱 인스턴스의 일괄 관리를 실행할 수 있습니다. 예를 들어 FCM 주제에 앱 인스턴스를 일괄 추가하거나 삭제할 수 있습니다. API 호출당 최대 1,000개의 앱 인스턴스를 업데이트하려면 이 엔드포인트에서 Instance ID 서비스를 호출하고 JSON 본문에 앱 인스턴스 토큰을 제공합니다.

 https://iid.googleapis.com/iid/v1:batchAdd

 https://iid.googleapis.com/iid/v1:batchRemove

매개변수

  • Authorization: Bearer <access_token>. 헤더에서 이 매개변수를 설정합니다. 단기 OAuth2 토큰을 Authorization 헤더의 값으로 추가합니다. 이 토큰을 가져오는 방법에 관한 자세한 내용은 수동으로 사용자 인증 정보 제공을 참고하세요.
  • access_token_auth: true. 헤더에서 이 매개변수를 설정합니다.
  • to : 주제 이름입니다.
  • registration_tokens : 추가하거나 삭제하려는 앱 인스턴스의 IID 토큰 배열입니다.

결과

성공하면 호출은 HTTP 상태 200을 반환합니다. 결과가 비어 있으면 토큰이 성공적으로 구독되었음을 나타냅니다. 구독에 실패한 경우 결과에 다음 오류 코드 중 하나가 포함됩니다.

  • NOT_FOUND: 등록 토큰이 삭제되었거나 앱이 제거되었습니다.
  • INVALID_ARGUMENT: 제공된 등록 토큰이 발신 ID에 유효하지 않습니다.
  • INTERNAL: 알 수 없는 이유로 백엔드 서버에 오류가 발생했습니다. 요청을 다시 시도하세요.
  • TOO_MANY_TOPICS: 앱 인스턴스당 주제 수가 너무 많습니다.
  • RESOURCE_EXHAUSTED: 짧은 시간에 너무 많은 정기 결제 또는 정기 결제 취소 요청이 발생했습니다. 지수 백오프로 다시 시도합니다.

POST 요청 예시

https://iid.googleapis.com/iid/v1:batchAdd
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true
{
   "to": "/topics/movies",
   "registration_tokens": ["nKctODamlM4:CKrh_PC8kIb7O...", "1uoasi24:9jsjwuw...", "798aywu:cba420..."],
}

결과 예

HTTP 200 OK
{
  "results":[
    {},
    {"error":"NOT_FOUND"},
    {},
  ]
}

APNs 토큰의 등록 토큰 만들기

인스턴스 ID 서비스의 batchImport 메서드를 사용하면 기존 iOS APN 토큰을 Firebase 클라우드 메시징으로 일괄 가져와 유효한 등록 토큰에 매핑할 수 있습니다. 이 엔드포인트에서 Instance ID 서비스를 호출하면서 JSON 본문에 APNs 토큰 목록을 제공합니다.

 https://iid.googleapis.com/iid/v1:batchImport

응답 본문에는 상응하는 APN 기기 토큰에 FCM 메시지를 전송하는 데 사용할 준비가 된 인스턴스 ID 등록 토큰 배열이 포함됩니다.

매개변수

  • Authorization: Bearer <access_token>. 헤더에서 이 매개변수를 설정합니다. 단기 OAuth2 토큰을 Authorization 헤더의 값으로 추가합니다. 이 토큰을 가져오는 방법에 관한 자세한 내용은 수동으로 사용자 인증 정보 제공을 참고하세요.
  • access_token_auth: true. 헤더에서 이 매개변수를 설정합니다.
  • application : 앱의 번들 ID입니다.
  • sandbox : 샌드박스 환경 (TRUE) 또는 프로덕션 (FALSE)을 나타내는 불리언입니다.
  • apns_tokens : 추가하거나 삭제하려는 앱 인스턴스의 APNs 토큰 배열입니다. 요청당 최대 100개의 토큰

결과

성공하면 호출은 HTTP 상태 200과 JSON 결과 본문을 반환합니다. 요청에 제공된 각 APNs 토큰의 경우 결과 목록에는 다음이 포함됩니다.

  • APN 토큰입니다.
  • 확인하세요. 'OK' 또는 실패를 설명하는 오류 메시지
  • 성공한 결과의 경우 FCM에서 APNs 토큰에 매핑하는 등록 토큰입니다.

POST 요청 예시

https://iid.googleapis.com/iid/v1:batchImport
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth:true
{
  "application": "com.google.FCMTestApp",
  "sandbox":false,
  "apns_tokens":[
      "368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
      "76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86"
   ]
}

결과 예

HTTP 200 OK
{
 "results":[
       {
        "apns_token": "368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
         "status": "OK",
         "registration_token":"nKctODamlM4:CKrh_PC8kIb7O...clJONHoA"
       },
       {
         "apns_token": "76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86",
         "status":"Internal Server Error"
        },
     ]
  }

오류 응답

Instance ID 서버 API를 호출하면 다음 HTTP 오류 코드가 반환됩니다.

  • HTTP status 400 (Bad request) - 요청 매개변수가 누락되었거나 잘못되었습니다. 자세한 내용은 오류 메시지를 확인하세요.
  • HTTP status 401 (Unauthorized) - 인증 헤더가 잘못되었습니다.
  • HTTP status 403 (Forbidden) - 승인 헤더가 authorizedEntity와 일치하지 않습니다.
  • HTTP status 404 (Not found) - 잘못된 HTTP 경로 또는 IID 토큰을 찾을 수 없습니다. 자세한 내용은 오류 메시지를 확인하세요.
  • HTTP status 503 (Service unavailable) - 서비스를 사용할 수 없습니다. 지수 백오프로 요청을 다시 시도합니다.