SDK de Engage: Instrucciones de integración técnica de terceros

Google está compilando una plataforma integrada en el dispositivo que organiza las apps de los usuarios por verticales y que permite ofrecer una nueva experiencia envolvente para el descubrimiento y el consumo de contenido personalizado en las apps. Esta experiencia en pantalla completa brinda a los socios desarrolladores la oportunidad de mostrar su mejor contenido enriquecido en un canal dedicado fuera de su app.En esta guía, se incluyen instrucciones para que los socios desarrolladores integren su contenido de salud y fitness usando el SDK de Engage para propagar esta nueva área de superficie.

Información detallada sobre la integración

Terminología

Esta integración incluye los siguientes tres tipos de clústeres: Recommendation, Featured y Continuation.

• En los clústeres de Recommendation, se muestran sugerencias personalizadas de salud y fitness de un socio desarrollador individual. Estas recomendaciones se pueden personalizar para el usuario o generalizar (por ejemplo, tendencias de bienestar y salud). Úsalas para mostrar artículos o personas relacionados con la salud y el bienestar.

  • Un clúster de Recommendation puede estar formado por ArticleEntity, PersonEntity o EventEntity, pero no por una combinación de diferentes tipos de entidades.

  Tus recomendaciones tienen la siguiente estructura:

  • Clúster de Recommendation: Es una vista de la IU que contiene un grupo de recomendaciones del mismo socio desarrollador.

  • Entidad: Es un objeto que representa un solo elemento en un clúster. Esta integración ofrece algunas entidades que se mostrarían con el clúster de Recommendation:

    • ArticleEntity: ArticleEntity representa una recomendación para contenido de texto relacionado con la salud y el fitness. Se puede usar para artículos, entradas de blog, contenido de marketing, fragmentos de noticias, etcétera.

      

      Figura 1: IU que muestra un solo ArticleEntity en el clúster de Recommendations.

    • PersonEntity: PersonEntity representa a una persona. Las recomendaciones podrían ser destacar un entrenador o cualquier persona relacionada con la salud y el estado físico, etcétera.

      

      Figura 2: IU que muestra una sola PersonEntity en el clúster de Recomendaciones

    • EventEntity: EventEntity representa un evento que se llevará a cabo en el futuro. La hora de inicio del evento es un dato fundamental que se debe transmitir a los usuarios. Esta entidad podría usarse para mostrar eventos relacionados con la salud y el bienestar, como campamentos de donación de sangre, sesiones de entrenamiento, clases de gimnasio o yoga, etcétera.

      

      Figura 3: IU que muestra un solo EventEntity en el clúster de Recommendations.

• El clúster de Continuation muestra el contenido que interactuaron recientemente los usuarios de varios socios desarrolladores en una sola agrupación de IU. Cada socio desarrollador podrá transmitir un máximo de 10 entidades en el clúster de Continuation.

  Tu contenido de continuación puede tener la siguiente estructura:

  • ArticleEntity: ArticleEntity representa una recomendación para contenido basado en texto relacionado con la salud y el fitness. Esta entidad se puede usar para representar artículos de noticias sin terminar o cualquier otro contenido que el usuario desee seguir consumiendo desde donde lo dejó. P. ej., un fragmento de noticias o un fragmento de entrada de blog sobre temas relacionados con la salud o el fitness.

    

    Figura 6: IU que muestra una sola ArticleEntity dentro de un clúster de Continuation.

  • EventReservationEntity: EventReservationEntity representa la reserva de un evento y ayuda a los usuarios a hacer un seguimiento de las reservas de eventos de salud y entrenamiento futuros o en curso. Ej.: sesiones de capacitación

    

    Figura 8: IU que muestra una sola EventReservationEntity dentro de un clúster de Continuation

• El clúster de Featured es una vista de la IU que muestra el hero GenericFeaturedEntity elegido entre muchos socios desarrolladores en una agrupación de IU. Hay un solo clúster de Featured, que aparecerá cerca de la parte superior de la IU, con una ubicación de prioridad por sobre todos los clústeres de Recommendation. Cada socio desarrollador puede transmitir una sola entidad de un tipo compatible en la sección Featured, y habrá muchas entidades (potencialmente de diferentes tipos) de varios desarrolladores de apps en el clúster de Featured.

  • GenericFeaturedEntity: GenericFeaturedEntity se diferencia del elemento de recomendación en que el elemento destacado debe usarse para un solo contenido principal de los desarrolladores y debe representar el contenido más importante que será interesante y relevante para los usuarios.

    

    Figura 12: IU que muestra una sola tarjeta hero GenericFeaturedEntity dentro de un clúster de Featured

Trabajo previo

Nivel de API mínimo: 19

Agrega la biblioteca com.google.android.play:engage a tu app:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.4.1'
}

Resumen

El diseño se basa en una implementación de un servicio vinculado.

Los datos que un cliente puede publicar están sujetos a los siguientes límites para diferentes tipos de clústeres:

Tipo de clúster	Límites del clúster	Límites mínimos de entidades en un clúster	Límites máximos de entidades en un clúster
Clústeres de Recommendation	5 como máximo	5 como mínimo	25 como máximo (ArticleEntity, PersonEntity o EventEntity)
Clúster de Continuation	1 como máximo	Una como mínimo	10 como máximo (ArticleEntity o EventReservationEntity)
Clúster de Featured	1 como máximo	Una como mínimo	10 como máximo (GenericFeaturedEntity)

