Endpoint de referencia de API de PC y Console Server-To-Server (S2S)

La atribución de juegos de PC y consola es una función para empresas. Para obtener más información sobre esta función, lee nuestras preguntas frecuentes sobre la atribución de juegos de PC y consola o ponte en contacto con tu gestor de éxito de clientes.

 

Punto final de notificación de sesión

GET https://s2s.singular.net/api/v1/launch

Utilice el punto final de notificación de sesión para informar de todos los lanzamientos de juegos (primeras sesiones, sesiones repetidas) a este punto final lo más cerca posible del tiempo real. El primer lanzamiento de juego recibido por Singular para una instalación identificada por el ID de dispositivo de Singular, se utiliza para la atribución.

Parámetros de sesión

Parámetro Descripción Restricciones Ejemplo
a La clave "SDK" de su cuenta Singular, en "Herramientas para desarrolladores -> Integración SDK > Claves SDK". Requerido your_org_name_sh868sdjv
p Plataforma de juego, debes seguir los valores admitidos:
pc, xbox, playstation, nintendo, metaquest

Requerido

Sólo valores admitidos

pc
i Un valor identificador único para su juego. Utilice el mismo valor si el mismo juego se distribuye en varias plataformas.

Requerido

Notación DNS inversa

Distingue entre mayúsculas y minúsculas

com.singular.game
sdid

UUID que Singular utiliza para identificar instalaciones únicas y la actividad de juego de un usuario.

Este UUID debe ser generado por el juego/servidor y se recomienda que se genere en el momento del primer lanzamiento (instalación) del juego. El identificador debe persistir durante toda la vida de la instalación de la aplicación.

UUID (Version 4) 49c2d3a6-326e-4ec5-a16b-0a47e34ed953
match_id

Un identificador único que puede ser utilizado para la atribución debe ser enviado en el primer lanzamiento del juego para el usuario. Este valor debe coincidir con el "match_id" utilizado en la implementación de Singular web SDK.

 

Opcional para atribución determinista

Si se envía, debe ser en el primer lanzamiento del juego tras la instalación

matchid_12345
os

Sistema operativo / Sistema de juego

Se admiten valores personalizados, pero se sugieren valores recomendados.

Requerido

Valores personalizados admitidos

Platform = PC

  • windows
  • linux
  • macOS
  • steamOS

Platform = XBox

  • Xbox_one
  • Xbox_360
  • Xbox_series_s
  • xbox_series_x

Platform = Playstation

  • playstation_3
  • Playstation_4
  • playstation_5

Platform = Nintendo

  • nintendo_switch

Platform = Meta Quest

  • metaquest
  • metaquest_2
  • metaquest_pro
ve Versión del sistema operativo Opcional 22H2
av  La versión de la aplicación o del juego Opcional 1.1.5.581823a
ip 

La dirección IP del dispositivo en el momento del evento de lanzamiento del juego

Requerido 172.58.29.235 
use_ip Extrae el campo IP de la petición HTTP. Si lo establece en true, no proporcione el parámetro ip.

Opcional

Boolean

false 
install_source 

El nombre de la tienda de juegos que distribuyó el juego.

Se permiten valores personalizados, pero se recomiendan los siguientes

Requerido

steam

epicgamestore

microsoftstore

gog

humblestore

xbox

playstation

nintendo

selfdistributed

[custom]

 

ua  Agente de usuario del dispositivo Opcional

Mozilla/5.0 (Windows NT 10.0; Win64; x64)
AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36 

global_properties

Pares clave-valor que pueden definirse y guardarse para el usuario. Los valores definidos deben persistir en todas las llamadas posteriores. Si un valor no se envía, se considera no definido.

Opcional

Se permiten hasta 5 propiedades globales de 200 caracteres cada una. Debe ser un objeto JSON codificado con URL.

%7B%22key1%22%3A%22value1%22%2C%
22key2%22%3A%22value2%22%7D

install Indicador de instalación. 'true' si la sesión fue la primera después de instalar la aplicación. 'false' en caso contrario. Necesario para las funciones de seguimiento de la reinstalación.

Opcional

Boolean 

true 
utime Hora de lanzamiento del juego en tiempo UNIX. Opcional 1483228800
umilisec Tiempo de lanzamiento del juego en milisegundos tiempo UNIX. Opcional 1483228800000
custom_user_id

ID de usuario

Opcional 123456789abcd 

 

Punto final de notificación de eventos

GET https://s2s.singular.net/api/v1/evt

