Notificações de usuário

Notificações de experiência são uma maneira para opt-in usuários com idade 13+ manterem-se atualizados com suas experiências favoritas através de notificações personalizadas e oportunas.Como desenvolvedor, você pode determinar que tipos de atividades na experiência são mais importantes para notificar seus usuários e definir o conteúdo da notificação.

Depois de receber uma notificações, os usuários podem se juntar à experiência diretamente através do botão Junte-se e gerar de acordo com seus dados de lançamento lançamento.

Para mais informações sobre recursos, requisitos de elegibilidade, diretrizes de uso e a API (Interface de Programação para Aplicações)de motor correspondente, consulte o guia de experiências.

Implementação

A Notificação de Usuário recurso permite que você envie notificações de experiência a usuários.Antes de usá-lo, você deve gerar uma chave de API ou configurar o OAuth 2.0 para o seu aplicativo.Os exemplos nesta página usam chaves de API.

Para enviar uma notificação de experiência a um usuário:

1. Crie uma string de notificação no Painel do Criador.Este passo deve ser feito no Painel do Criador; não há Open Cloud API para isso.
2. Forme o solicitar / pedir:

   1. Copie a chave da API para o cabeçalho de solicitação x-api-key.
   2. Copie o ID da string de notificação como o valor da propriedade payload.message_id.
   3. Defina para .
   4. Defina source.universe para ser o URL da recursos do universo "universes/${UniverseID}".

Envie uma notificaçõesde experiência
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT"
	}
}'

Exemplo de resposta que retorna o ID de notificação no campo id:

{
  "path": "users/505306092/notifications/6ca4d981-36fa-4255-82a1-14d95c116889",
  "id": "6ca4d981-36fa-4255-82a1-14d95c116889"
}

Personalize notificações usando parâmetros

Para personalizar a notificação para cada destinatário, inclua parâmetros na corda de notificação.Então personalize os parâmetros ao chamar a API (Interface de Programação para Aplicações).Por exemplo, você pode definir a string de notificação como:

Adicione os parâmetros userId-friend e points na script:

Personalize Notificação Usando Parâmetros
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT",
		"parameters": {
			"userId-friend": {"int64_value": 3702832553},
			"points": {"string_value": "5"}
		}
	}
}'

Inclua dados de lançamento e análise

Para melhorar a experiência do usuário ainda mais, você pode incluir dados de lançamento na notificação, úteis para cenários como encaminhar usuários para uma localização de coordenadas ou personalizar a experiência de junção.Além disso, você pode incluir análises de dados para segmentar o desempenho de diferentes categorias de notificações.

Incluir Dados de Lançamento e Dados de Análise
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT"
	},
	"join_experience": {
		"launch_data": "Test_Launch_Data"
	},
	"analytics_data": {
		"category": "Test_Analytics_Category"
	}
}'

Limites de taxa e entrega

Cada usuário pode receber uma notificação por dia de uma experiência dada e você recebe feedback transparente quando o limite de aceleração de um usuário é atingido.

Há muitas outras razões pelas quais uma notificação pode não ser entregue. Para mais informações, veja Sistema de entrega no guia do Motor.