Referencia de puntos finales de la API de servidor a servidor (S2S) para PC y consola

Documento
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, lea nuestras Preguntas frecuentes sobre la atribución de juegos de PC y consola o póngase en contacto con su 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 y sesiones repetidas) a este punto final en el tiempo más real posible. 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 Clave "SDK" de su cuenta Singular, en "Herramientas de desarrollo -> Integración SDK > Claves SDK". Obligatorio tu_nombre_org_sh868sdjv
p Plataforma del juego, deben ser los siguientes valores soportados:
pc, xbox, playstation, nintendo, metaquest

Obligatorio

Sólo valores admitidos

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

Obligatorio

Notación DNS inversa

Distingue entre mayúsculas y minúsculas

com.singular.juego
sdid

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

Este UUID debe ser generado por el juego/servidor y se recomienda que se genere en el momento del primer lanzamiento del juego (instalación).

UUID (Versión 4) 49c2d3a6-326e-4ec5-a16b-0a47e34ed953
match_id

Identificador 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.

Si el identificador es PII, debe estar cifrado (SHA-256).

Opcional para atribución determinista

Si se envía, debe ser en el primer lanzamiento del juego después de la instalación

matchid_12345
os

Sistema operativo / Sistema de juego

Se admiten valores personalizados, pero se sugieren valores recomendados

Obligatorio

Valores personalizados admitidos

Plataforma = PC

  • windows
  • linux
  • macOS
  • steamOS

Plataforma = XBox

  • Xbox_one
  • Xbox_360
  • Xbox_series_s
  • xbox_series_x

Plataforma = Playstation

  • playstation_3
  • playstation_4
  • playstation_5

Plataforma = Nintendo

  • nintendo_switch

Plataforma = Meta Quest

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

IP del dispositivo en el momento del evento de lanzamiento del juego

Obligatorio 172.58.29.235
usar_ip Extrae el campo IP de la petición HTTP. Si estableces esto a true, no proporciones el parámetro ip.

Opcional

Booleano

falso
install_source

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

Se admiten valores personalizados, pero se sugieren recomendaciones

Requerido

steam

epicgamestore

microsoftstore

gog

humblestore

xbox

playstation

nintendo

autodistribuido

[custom]

ua Agente de usuario del dispositivo Opcional

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

propiedades_globales

Pares clave-valor que pueden definirse y guardarse para el usuario. Los valores definidos deben persistir en todas las llamadas posteriores. No enviar un valor se considera como no definir el valor.

Opcional

Se admiten hasta 5 propiedades globales. de 200 caracteres cada una Debe ser un objeto JSON URLEncoded

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

data_sharing_options

Pase este valor opcional para indicar el consentimiento del usuario final para compartir información. Si se establece, este valor debe persistir y pasarse en cada solicitud /launch y /evt posterior del usuario. Véase Privacidad del usuario de PC y consola

Pase "limit_data_sharing":false para indicar que el usuario consintió (optó por) compartir su información.

Pase "limit_data_sharing":true si el usuario se negó.

Opcional

%7B%22limit_data_sharing%22%3Atrue%7D

instalar 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 reinstalación.

Opcional

Booleano

verdadero
utime Hora de lanzamiento del juego en tiempo UNIX. Opcional 1483228800
umiliseg Hora de inicio del juego en milisegundos 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 de desarrollo -> Integración SDK > Claves SDK". Obligatorio tu_nombre_org_sh868sdjv
p Plataforma del juego, deben ser los siguientes valores soportados:
pc, xbox, playstation, nintendo, metaquest

Obligatorio

Sólo valores admitidos

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

Obligatorio

Notación DNS inversa

Distingue entre mayúsculas y minúsculas

com.singular.app
sdid

Singular Device ID que Singular utiliza para identificar instalaciones únicas y actividad de juego para un usuario.

Este UUID debe ser generado por el juego/servidor y se recomienda que se genere en el momento del primer lanzamiento del juego (instalación).

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

El nombre del evento del juego.

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

Requerido sng_logro_desbloqueado
e

Atributos de evento personalizados que proporcionan información detallada 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 es un evento de ingresos. Puede omitirse si el nombre del evento es "__iap__" o se proporciona un "amt" distinto de cero.

Obligatorio para eventos de ingresos

true
amt

Si es un evento de ingresos,el importe en moneda. Debe utilizarse junto con el parámetro "cur".

Obligatorio para los eventos de ingresos

2.51
cur

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

Obligatorio para los ingresos

EUR
os

Sistema operativo / Sistema de juego

Se admiten valores personalizados, pero se sugieren valores recomendados

Requerido

Valores personalizados admitidos

Plataforma = PC

  • windows
  • linux
  • macOS
  • steamOS

Plataforma = XBox

  • Xbox_one
  • Xbox_360
  • Xbox_series_s
  • xbox_series_x

Plataforma = Playstation

  • playstation_3
  • playstation_4
  • playstation_5

Plataforma = Nintendo

  • nintendo_switch

Plataforma = Meta Quest

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

IP del dispositivo en el momento del evento en el juego

Obligatorio 172.58.29.235
usar_ip Extrae el campo IP de la petición HTTP. Si estableces esto a true, no proporciones el parámetro ip.

Opcional

Booleano

falso
install_source

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

Se admiten valores personalizados, pero se sugieren recomendaciones

Requerido

steam

epicgamestore

microsoftstore

gog

humblestore

xbox

playstation

nintendo

autodistribuido

[custom]

ua Agente de usuario del dispositivo Opcional

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

propiedades_globales

Pares clave-valor que pueden definirse y guardarse para el usuario. Los valores definidos deben persistir en todas las llamadas posteriores. No enviar un valor se considera como no definir el valor.

Opcional

Se admiten hasta 5 propiedades globales. de 200 caracteres cada una Debe ser un objeto JSON URLEncoded

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

data_sharing_options

Pase este valor opcional para indicar el consentimiento del usuario final para compartir información. Si se establece, este valor debe persistir y pasarse en cada solicitud /launch y /evt posterior del usuario. Véase Privacidad del usuario de PC y consola

Pase "limit_data_sharing":false para indicar que el usuario consintió (optó por) compartir su información.

Pase "limit_data_sharing":true si el usuario se negó.

Opcional

%7B%22limit_data_sharing%22%3Atrue%7D

utime Hora del evento en el juego en tiempo UNIX. Opcional 1483228800
umilisec Tiempo del evento en el juego en milisegundos tiempo UNIX. Opcional 1483228800000
custom_user_id

ID de usuario

Opcional 123456789abcd