Utiliza el punto final de notificación de eventos para informar de todos los eventos opcionales del juego que desees a este punto final lo más cerca posible del tiempo real. Se recomienda encarecidamente la transmisión de eventos del juego, que se utilizan para el análisis, la elaboración de informes y el reenvío a varios socios para su optimización.

Parámetros de evento

Parámetro Descripción Restricciones Ejemplo
a La clave "SDK" de su cuenta Singular, en "Herramientas para desarrolladores -> Integración SDK > Claves SDK". Requerido your_org_name_sh868sdjv
p Plataforma de juego, debes seguir los valores admitidos:
pc, xbox, playstation, nintendo, metaquest

Requerido

Sólo valores admitidos

pc
i Un valor identificador único para su juego. Utilice el mismo valor si el mismo juego se distribuye en varias plataformas.

Required

Notación DNS inversa

Distingue entre mayúsculas y minúsculas

com.singular.app
sdid

UUID que Singular utiliza para identificar instalaciones únicas y la actividad de juego de un usuario.

Este UUID debe ser generado por el juego/servidor y se recomienda que se genere en el momento del primer lanzamiento (instalación) del juego. El identificador debe persistir durante toda la vida de la instalación de la aplicación.

UUID 49c2d3a6-326e-4ec5-a16b-0a47e34ed953
n

El nombre del evento en el juego.

Se recomienda encarecidamente utilizar la convención de nomenclatura de eventos estándar de Singular.

Requerido sng_achievement_unlocked
e

Atributos de evento personalizados que proporcionan información enriquecida sobre el evento, en formato JSON.

Se recomienda encarecidamente utilizar la convención de nomenclatura de atributos de eventos estándar de Singular.

Opcional

JSON

%7B%22sng_attr_content_id%22%3A5581%2C
sng_attr_content%22%3A%22XBox%22%2C%22
sng_attr_content_type%22%3A%22electronics%22%7D
is_revenue_event

Si se trata de un evento de ingresos. Puede omitirlo si el nombre del evento es "__iap__" o se proporciona un "amt" distinto de cero.

Obligatorio para los eventos con ingresos

true
amt

Si se trata de un evento de ingresos, el importe en divisa. Debe utilizarse junto con el parámetro "cur".

Obligatorio para los eventos con ingresos

2.51
cur

Si se trata de un evento de ingresos, el código de moneda ISO 4217 de tres letras. Debe utilizarse junto con el parámetro "amt".

Obligatorio para los eventos con ingresos

EUR
os

Sistema operativo / Sistema de juego

Se admiten valores personalizados, pero se sugieren valores recomendados.

Requerido

Valores personalizados admitidos

Platform = PC

  • windows
  • linux
  • macOS
  • steamOS

Platform = XBox

  • Xbox_one
  • Xbox_360
  • Xbox_series_s
  • xbox_series_x

Platform = Playstation

  • playstation_3
  • Playstation_4
  • playstation_5

Platform = Nintendo

  • nintendo_switch

Platform = Meta Quest

  • metaquest
  • metaquest_2
  • metaquest_pro
ve Versión del sistema operativo Opcional 22H2
av  La versión de la aplicación o del juego Opcional 1.1.5.581823a
ip 

La dirección IP del dispositivo en el momento del evento de lanzamiento del juego

Requerido 172.58.29.235 
use_ip Extrae el campo IP de la petición HTTP. Si lo establece en true, no proporcione el parámetro ip.

Opcional

Boolean

false 
install_source 

El nombre de la tienda de juegos que distribuyó el juego.

Se permiten valores personalizados, pero se recomiendan los siguientes

Requerido

steam

epicgamestore

microsoftstore

gog

humblestore

xbox

playstation

nintendo

selfdistributed

[custom]

 

ua  Agente de usuario del dispositivo Opcional

Mozilla/5.0 (Windows NT 10.0; Win64; x64)
AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36 

global_properties

Pares clave-valor que pueden definirse y guardarse para el usuario. Los valores definidos deben persistir en todas las llamadas posteriores. Si un valor no se envía, se considera no definido.

Opcional

Se permiten hasta 5 propiedades globales de 200 caracteres cada una. Debe ser un objeto JSON codificado con URL.

%7B%22key1%22%3A%22value1%22%2C%
22key2%22%3A%22value2%22%7D

utime Hora de lanzamiento del juego en tiempo UNIX. Opcional 1483228800
umilisec Tiempo de lanzamiento del juego en milisegundos tiempo UNIX. Opcional 1483228800000
custom_user_id

ID de usuario

Opcional 123456789abcd