Справочник по серверу

Реализация сервера необязательна. Используйте службу Instance ID, если вы хотите выполнить следующие операции:

Получить информацию об экземплярах приложения

Чтобы получить информацию об экземпляре приложения, вызовите службу идентификатора экземпляра в этой конечной точке, указав токен экземпляра приложения, как показано:

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

Параметры

  • Authorization: Bearer <access_token> . Установите этот параметр в заголовке. Добавьте кратковременный токен OAuth2 в качестве значения заголовка Authorization . Для получения дополнительной информации о получении этого токена см. Provide credentials manual .
  • access_token_auth: true . Установите этот параметр в заголовке.
  • [необязательно] boolean 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"}
    }
  }
}

Создание карт взаимосвязей для экземпляров приложений

API Instance ID позволяет создавать карты отношений для экземпляров приложений. Например, можно сопоставить токен регистрации с темой FCM, подписав экземпляр приложения на тему. API предоставляет методы для создания таких отношений как по отдельности, так и в больших объемах.

Создайте сопоставление отношений для экземпляра приложения

При наличии регистрационного токена и поддерживаемой связи можно создать сопоставление. Например, можно подписать экземпляр приложения на тему FCM, вызвав службу Instance ID в этой конечной точке, предоставив токен экземпляра приложения, как показано:

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

Параметры

  • Authorization: Bearer <access_token> . Установите этот параметр в заголовке. Добавьте кратковременный токен OAuth2 в качестве значения заголовка Authorization . Для получения дополнительной информации о получении этого токена см. Provide credentials manual .
  • 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
{}

Управление картами взаимосвязей для нескольких экземпляров приложений

Используя пакетные методы службы Instance ID, вы можете выполнять пакетное управление экземплярами приложений. Например, вы можете выполнять массовое добавление или удаление экземпляров приложений в тему FCM. Чтобы обновить до 1000 экземпляров приложений за один вызов API, вызовите службу Instance ID в этой конечной точке, предоставив токены экземпляров приложений в теле JSON:

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

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

Параметры

  • Authorization: Bearer <access_token> . Установите этот параметр в заголовке. Добавьте кратковременный токен OAuth2 в качестве значения заголовка Authorization . Для получения дополнительной информации о получении этого токена см. Provide credentials manual .
  • access_token_auth: true . Установите этот параметр в заголовке.
  • to : Название темы.
  • registration_tokens : Массив токенов IID для экземпляров приложений, которые вы хотите добавить или удалить.

Результаты

При успешном выполнении вызов возвращает HTTP-статус 200. Пустые результаты указывают на успешную подписку на токен. В случае неудачных подписок результат содержит один из следующих кодов ошибок:

  • NOT_FOUND — Токен регистрации был удален или приложение было удалено.
  • INVALID_ARGUMENT — Предоставленный регистрационный токен недействителен для идентификатора отправителя.
  • ВНУТРЕННИЙ — Внутренний сервер вышел из строя по неизвестным причинам. Повторите запрос.
  • 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

Используя метод batchImport службы Instance ID, вы можете массово импортировать существующие токены iOS APNs в Firebase Cloud Messaging, сопоставляя их с действительными токенами регистрации. Вызовите службу Instance ID в этой конечной точке, предоставив список токенов APNs в теле JSON: 

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

Тело ответа содержит массив токенов регистрации идентификатора экземпляра, готовых к использованию для отправки сообщений FCM на соответствующий токен устройства APNs.

Параметры

  • Authorization: Bearer <access_token> . Установите этот параметр в заголовке. Добавьте кратковременный токен OAuth2 в качестве значения заголовка Authorization . Для получения дополнительной информации о получении этого токена см. Provide credentials manual .
  • access_token_auth: true . Установите этот параметр в заголовке.
  • application : идентификатор пакета приложения.
  • sandbox : логическое значение, указывающее на среду песочницы (TRUE) или производство (FALSE)
  • apns_tokens : Массив токенов APN для экземпляров приложений, которые вы хотите добавить или удалить. Максимум 100 токенов на запрос.

Результаты

При успешном выполнении вызов возвращает HTTP-статус 200 и тело результата JSON. Для каждого токена APNs, указанного в запросе, список результатов включает:

  • Токен APNs.
  • Статус. Либо ОК, либо сообщение об ошибке, описывающее сбой.
  • Для успешного результата токен регистрации, который 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"
        },
     ]
  }

Ошибочные ответы

Вызовы API сервера Instance ID возвращают следующие коды ошибок 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) — сервис недоступен. Повторите запрос с экспоненциальной задержкой.