Paso 1: Proporciona los datos de la entidad

El SDK definió distintas entidades para representar cada tipo de elemento. Admitimos las siguientes entidades para la categoría Salud y fitness:

1. GenericFeaturedEntity
2. ArticleEntity
3. PersonEntity
4. EventEntity
5. EventReservationEntity

En los gráficos siguientes, se describen los atributos y requisitos disponibles para cada tipo.

GenericFeaturedEntity

Atributo	Requisito	Descripción	Formato
URI de acción	Obligatorio	Vínculo directo a la entidad en la app del proveedor. Nota: Puedes usar vínculos directos para la atribución. Consulta estas Preguntas frecuentes	URI
Imágenes de pósteres	Obligatorio	Solo mostraremos 1 imagen cuando se proporcionen varias. La relación de aspecto recomendada es 16:9. Nota: Si se proporciona una insignia, asegúrate de que haya un espacio de seguridad de 24 dps en la parte superior e inferior de la imagen.	Consulta la sección Especificaciones de imagen para obtener más información.
Títulos	Opcional	Es el título de la entidad.	Texto libre Tamaño de texto recomendado: 50 caracteres
Descripción	Opcional	Un solo párrafo de texto para describir la entidad Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado: 180 caracteres
Lista de subtítulos	Opcional	Hasta tres subtítulos, cada uno con una sola línea de texto. Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado para cada subtítulo: 50 caracteres como máximo
Insignias	Opcional	Cada insignia puede ser texto libre (15 caracteres como máximo) o imagen pequeña. Tratamiento especial de la UX en la parte superior de la imagen o el video, p.ej., como una insignia superpuesta en la imagen P. ej. "Actualización en tiempo real" P. ej. Duración de la lectura del artículo
Insignia: Texto	Opcional	Título de la insignia Nota: Es obligatorio incluir texto o una imagen para la insignia.	Texto libre Tamaño de texto recomendado: 15 caracteres como máximo
Insignia: Imagen	Opcional	Imagen pequeña Tratamiento especial de la UX, p. ej., como insignia superpuesta en la miniatura de la imagen o el video Nota: Es obligatorio incluir texto o una imagen para la insignia.	Consulta la sección Especificaciones de imagen para obtener más información.
Categorías de contenido	Opcional	Describe la categoría del contenido de la entidad.	Lista de enums Consulta la sección Categorías de contenido para obtener orientación.

ArticleEntity

Atributo	Requisito	Descripción	Formato
URI de acción	Obligatorio	Vínculo directo a la entidad en la app del proveedor. Nota: Puedes usar vínculos directos para la atribución. Consulta estas Preguntas frecuentes	URI
Títulos	Obligatorio	Es el título de la entidad.	Texto libre Tamaño de texto recomendado: 50 caracteres como máximo
Imágenes de pósteres	Opcional	Solo mostraremos 1 imagen cuando se proporcionen varias. La relación de aspecto recomendada es 16:9. Nota: Se recomienda subir imágenes. Si se proporciona una insignia, asegúrate de que haya un espacio de seguridad de 24 dps en la parte superior e inferior de la imagen.	Consulta la sección Especificaciones de imagen para obtener más información.
Fuente: título	Opcional	El nombre del autor, la organización o el denunciante	Texto libre Tamaño de texto recomendado: Menos de 25 caracteres
Fuente: Imagen	Opcional	Una imagen de la fuente, como el autor, la organización o el reportero	Consulta la sección Especificaciones de imagen para obtener más información.
Descripción	Opcional	Un solo párrafo de texto para describir la entidad Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado: 180 caracteres
Lista de subtítulos	Opcional	Hasta tres subtítulos, cada uno con una sola línea de texto. Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado para cada subtítulo: 50 caracteres como máximo
Insignias	Opcional	Cada insignia puede ser texto libre (15 caracteres como máximo) o imagen pequeña. Tratamiento especial de la UX en la parte superior de la imagen o el video, p.ej., como una insignia superpuesta en la imagen P. ej. "Actualización en tiempo real" P. ej. Duración de la lectura del artículo
Insignia: Texto	Opcional	Título de la insignia Nota: Es obligatorio incluir texto o una imagen para la insignia.	Texto libre Tamaño de texto recomendado: 15 caracteres como máximo
Insignia: Imagen	Opcional	Imagen pequeña Tratamiento especial de la UX, p. ej., como insignia superpuesta en la miniatura de la imagen o el video Nota: Es obligatorio incluir texto o una imagen para la insignia.	Consulta la sección Especificaciones de imagen para obtener más información.
Hora de publicación del contenido	Opcional	Esta es la marca de tiempo de época, en milisegundos, en la que se publicó o actualizó el contenido en la app.	Marca de tiempo de época en milisegundos
Tiempo de participación más reciente	Condicionalmente obligatorio	Es la marca de tiempo de época, en milisegundos, en la que el usuario interactuó con esta entidad la última vez. Nota: Este campo es obligatorio si esta entidad es parte del clúster de Continuation.	Marca de tiempo de época en milisegundos
Porcentaje de progreso	Condicionalmente obligatorio	Es el porcentaje de todo el contenido consumido por el usuario hasta la fecha. Nota: Este campo es obligatorio si esta entidad es parte del clúster de Continuation.	Un valor int entre 0 y 100 inclusive.
Categorías de contenido	Opcional	Describe la categoría del contenido de la entidad.	Lista de enums Consulta la sección Categorías de contenido para obtener orientación.

