서버 참조

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

앱 인스턴스 정보 가져오기

앱 인스턴스에 대한 정보를 가져오려면 이 엔드포인트에서 인스턴스 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"}
    }
  }
}

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

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

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

등록 토큰과 지원되는 관계가 있으면 매핑을 만들 수 있습니다. 예를 들어 이 엔드포인트에서 인스턴스 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개의 앱 인스턴스를 업데이트하려면 이 엔드포인트에서 인스턴스 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: