Guía de integración del juego de PC y consola

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.

Singular proporciona una API REST que puede utilizarse para enviar todos los datos de conversión de juegos de PC y consola a Singular para su análisis y atribución.

Esta guía explica cómo crear una integración S2S de PC y consola con Singular e implementar varias funciones opcionales.

Conceptos de integración

Esta sección detalla conceptos generales importantes para implementar una integración S2S de PC y consola completa.

Para obtener una lista completa de los puntos finales de la API S2S, sus parámetros y ejemplos de llamadas, consulte la Referencia de puntos finales S2S de PC y consola.

Privacidad del usuario

Con el fin de preservar la privacidad del usuario, Singular recomienda que los desarrolladores de juegos ofrezcan a los usuarios finales la opción de aceptar o rechazar el envío de datos de eventos de juego a Singular.

Autenticación

Todas las solicitudes a la API S2S de PC y consola de Singular requieren el envío de una clave SDK en el parámetro "a=". Puede encontrar su clave SDK de Singular en "Herramientas para desarrolladores -> Integración SDK > Claves SDK" en su panel de control de Singular.

Advertencia: No utilice la "clave API" de Singular que se encuentra en "Herramientas de desarrollador -> Claves API". La "clave API" se utiliza por separado para la API de informes de Singular.

Plataformas, sistemas de juego y tiendas compatibles

La "Plataforma" en Singular se define como la "plataforma" en la que el usuario juega el juego, y debe pasarse en el parámetro"p=" en todas las peticiones S2S API. A continuación se muestra una lista cerrada de los valores de "plataforma" admitidos:

  • pc
  • xbox
  • playstation
  • nintendo
  • metaquest

Además de "plataforma", el "sistema operativo/de juego" y "tienda" deben pasarse en los parámetros"os=" e"install_source=", respectivamente. Se admiten valores personalizados, pero Singular recomienda los siguientes valores por plataforma:

Plataforma
(p=
)
Sistema operativo/de juego
(os=)
Tienda
(install_source=
)
pc
windows
linux
macos
steamos
steam
epicgamestore
microsoftstore
gog
humblestore
selfdistributed
xbox xbox_one
xbox_360
xbox_series_s
xbox_series_x
xbox
playstation playstation_3
playstation_4
playstation_5
playstation
nintendo nintendo_switch nintendo
metaquest metaquest
metaquest_2
metaquest_pro
metaquest

Identificador del juego

Para que Singular pueda asociar eventos de juego a un juego, se debe pasar un identificador de juego en el parámetro"i=" en cada solicitud.

  • Se puede admitir cualquier valor, pero Singular recomienda que el valor se pase en notación DNS inversa (es decir, com.singular.game).
  • Si su juego está disponible en varias plataformas, es necesario que se utilice el mismo identificador para el mismo juego en todas las plataformas compatibles (p=pc&i=com.singular.game, p=xbox&i=com.singular.game, p=playstation&i=com.singular.game).
  • Para que Singular atribuya correctamente las conversiones de juegos a las campañas Web que se realizan a través de una página de destino del sitio Web, el "identificador de producto" de la integración Web de Singular debe coincidir también con el valor del identificador del juego.

Identificación de instalaciones únicas de juegos

Para que Singular pueda asociar eventos de juego a lo largo de varias sesiones de juego para la misma instalación de juego, se debe pasar un identificador de instalación/dispositivo en el parámetro"sdid=" en cada solicitud.

  • Formato UUID (versión 4) recomendado
  • Este valor debe ser generado por el juego/servidor cuando el juego se lanza (instala) por primera vez y persistir durante toda la instalación del juego.

ID del partido (opcional)

Si las campañas web de su juego conducen a los usuarios a una página web de destino y puede utilizar el "match ID" para la atribución sitio web -> juego PC/Consola, puede pasar opcionalmente el "match ID" en el parámetro"match_id=" para mejorar la precisión de la atribución. Lea más sobre la atribución PC & Consola en nuestro FAQ sobre el tema.

  • Para que la atribución de instalación utilice el "match ID", debe pasarse en el primer lanzamiento del juego para el usuario.
  • El "Match ID" debe coincidir con el mismo valor del usuario en su implementación de Singular web SDK.