PersonEntity

Atributo	Requisito	Descripción	Formato
URI de acción	Obligatorio	Vínculo directo a la entidad en la app del proveedor. Nota: Puedes usar vínculos directos para la atribución. Consulta estas Preguntas frecuentes	URI
Perfil: Nombre	Obligatorio	Nombre de perfil, ID o identificador (p. ej., "Juan Pérez", "@EquipoPixel", etcétera)	Cadena Tamaño de texto recomendado: 50 caracteres como máximo
Perfil - Avatar	Obligatorio	Foto de perfil o avatar del usuario. Nota: Debe ser una imagen cuadrada con una relación de aspecto de 1:1.	Consulta la sección Especificaciones de imagen para obtener más información.
Perfil: Texto adicional	Opcional	Texto libre, como el identificador del perfil	Texto libre Tamaño de texto recomendado: 15 caracteres como máximo
Perfil: imagen adicional	Opcional	Imagen pequeña como una insignia de verificación.	Consulta la sección Especificaciones de imagen para obtener más información.
Imagen del encabezado	Opcional	Solo mostraremos 1 imagen cuando se proporcionen varias. La relación de aspecto recomendada es 16:9. Nota: Se recomienda subir imágenes. Si se proporciona una insignia, asegúrate de que haya un espacio de seguridad de 24 dps en la parte superior e inferior de la imagen.	Consulta la sección Especificaciones de imagen para obtener más información.
Popularidad: recuento	Opcional	Representa la imagen del encabezado. Debe ser diferente de la imagen de perfil. Se puede usar si hay una imagen adicional para ayudar a destacar a la persona como su trabajo. Nota: Debe ser una imagen con una relación de aspecto de 16:9. Si se proporciona una insignia, asegúrate de que haya un espacio de seguridad de 24 dps en la parte superior e inferior de la imagen	Cadena Tamaño de texto recomendado: 20 caracteres como máximo para la cantidad y la etiqueta combinados
Popularidad: valor de recuento	Opcional	La cantidad de seguidores o el valor de popularidad. Nota: Proporciona el valor de recuento si tu app no quiere controlar la lógica sobre cómo optimizar un número grande para diferentes tamaños de visualización. Si se proporcionan Count y Count Value, se usa Count.	Versión larga
Popularidad: sello discográfico	Opcional	Indica cuál es la etiqueta de popularidad. Por ejemplo, "Me gusta".	Cadena Tamaño de texto recomendado: 20 caracteres como máximo para la cantidad y la etiqueta combinados
Popularidad: elemento visual	Opcional	Indica para qué sirve la interacción. Por ejemplo, una imagen que muestra un ícono de “me gusta” o emojis. Se puede proporcionar más de 1 imagen, aunque es posible que no se muestren todas en todos los factores de forma. Nota: Debe ser una imagen cuadrada con una relación de aspecto de 1:1.	Consulta la sección Especificaciones de imagen para obtener más información.
Calificación: Valor máximo	Obligatorio	Es el valor máximo de la escala de calificación. Se debe brindar si también se proporciona el valor actual de la calificación.	Número >= 0.0
Calificación: Valor actual	Obligatorio	Es el valor actual de la escala de calificación. Se debe proporcionar si también se proporciona el valor máximo de la calificación.	Número >= 0.0
Calificación: Cantidad	Opcional	Es el recuento de calificaciones de la entidad. Nota: Proporciona este campo si tu app quiere controlar cómo se muestra a los usuarios. Proporciona la cadena concisa que se puede mostrar al usuario. Por ejemplo, si la cantidad es 1,000,000, considera usar abreviaturas como 1 M para que no se trunque en tamaños de visualización más pequeños.	Cadena
Calificación: Valor de la cuenta	Opcional	Es el recuento de calificaciones de la entidad. Nota: Proporciona este campo si no quieres controlar la lógica de abreviatura de pantalla por tu cuenta. Si están presentes Count y Count Value, usaremos Count para mostrárselos a los usuarios	Versión larga
Ubicación: país	Opcional	Es el país donde se encuentra la persona o donde presta servicios.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Ciudad	Opcional	Es la ciudad donde se encuentra la persona o donde presta servicios.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: dirección visible	Opcional	Se le mostrará al usuario la dirección en la que se encuentra o donde atiende la persona.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: dirección	Opcional	Es la dirección (si corresponde) donde se encuentra la persona o donde presta sus servicios.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Estado	Opcional	Es el estado (si corresponde) donde se encuentra la persona o presta sus servicios.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Código postal	Opcional	Indica el código postal (si corresponde) del lugar donde se encuentra la persona o presta sus servicios.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: vecindario	Opcional	Es el vecindario (si corresponde) donde se encuentra la persona o presta sus servicios.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Insignias	Opcional	Cada insignia puede ser texto libre (15 caracteres como máximo) o imagen pequeña.
Insignia: Texto	Opcional	Título de la insignia Nota: Es obligatorio incluir texto o una imagen para la insignia.	Texto libre Tamaño de texto recomendado: 15 caracteres como máximo
Insignia: Imagen	Opcional	Imagen pequeña Tratamiento especial de la UX, p. ej., como insignia superpuesta en la miniatura de la imagen o el video Nota: Es obligatorio incluir texto o una imagen para la insignia.	Consulta la sección Especificaciones de imagen para obtener más información.
Descripción	Opcional	Un solo párrafo de texto para describir la entidad Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado: 180 caracteres
Lista de subtítulos	Opcional	Hasta tres subtítulos, cada uno con una sola línea de texto. Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado para cada subtítulo: 50 caracteres como máximo
Categorías de contenido	Opcional	Describe la categoría del contenido de la entidad.	Lista de enums aptas TYPE_HEALTH_AND_FITENESS (p.ej., yoga/entrenador de actividad física) TYPE_HOME_AND_AUTO (por ejemplo, plomero) TYPE_SPORTS (p.ej., jugador) FECHAS_TIPO Consulta la sección Categorías de contenido para obtener orientación.

EventEntity

Atributo	Requisito	Descripción	Formato
URI de acción	Obligatorio	Vínculo directo a la entidad en la app del proveedor. Nota: Puedes usar vínculos directos para la atribución. Consulta estas Preguntas frecuentes	URI
Títulos	Obligatorio	Es el título de la entidad.	Cadena Tamaño de texto recomendado: 50 caracteres como máximo
Inicio	Obligatorio	Es la marca de tiempo de época en la que se espera que comience el evento. Nota: Se representará en milisegundos.	Marca de tiempo de época en milisegundos
Modo de evento	Obligatorio	Un campo para indicar si el evento será virtual, presencial o ambos.	Enumeración: VIRTUAL, IN_PERSON o HYBRID
Imágenes de pósteres	Obligatorio	Solo mostraremos 1 imagen cuando se proporcionen varias. La relación de aspecto recomendada es 16:9. Nota: Se recomienda subir imágenes. Si se proporciona una insignia, asegúrate de que haya un espacio de seguridad de 24 dps en la parte superior e inferior de la imagen.	Consulta la sección Especificaciones de imagen para obtener más información.
Ubicación: país	Condicionalmente obligatorio	Indica el país donde se realiza el evento. Nota: Este paso es obligatorio para los eventos IN_PERSON o HYBRID.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Ciudad	Condicionalmente obligatorio	Es la ciudad donde se lleva a cabo el evento. Nota: Este paso es obligatorio para los eventos IN_PERSON o HYBRID.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: dirección visible	Condicionalmente obligatorio	Es la dirección o el nombre del lugar donde se llevará a cabo el evento que se debe mostrar al usuario. Nota: Este paso es obligatorio para los eventos IN_PERSON o HYBRID.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: dirección	Opcional	Dirección (si corresponde) de la ubicación en la que se realiza el evento	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Estado	Opcional	Es el estado o la provincia (si corresponde) donde se organiza el evento.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Código postal	Opcional	El código postal (si corresponde) de la ubicación donde se realiza el evento	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: vecindario	Opcional	El vecindario (si corresponde) en el que se realiza el evento	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Finalización	Opcional	Es la marca de tiempo de época en la que se espera que finalice el evento. Nota: Se representará en milisegundos.	Marca de tiempo de época en milisegundos
Descripción	Opcional	Un solo párrafo de texto para describir la entidad Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado: 180 caracteres
Lista de subtítulos	Opcional	Hasta tres subtítulos, cada uno con una sola línea de texto. Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado para cada subtítulo: 50 caracteres como máximo
Insignias	Opcional	Cada insignia puede ser texto libre (15 caracteres como máximo) o imagen pequeña.
Insignia: Texto	Opcional	Título de la insignia Nota: Es obligatorio incluir texto o una imagen para la insignia.	Texto libre Tamaño de texto recomendado: 15 caracteres como máximo
Insignia: Imagen	Opcional	Imagen pequeña Tratamiento especial de la UX, p. ej., como insignia superpuesta en la miniatura de la imagen o el video Nota: Es obligatorio incluir texto o una imagen para la insignia.	Consulta la sección Especificaciones de imagen para obtener más información.
Precio - Precio actual	Condicionalmente obligatorio	Es el precio actual de la entrada o el pase para el evento. Se debe brindar si se proporciona el precio tachado.	Texto libre
Precio (precio de ejercicio)	Opcional	Es el precio original de la entrada o el pase para el evento.	Texto libre
Solicitud de oferta de precio	Opcional	Es el texto destacado del precio que muestra una promoción, un evento o un descuento para miembros, si está disponible.	Texto libre Tamaño de texto recomendado: Menos de 45 caracteres (el texto demasiado largo puede mostrar puntos suspensivos)
Categorías de contenido	Opcional	Describe la categoría del contenido de la entidad.	Lista de enums aptas TYPE_POLICYS_AND_TV_SHOWS (p.ej., cine) TYPE_DIGITAL_GAMES (p.ej., deportes electrónicos) TYPE_MUSIC (por ejemplo, concierto) TYPE_TRAVEL_AND_LOCAL (p.ej., gira, festival) TYPE_HEALTH_AND_FITENESS (p.ej., clase de yoga) TYPE_EDUCATION (p.ej., clase) TYPE_SPORTS (p.ej., partido de fútbol) TYPE_DATING (p.ej., encuentro) Consulta la sección Categorías de contenido para obtener orientación.

