Лаунчер

Операции лаунчера используются клиентом запуска игры для проверки доступности API, отправки событий, аппаратного профиля и отчетов о сбоях.

Проверка доступности

QuerydocumentId: healthauth: launcher key

health

Описание

Проверяет доступность API лаунчера.

Входные данные

Операция не принимает переменные.

Результат

Тип ответа - Boolean!.

Ошибки

• PROJECT_NOT_FOUND - проект не найден.
• LAUNCHER_DISABLED - API лаунчера отключен.

Пример обмена

Запрос

documentId: health

{
  "documentId": "health",
  "variables": {}
}

Ответ

200 OK

{
  "data": {
    "health": true
  }
}

Связанные типы

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

Событие лаунчера

MutationdocumentId: reportLauncherEventauth: launcher key

reportLauncherEvent

Описание

Отправляет событие лаунчера: запуск, авторизацию, начало загрузки, завершение загрузки или другое клиентское действие.

Входные данные

Поле	Тип	Обязательный	Описание
launcherKey	String!	✓	Ключ лаунчера
launcherId	String	-	ID установленного клиента
event	String!	✓	Название события
launcherVersion	String	-	Версия лаунчера
payload	JSON	-	Дополнительные данные события

Результат

Тип ответа - Boolean!.

Ошибки

• VALIDATION - обязательные поля не переданы.
• INVALID_LAUNCHER_KEY - ключ лаунчера неверный.

Пример обмена

Запрос

documentId: reportLauncherEvent

{
  "documentId": "reportLauncherEvent",
  "variables": {
    "launcherKey": "launcher-key",
    "launcherId": "launcher-id",
    "event": "launcher_opened",
    "launcherVersion": "1.0.0",
    "payload": {}
  }
}

Ответ

200 OK

{
  "data": {
    "reportLauncherEvent": true
  }
}

Связанные типы

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

Аппаратный профиль

MutationdocumentId: reportHardwareauth: launcher key

reportHardware

Описание

Отправляет аппаратный профиль устройства для диагностики, защиты и поддержки пользователей.

Входные данные

Поле	Тип	Обязательный	Описание
launcherKey	String!	✓	Ключ лаунчера
hardware	JSON!	✓	Аппаратный профиль

Результат

Тип ответа - Boolean!.

Ошибки

• VALIDATION - аппаратный профиль не передан.
• INVALID_LAUNCHER_KEY - ключ лаунчера неверный.

Пример обмена

Запрос

documentId: reportHardware

{
  "documentId": "reportHardware",
  "variables": {
    "launcherKey": "launcher-key",
    "hardware": {
      "cpu": "Intel Core",
      "gpu": "NVIDIA",
      "ram": 16
    }
  }
}

Ответ

200 OK

{
  "data": {
    "reportHardware": true
  }
}

Связанные типы

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

Отчет о сбое

MutationdocumentId: reportCrashauth: launcher key

reportCrash

Описание

Отправляет отчет о сбое лаунчера или игрового клиента.

Входные данные

Поле	Тип	Обязательный	Описание
launcherKey	String!	✓	Ключ лаунчера
crash	JSON!	✓	Данные сбоя

Результат

Тип ответа - Boolean!.

Ошибки

• VALIDATION - данные сбоя не переданы.
• INVALID_LAUNCHER_KEY - ключ лаунчера неверный.

Пример обмена

Запрос

documentId: reportCrash

{
  "documentId": "reportCrash",
  "variables": {
    "launcherKey": "launcher-key",
    "crash": {
      "message": "Unhandled exception",
      "stack": "stack trace",
      "launcherVersion": "1.0.0"
    }
  }
}

Ответ

200 OK

{
  "data": {
    "reportCrash": true
  }
}

Связанные типы

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