Importante: La utilización del "Match ID" para la atribución se considera una función avanzada. Consulte con su ingeniero de soluciones de Singular antes de implementarla.

Informe de lanzamientos de partidas

La notificación de todas las sesiones de juego a Singular es necesaria en una integración de PC y consola y espera que las sesiones de juego se envíen cada vez que se inicia el juego.

Para notificar a Singular sobre una sesión de juego, llame al punto final de notificación de sesión .

Las notificaciones de sesión permiten a Singular hacer varias cosas:

  • Si se trata de la primera sesión de juego después de una instalación única (véase Identificación de instalaciones de juego únicas), Singular reconoce una nueva instalación y activa el proceso de atribución de instalaciones.
  • (Próximamente) Si la sesión de juego se considera una sesión de reenganche, Singular activa el proceso de atribución de reenganches (más información en Preguntas frecuentes sobre reenganches).
  • De lo contrario, Singular la marca como una sesión de juego, que se utiliza para realizar un seguimiento de la actividad y la retención del usuario.

Consejo: Cuando recopile los datos para informar de una sesión de juego, asegúrese de esperar a que las funciones asíncronas devuelvan y gestionen diversas funcionalidades. Por ejemplo:

  • Cuando se utiliza Match ID para mejorar la coincidencia de atribución, es importante informar de la primera sesión de juego sólo después de que el Match ID esté potencialmente disponible. Véase Match ID.
  • Si su juego proporciona una manera de optar por la comercialización de Singular y análisis de juego, es importante esperar hasta que el consentimiento se recoge antes de informar de la sesión de juego. Ver Privacidad del Usuario.

Informar de eventos en el juego

Eventos

Singular puede recopilar datos sobre eventos en el juego para ayudar a analizar el rendimiento de sus campañas de marketing.Los eventos pueden incluir cualquier interacción del usuario, desde inicios de sesión y registros hasta subidas de nivel en el juego.

Antes de implementar una integración S2S con Singular, debe tener una lista de los eventos que su organización desea seguir (véase Definición de eventos en el juego).

Para notificar a Singular cuando se produce un evento en su juego, llame al punto final de Notificación de Eventos. El nombre del evento que incluya en la llamada es la forma en que se identificará el evento en los informes, exportaciones y postbacks de Singular.

Notas:

  • Singular recomienda pasar eventos utilizando la convención de nomenclatura de eventos y atributos estándar de Singular. El uso de eventos estándar agiliza la asignación y la compatibilidad con los eventos estándar de sus socios en las integraciones.
  • Singular recomienda pasar nombres de eventos personalizados y atributos en inglés para compatibilidad con cualquier socio de terceros y soluciones de análisis que desee utilizar.
  • Los nombres de eventos están limitados a 32 caracteres ASCII. Para caracteres no ASCII, el límite es de 32 bytes una vez convertidos a UTF-8.
  • Los atributos y valores de los eventos están limitados a 500 caracteres ASCII.

Ingresos

Singular puede recopilar datos sobre los ingresos obtenidos a través del juego para ayudar a analizar el rendimiento y el ROI de sus campañas.Singular pondrá los datos a su disposición en informes, exportación de registros y postbacks.

Para realizar un seguimiento de los eventos de ingresos, utilice el mismo punto final de notificación de eventos que utiliza para todos los eventos, pero añada la siguiente información:

  • is_revenue_event=true: Esto marca el evento como un evento de ingresos. Puede omitir este parámetro si el nombre del evento es"__iap__" o el importe es superior a cero.
  • Importe de los ingresos (por ejemplo,"amt=1.99").
  • Divisa (utilice el código de divisa ISO 4217, por ejemplo,"cur=USD").