EventReservationEntity

Atributo	Requisito	Descripción	Formato
URI de acción	Obligatorio	Vínculo directo a la entidad en la app del proveedor. Nota: Puedes usar vínculos directos para la atribución. Consulta estas Preguntas frecuentes	URI
Títulos	Obligatorio	Es el título de la entidad.	Cadena Tamaño de texto recomendado: 50 caracteres como máximo
Inicio	Obligatorio	Es la marca de tiempo de época en la que se espera que comience el evento. Nota: Se representará en milisegundos.	Marca de tiempo de época en milisegundos
Modo de evento	Obligatorio	Un campo para indicar si el evento será virtual, presencial o ambos.	Enumeración: VIRTUAL, IN_PERSON o HYBRID
Ubicación: país	Condicionalmente obligatorio	Indica el país donde se realiza el evento. Nota: Este paso es obligatorio para los eventos IN_PERSON o HYBRID.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Ciudad	Condicionalmente obligatorio	Es la ciudad donde se lleva a cabo el evento. Nota: Este paso es obligatorio para los eventos IN_PERSON o HYBRID.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: dirección visible	Condicionalmente obligatorio	Es la dirección o el nombre del lugar donde se llevará a cabo el evento que se debe mostrar al usuario. Nota: Este paso es obligatorio para los eventos IN_PERSON o HYBRID.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: dirección	Opcional	Dirección (si corresponde) de la ubicación en la que se realiza el evento	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Estado	Opcional	Es el estado o la provincia (si corresponde) donde se organiza el evento.	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: Código postal	Opcional	El código postal (si corresponde) de la ubicación donde se realiza el evento	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Ubicación: vecindario	Opcional	El vecindario (si corresponde) en el que se realiza el evento	Texto libre Tamaño de texto recomendado: 20 caracteres como máximo
Imágenes de pósteres	Opcional	Solo mostraremos 1 imagen cuando se proporcionen varias. La relación de aspecto recomendada es 16:9. Nota: Se recomienda subir imágenes. Si se proporciona una insignia, asegúrate de que haya un espacio de seguridad de 24 dps en la parte superior e inferior de la imagen.	Consulta la sección Especificaciones de imagen para obtener más información.
Finalización	Opcional	Es la marca de tiempo de época en la que se espera que finalice el evento. Nota: Se representará en milisegundos.	Marca de tiempo de época en milisegundos
Proveedor de servicios: Nombre	Opcional	El nombre del proveedor de servicios. Nota: El proveedor de servicios debe incluir texto o imagen.	Texto libre. P. ej., el nombre del organizador del evento o la gira.
Proveedor de servicios: imagen	Opcional	El logotipo o la imagen del proveedor de servicios. Nota: El proveedor de servicios debe incluir texto o imagen.	Consulta la sección Especificaciones de imagen para obtener más información.
Descripción	Opcional	Un solo párrafo de texto para describir la entidad Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado: 180 caracteres
Lista de subtítulos	Opcional	Hasta tres subtítulos, cada uno con una sola línea de texto. Nota: Al usuario se le mostrará la descripción o la lista de subtítulos, pero no ambas.	Texto libre Tamaño de texto recomendado para cada subtítulo: 50 caracteres como máximo
Insignias	Opcional	Cada insignia puede ser texto libre (15 caracteres como máximo) o imagen pequeña.
Insignia: Texto	Opcional	Título de la insignia Nota: Es obligatorio incluir texto o una imagen para la insignia.	Texto libre Tamaño de texto recomendado: 15 caracteres como máximo
Insignia: Imagen	Opcional	Imagen pequeña Tratamiento especial de la UX, p. ej., como insignia superpuesta en la miniatura de la imagen o el video Nota: Es obligatorio incluir texto o una imagen para la insignia.	Consulta la sección Especificaciones de imagen para obtener más información.
ID de reserva	Opcional	El ID de reserva para la reserva del evento.	Texto libre
Precio - Precio actual	Condicionalmente obligatorio	Es el precio actual de la entrada o el pase para el evento. Se debe brindar si se proporciona el precio tachado.	Texto libre
Precio (precio de ejercicio)	Opcional	Es el precio original de la entrada o el pase para el evento.	Texto libre
Solicitud de oferta de precio	Opcional	Es el texto destacado del precio que muestra una promoción, un evento o un descuento para miembros, si está disponible.	Texto libre Tamaño de texto recomendado: Menos de 45 caracteres (el texto demasiado largo puede mostrar puntos suspensivos)
Calificación: Valor máximo	Opcional	Es el valor máximo de la escala de calificación. Se debe brindar si también se proporciona el valor actual de la calificación.	Número >= 0.0
Calificación: Valor actual	Opcional	Es el valor actual de la escala de calificación. Se debe proporcionar si también se proporciona el valor máximo de la calificación.	Número >= 0.0
Calificación: Cantidad	Opcional	Es la cantidad de calificaciones del evento. Nota: Proporciona este campo si tu app quiere controlar cómo se muestra a los usuarios. Proporciona la cadena concisa que se puede mostrar al usuario. Por ejemplo, si la cantidad es 1,000,000, considera usar abreviaturas como 1 M para que no se trunque en tamaños de visualización más pequeños.	Cadena
Calificación: Valor de la cuenta	Opcional	Es la cantidad de calificaciones del evento. Nota: Proporciona este campo si no quieres controlar la lógica de abreviatura de pantalla por tu cuenta. Si están presentes Count y Count Value, usaremos Count para mostrárselos a los usuarios	Versión larga
Categorías de contenido	Opcional	Describe la categoría del contenido de la entidad.	Lista de enums aptas TYPE_POLICYS_AND_TV_SHOWS (p.ej., cine) TYPE_DIGITAL_GAMES (p.ej., deportes electrónicos) TYPE_MUSIC (por ejemplo, concierto) TYPE_TRAVEL_AND_LOCAL (p.ej., gira, festival) TYPE_HEALTH_AND_FITENESS (p.ej., clase de yoga) TYPE_EDUCATION (p.ej., clase) TYPE_SPORTS (p.ej., partido de fútbol) TYPE_DATING (p.ej., encuentro) Consulta la sección Categorías de contenido para obtener orientación.

