Действие SetPlatformApplicationAttributes
Статья создана
Обновлена 24 сентября 2024 г.
Задать параметры канала мобильных Push-уведомлений.
HTTP-запрос
POST https://notifications.yandexcloud.net/
Query-параметры
| Параметр | Описание |
|---|---|
Action |
string Обязательное поле. Параметр для обозначения типа операции. Значение: SetPlatformApplicationAttributes. |
PlatformApplicationArn |
string Обязательное поле. Идентификатор канала мобильных Push-уведомлений. Пример: arn:aws:sns::aoegtvhtp8ob********:app/GCM/test-cns-9990. |
Attributes.entry.N.key |
string Обязательное поле. Ключ атрибута. N — числовое значение.Пример: Attributes.entry.1.key=PlatformPrincipal&Attributes.entry.2.key=PlatformCredential. |
Attributes.entry.N.value |
string Обязательное поле. Значение атрибута. N — числовое значение.Пример: Attributes.entry.1.value=c8gzjriSVxDDzX2fAV********&Attributes.entry.2.value=CgB6e3x9iW/qiE9l9wAUPK0e/bJQe5uIgTlYUD4bP********. |
ResponseFormat |
string Формат ответа. Возможные значения:
|
Атрибуты
Общие атрибуты
| Атрибут | Описание |
|---|---|
Description |
string Описание приложения. Пример: Test application. |
Атрибуты APNS и APNS_SANDBOX
| Атрибут | Описание |
|---|---|
PlatformPrincipal |
string Токен в формате .p8 или SSL-сертификат в формате .p12. Аутентификация с токеном является предпочтительной, как более современная. |
PlatformCredential |
string Идентификатор токена или закрытый ключ SSL-сертификата. |
ApplePlatformTeamID |
string Идентификатор разработчика, только при использовании токена. |
ApplePlatformBundleID |
string Идентификатор приложения (Bundle ID), только при использовании токена. |
Атрибуты FCM
| Атрибут | Описание |
|---|---|
PlatformCredential |
string Ключ сервисного аккаунта Google Cloud в формате JSON для аутентификации с помощью HTTP v1 API или API-ключ (server key) для аутентификации с помощью Legacy API. Версия HTTP v1 API является предпочтительной, так как с июня 2024 года Legacy API не будет поддерживаться FCM. |
Атрибуты HMS
| Атрибут | Описание |
|---|---|
PlatformPrincipal |
string Идентификатор ключа. |
PlatformCredential |
string API-ключ. |
Подробнее об атрибутах для аутентификации см. в подразделе Каналы мобильных Push-уведомлений.
Ответ
Успешный ответ
При отсутствии ошибок Cloud Notification Service отвечает HTTP-кодом 200.
Успешный ответ содержит дополнительные данные в формате XML или JSON в зависимости от указанного параметра ResponseFormat.
Схема данных:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<SetPlatformApplicationAttributes>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
</SetPlatformApplicationAttributes>
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Где RequestId — идентификатор запроса.
Ответ с ошибкой
При возникновении ошибки Cloud Notification Service отвечает сообщением с соответствующим HTTP-кодом.
Перечень общих кодов ошибок для всех действий см. в разделе Ошибки.