跳转到主要内容
POST
Setup Push Notification

授权

X-SecretKey
string
header
必填

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

请求体

application/json

When using the Apple Push Notification service (APNS) or the development version (APNS_SANDBOX), the APNS Private Key should be used as the Credential in this call. With Google Cloud Messaging (GCM), the Android API Key should be used. The current ARN (if one exists) can be overwritten by setting the OverwriteOldARN boolean to true.

When using the Apple Push Notification service (APNS) or the development version (APNS_SANDBOX), the APNS Private Key should be used as the Credential in this call. With Google Cloud Messaging (GCM), the Android API Key should be used. The current ARN (if one exists) can be overwritten by setting the OverwriteOldARN boolean to true.

Credential
string
必填

Credential is the Private Key for APNS/APNS_SANDBOX, and the API Key for GCM

OverwriteOldARN
boolean
必填

replace any existing ARN with the newly generated one. If this is set to false, an error will be returned if notifications have already setup for this platform.

Platform
enum<string>
必填

supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud Messaging (GCM) for Android

可用选项:
GCM,
APNS,
APNS_SANDBOX
Key
string

for APNS, this is the PlatformPrincipal (SSL Certificate)

Name
string

This field is deprecated and any usage of this will cause the API to fail.

响应

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
示例:
最后修改于 2026年10月6日