Especificaciones de imagen

En esta tabla, se indican las especificaciones obligatorias para los recursos de imagen:

Relación de aspecto	Píxeles mínimos	Píxeles recomendados
Formato cuadrado (1 x 1) Preferido	300 x 300	1,200 x 1,200
Formato horizontal (1.91 x 1)	600 x 314	1,200 x 628
Formato vertical (4 x 5)	480 x 600	960 x 1,200

Las imágenes deben estar alojadas en CDN públicas para que Google pueda acceder a ellas.

Formatos de archivo

PNG, JPG, GIF estático, WebP

Tamaño máximo de los archivos

5120 KB

Recomendaciones adicionales

• Área segura para la imagen: Coloca el contenido importante en el 80% central de la imagen.
• Usa un fondo transparente para que la imagen se muestre correctamente cuando se configure el tema oscuro o claro.

Categoría de contenido

La categoría de contenido permite que las apps publiquen contenido que pertenece a varias categorías. Esto asigna el contenido con algunas de las categorías predefinidas, a saber:

• TYPE_EDUCATION
• TYPE_SPORTS
• TYPE_MOVIES_AND_TV_SHOWS
• TYPE_BOOKS
• TYPE_AUDIOBOOKS
• TYPE_MUSIC
• TYPE_DIGITAL_GAMES
• TYPE_TRAVEL_AND_LOCAL
• TYPE_HOME_AND_AUTO
• TYPE_BUSINESS
• TYPE_NEWS
• TYPE_FOOD_AND_DRINK
• TYPE_SHOPPING
• TYPE_HEALTH_AND_FITENESS
• TYPE_MEDICAL
• TYPE_PARENTING
• TYPE_DATING

Las imágenes deben estar alojadas en CDN públicas para que Google pueda acceder a ellas.

Lineamientos para usar las categorías de contenido

1. Algunas entidades, como ArticleEntity y GenericFeaturedEntity, son aptas para usar cualquiera de las categorías de contenido. Para otras entidades, como EventEntity, EventReservationEntity y PersonEntity, solo un subconjunto de estas categorías es apto. Verifica la lista de categorías aptas para un tipo de entidad antes de propagar la lista.

2. Usa el tipo de entidad específico para algunas categorías de contenido en una combinación de entidades genéricas y ContentCategory:

   • TYPE_MOVIES_AND_TV_SHOWS: Consulta las entidades de la Guía de integración de visualización antes de usar las entidades genéricas.
   • TYPE_BOOKS: Consulta EbookEntity antes de usar las entidades genéricas.
   • TYPE_AUDIOBOOKS: Consulta AudiobookEntity antes de usar las entidades genéricas.
   • TYPE_SHOPPING: revisa ShoppingEntity antes de usar las entidades genéricas.
   • TYPE_FOOD_AND_DRINK: revisa las entidades de la Guía de integración de alimentos antes de usar las entidades genéricas.

3. El campo ContentCategory es opcional y se debe dejar en blanco si el contenido no pertenece a ninguna de las categorías mencionadas anteriormente.

4. Si se proporcionan varias categorías de contenido, hazlo en el orden de relevancia para el contenido, colocando la categoría más relevante en primer lugar en la lista.

Paso 2: Proporciona los datos de los clústeres

Se recomienda que el trabajo de publicación de contenido se ejecute en segundo plano (por ejemplo, con WorkManager) y se programe con frecuencia o en eventos (por ejemplo, cada vez que el usuario abre la app o cuando acaba de agregar algo a su carrito).

AppEngagePublishClient es responsable de publicar los clústeres.

Hay cinco APIs para publicar clústeres en el cliente:

• isServiceAvailable
• publishRecommendationClusters
• publishFeaturedCluster
• publishContinuationCluster
• publishUserAccountManagementRequest
• updatePublishStatus
• deleteRecommendationsClusters
• deleteFeaturedCluster
• deleteContinuationCluster
• deleteUserManagementCluster
• deleteClusters

isServiceAvailable

Esta API se usa para verificar si el servicio está disponible para la integración y si el contenido se puede presentar en el dispositivo.

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

Nota: Te recomendamos que mantengas en ejecución un trabajo periódico para comprobar si el servicio se vuelve disponible más adelante. La disponibilidad del servicio puede cambiar con las actualizaciones de versiones de Android, las actualizaciones de apps, las instalaciones y las desinstalaciones. Cuando se realizan verificaciones de trabajo periódico en un intervalo determinado, se pueden publicar los datos una vez que el servicio esté disponible.

publishRecommendationClusters

Esta API se usa para publicar una lista de objetos RecommendationCluster.

Importante: Las APIs de publicación son APIs de inserción y actualización. Reemplazan el contenido existente. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente.

Kotlin

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

Cuando el servicio recibe la solicitud, se realizan las siguientes acciones en una transacción:

• Se quitan los datos existentes de RecommendationCluster del socio desarrollador.
• Los datos de la solicitud se analizan y se almacenan en el clúster de Recommendation actualizado.

En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

publishFeaturedCluster

Esta API se usa para publicar una lista de objetos FeaturedCluster.

Importante: Las APIs de publicación son APIs de inserción y actualización. Reemplazan el contenido existente. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente.

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Cuando el servicio recibe la solicitud, se realizan las siguientes acciones en una transacción:

• Se quitan los datos existentes de FeaturedCluster del socio desarrollador.
• Los datos de la solicitud se analizan y se almacenan en el clúster de Featured actualizado.

En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

publishContinuationCluster

Esta API se usa para publicar un objeto ContinuationCluster.

Importante: Las APIs de publicación son APIs de inserción y actualización. Reemplazan el contenido existente. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente.

Kotlin

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Cuando el servicio recibe la solicitud, se realizan las siguientes acciones en una transacción:

• Se quitan los datos existentes de ContinuationCluster del socio desarrollador.
• Los datos de la solicitud se analizan y se almacenan en el clúster de Continuation actualizado.

En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

publishUserAccountManagementRequest

Esta API se usa para publicar una tarjeta de acceso. La acción de acceso dirige a los usuarios a la página de acceso de la app para que esta pueda publicar contenido (o proporcionar contenido más personalizado).

Los siguientes metadatos forman parte de la tarjeta de acceso:

Atributo	Requisito	Descripción
URI de acción	Obligatorio	Vínculo directo a la acción (p. ej., navega a la página de acceso de la app)
Imagen	Opcional: En caso de que no se proporcione el título, debes brindar uno.	Imagen que se muestra en la tarjeta Imágenes con una relación de aspecto de 16 × 9, con una resolución de 1264 × 712
Títulos	Opcional: En caso de que no se proporcione la imagen, debes brindar una.	Título en la tarjeta
Texto de acción	Opcional	Texto que se muestra en la CTA (p. ej., Acceder)
Subtítulo	Opcional	Subtítulo opcional en la tarjeta

Importante: Las APIs de Publication son APIs de inserción y actualización. Reemplazan el contenido existente. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente.

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Cuando el servicio recibe la solicitud, se realizan las siguientes acciones en una transacción:

• Se quitan los datos existentes de UserAccountManagementCluster del socio desarrollador.
• Los datos de la solicitud se analizan y se almacenan en el clúster de UserAccountManagementCluster actualizado.

En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

updatePublishStatus

Si, por algún motivo empresarial interno, no se publica ninguno de los clústeres, te recomendamos enfáticamente actualizar el estado de publicación con la API de updatePublishStatus. A continuación, explicamos por qué es importante:

• Proporcionar el estado en todas las situaciones, incluso cuando el contenido está publicado (STATUS == PUBLISHED), es fundamental para propagar los paneles que usan este estado explícito para transmitir el estado y otras métricas de tu integración.
• Si no se publica contenido pero el estado de integración no está roto (STATUS == NOT_PUBLISHED), Google puede evitar activar alertas en los paneles de estado de la app. Confirma que el contenido no se publicó debido a una situación prevista desde el punto de vista del proveedor.
• Ayuda a los desarrolladores a proporcionar estadísticas sobre cuándo se publican los datos y cuándo no.
• Google puede usar los códigos de estado para sugerir al usuario que realice ciertas acciones en la app, de modo que pueda ver el contenido de la app o superarlo.

La lista de códigos de estado de publicación aptos es la siguiente:

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Si el contenido no se publica debido a que un usuario no accedió, Google te recomienda publicar la tarjeta de acceso. Si, por algún motivo, los proveedores no pueden publicar la tarjeta de acceso, recomendamos llamar a la API de updatePublishStatus con el código de estado NOT_PUBLISHED_REQUIRES_SIGN_IN.

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationClusters

Esta API se usa para borrar el contenido de los clústeres de Recommendation.

Importante: Solo se debe llamar a las APIs de Delete cuando no hay contenido para publicar. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente. Comunícate con engage-developers@ antes de usar las APIs de Delete.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Cuando el servicio recibe la solicitud, quita los datos existentes de los clústeres de Recommendation. En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

Nota: Esta API está disponible desde la versión 1.1.0 en adelante.

deleteFeaturedCluster

Esta API se usa para borrar el contenido del clúster de Featured.

Importante: Solo se debe llamar a las APIs de Delete cuando no hay contenido para publicar. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente. Comunícate con engage-developers@ antes de usar las APIs de Delete.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Cuando el servicio recibe la solicitud, quita los datos existentes del clúster de Featured. En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

Nota: Esta API está disponible desde la versión 1.1.0 en adelante.

deleteContinuationCluster

Esta API se usa para borrar el contenido del clúster de Continuation.

Importante: Solo se debe llamar a las APIs de Delete cuando no hay contenido para publicar. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente. Comunícate con engage-developers@ antes de usar las APIs de Delete.

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

Cuando el servicio recibe la solicitud, quita los datos existentes del clúster de Continuation. En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

Nota: Esta API está disponible desde la versión 1.1.0 en adelante.

deleteUserManagementCluster

Esta API se usa para borrar el contenido del clúster de UserAccountManagement.

Importante: Solo se debe llamar a las APIs de Delete cuando no hay contenido para publicar. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente. Comunícate con engage-developers@ antes de usar las APIs de Delete.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Cuando el servicio recibe la solicitud, quita los datos existentes del clúster de UserAccountManagement. En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

Nota: Esta API está disponible desde la versión 1.1.0 en adelante.

deleteClusters

Esta API se usa para borrar el contenido de un tipo de clúster determinado.

Importante: Solo se debe llamar a las APIs de Delete cuando no hay contenido para publicar. No llames a las APIs de Delete y Publication posteriormente para reemplazar el contenido, ya que las APIs de Publication lo hacen de forma inherente. Comunícate con engage-developers@ antes de usar las APIs de Delete.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_CONTINUATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_CONTINUATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                .build());

Cuando el servicio recibe la solicitud, quita los datos existentes de todos los clústeres que coincidan con los tipos de clúster especificados. Los clientes pueden optar por pasar uno o varios tipos de clústeres. En caso de error, se rechaza la solicitud completa y se mantiene el estado existente.

Manejo de errores

Te recomendamos que escuches el resultado de la tarea de las APIs de publicación, de manera que se pueda realizar una acción de seguimiento para recuperar y volver a enviar una tarea con éxito.

Kotlin

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

El error se muestra como una AppEngageException con la causa incluida como un código de error.

Código de error	Nota
SERVICE_NOT_FOUND	El servicio no está disponible en el dispositivo determinado.
SERVICE_NOT_AVAILABLE	El servicio está disponible en el dispositivo determinado, pero no en el momento de la llamada (por ejemplo, está inhabilitado explícitamente).
SERVICE_CALL_EXECUTION_FAILURE	No se pudo ejecutar la tarea debido a problemas con los subprocesos. En este caso, se puede volver a intentar.
SERVICE_CALL_PERMISSION_DENIED	El llamador no tiene permiso para realizar la llamada de servicio.
SERVICE_CALL_INVALID_ARGUMENT	La solicitud contiene datos no válidos (por ejemplo, una cantidad de clústeres mayor que la permitida).
SERVICE_CALL_INTERNAL	Hay un error en el servicio.
SERVICE_CALL_RESOURCE_EXHAUSTED	La llamada de servicio se realiza con demasiada frecuencia.

Paso 3: Controla los intents de transmisión

Además de realizar llamadas a las APIs de publicación de contenido a través de un trabajo, también se requiere configurar un BroadcastReceiver para recibir la solicitud de publicación de contenido.

El objetivo de los intents de transmisión es principalmente reactivar apps y forzar la sincronización de datos. Los intents de transmisión no están diseñados para enviarse con mucha frecuencia. Solo se activan cuando el servicio de Engage determina que el contenido puede estar inactivo (por ejemplo, si es de hace una semana). De esa manera, será más probable que el usuario tenga una experiencia de contenido actualizada, incluso si la aplicación no se ejecutó durante un período prolongado.

El BroadcastReceiver debe configurarse de las siguientes dos maneras:

• Registra de forma dinámica una instancia de la clase BroadcastReceiver con Context.registerReceiver(). Esto permite la comunicación desde aplicaciones que aún están activas en la memoria.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
  // received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION))
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION));

}

• Declara de forma estática una implementación con la etiqueta <receiver> en tu archivo AndroidManifest.xml. Esto permite que la aplicación reciba intents de transmisión cuando no está en ejecución y que la aplicación publique el contenido.

<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

El servicio envía los siguientes intents:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Te recomendamos que inicies una llamada a publishRecommendationClusters cuando recibas este intent.
• com.google.android.engage.action.PUBLISH_FEATURED Te recomendamos que inicies una llamada a publishFeaturedCluster cuando recibas este intent.
• com.google.android.engage.action.PUBLISH_CONTINUATION Te recomendamos que inicies una llamada a publishContinuationCluster cuando recibas este intent.

Flujo de trabajo de integración

Si deseas obtener una guía paso a paso para verificar la integración una vez que esta se complete, consulta Flujo de trabajo de integración para desarrolladores de Engage.

Preguntas frecuentes

Consulta Preguntas frecuentes sobre el SDK de Engage para ver preguntas frecuentes.

Contacto

Comunícate con [e-mail] si tienes preguntas durante el proceso de integración.

Próximos pasos

Después de completar esta integración, sigue estos pasos:

• Envía un correo electrónico a [e-mail] y adjunta el APK integrado que está listo para que Google lo pruebe.
• Google realiza una verificación y revisiones internas para asegurarse de que la integración funcione según lo previsto. Si se necesitan cambios, Google se comunica contigo con los detalles necesarios.
• Cuando se completen las pruebas y no se necesiten cambios, Google se comunicará contigo para notificarte que puedes comenzar a publicar el APK integrado y actualizado en Play Store.
• Después de que Google confirme que tu APK actualizado se publicó en Play Store, los clústeres de Recommendation, Featured y Continuation se pueden publicar y estar visibles para los usuarios.