Engage SDK Other Verticals: Third-party technical integration instructions

Google is building an on-device surface that organizes users' apps by verticals and enables a new immersive experience for personalized app content consumption and discovery. This full screen experience provides developer partners an opportunity to showcase their best rich content in a dedicated channel outside of their app.

This document contains instructions for developer partners to integrate new content like reservations, events, lodging, places of interest, people and other content. that might not belong to any of these categories using the Engage SDK to populate this new surface area.

Integration detail

Terminology

This integration includes the following three cluster types: Recommendation, Featured, and Continuation.

Recommendation clusters show personalized suggestions from an individual developer partner. It is a UI view that contains a group of recommendations from the same developer partner.
- ArticleEntity: ArticleEntity that represents a text-based recommendation for content that is relevant to more than one category of content. ArticleEntity item allows developers to provide a variety of text and image content with more metadata to articulate the information to the users compared to GenericFeaturedEntity. Ex: Marketing content, News snippet
  
  Figure 1: UI showing a single ArticleEntity within Recommendations cluster.
- EventEntity: EventEntity represents an event happening in the future. Event start time is a critical piece of information that needs to be conveyed to the users.
  
  Figure 2: UI showing a single EventEntity within Recommendations cluster.
- LodgingEntity: LodgingEntity represents an accommodation, such as a hotel, apartment, vacation home for short term and long term rental.
  
  Figure 3: UI showing a single LodgingEntity within Recommendations cluster.
- StoreEntity: StoreEntity represents a store, restaurant, cafe etc. It highlights content where a dining venue or store is the critical piece of information that needs to be conveyed to the users.
  
  Figure 4: UI showing a single StoreEntity within Recommendations cluster.
- PointOfInterestEntity: PointOfInterestEntity represents a place of interest like, a gas station, event venue, theme park, museum, tourist attraction, hiking trail etc. It highlights content where location is a critical piece of information that needs to be conveyed to the users. It shouldn't be used for lodging, a store or a dining venue.
  
  Figure 5: UI showing a single PointOfInterestEntity within Recommendations cluster.
- PersonEntity: PersonEntity represents a person. The recommendations could be to highlight a person in categories like health and fitness, sports, dating, etc.
  
  Figure 5: UI showing a single PersonEntity within Recommendations cluster.
The Continuation cluster shows content recently engaged by users from multiple developer partners in a single UI grouping. Each developer partner will be allowed to broadcast a maximum of 10 entities in the Continuation cluster.

Your continuation content can take the following structure:
- ArticleEntity: ArticleEntity that represents a text-based recommendation for content that is relevant to more than one category of content. This entity can be used to represent unfinished news articles or other content that the user would like to continue consuming from where they left it. Ex: Marketing content, News snippet
  
  Figure 6. UI showing a single ArticleEntity within a Continuation cluster.
- RestaurantReservationEntity: RestaurantReservationEntity represents a reservation for a restaurant or cafe and helps users track upcoming or ongoing restaurant reservations.
  
  Figure 7. UI showing a single RestaurantReservationEntity within a Continuation cluster.
- EventReservationEntity: EventReservationEntity represents a reservation for an event and helps users track upcoming or ongoing events reservations. Events could include, but not limited to the following:
  - Sports events like reservation for a football match
  - Gaming events like reservation for eSports
  - Entertainment events like reservation for movies in a cinema, concert, theater, book signing
  - Travel or point of interest reservations like guided tours, museum tickets
  - Social / Seminar / Conferences reservations
  - Education / Training sessions reservations
  Figure 8. UI showing a single EventReservationEntity within a Continuation cluster.
- LodgingReservationEntity: LodgingEntityReservation represents a reservation for a travel lodging and helps users track upcoming or ongoing hotel or vacation rental reservations.
  
  Figure 9. UI showing a single LodgingReservationEntity within a Continuation cluster.
- TransportationReservationEntity: TransportationReservationEntity represents a reservation for transportation by any mode and helps users track reservations for upcoming or ongoing flight, ferry, train, bus, ride-hailing, or cruise.
  
  Figure 10. UI showing a single TransportationReservationEntity within a Continuation cluster.
- VehicleRentalReservationEntity: VehicleRentalReservationEntity represents a vehicle rental reservation and helps users track upcoming or ongoing vehicle rental reservations.
  
  Figure 11. UI showing a single VehicleRentalReservationEntity within a Continuation cluster.
The Featured cluster is a UI view that showcases the chosen hero GenericFeaturedEntity from many developer partners in one UI grouping. There is a single Featured cluster, which is surfaced near the top of the UI, with a priority placement above all Recommendation clusters. Each developer partner is allowed to broadcast a single entity of a supported type in Featured, with many entities (potentially of different types) from multiple app developers in the Featured cluster.
- GenericFeaturedEntity: GenericFeaturedEntity differs from Recommendation item in that Featured item should be used for a single top content from developers and should represent the single most important content that will be interesting and relevant to users.
  
  Figure 12: UI showing a single hero GenericFeaturedEntity card within a Featured cluster

Pre-work

Minimum API level: 19

Add the com.google.android.engage:engage-core library to your app:

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

Summary

The design is based on an implementation of a bound service.

The data a client can publish is subject to the following limits for different cluster types:

Cluster type	Cluster limits	Minimum entity limits in a cluster	Maximum entity limits in a cluster
Recommendation Cluster(s)	At most 5	At least 5	At most 25 (`ArticleEntity`, `EventEntity`, `LodgingEntity`, `StoreEntity`, `PointOfInterestEntity`, or `PersonEntity`)
Continuation Cluster	At most 1	At least 1	At most 10 (`ArticleEntity`, `EventReservationEntity`, `LodgingReservationEntity`, `TransportationReservationEntity`, or `VehicleRentalReservationEntity`)
Featured Cluster	At most 1	At least 1	At most 10 (`GenericFeaturedEntity`)

Step 1: Provide entity data

The SDK has defined different entities to represent each item type. We support the following entities for the others category:

GenericFeaturedEntity
ArticleEntity
EventEntity
LodgingEntity
StoreEntity
PointOfInterestEntity
PersonEntity
RestaurantReservationEntity
EventReservationEntity
LodgingReservationEntity
TransportationReservationEntity
VehicleRentalReservationEntity

The charts below outline available attributes and requirements for each type.

`GenericFeaturedEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Poster images	Required	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
Title	Optional	Title of the entity.	Free text Recommended text size: 50 chars
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Badges	Optional	Each badge is either free text (max 15 chars) or small image. Special UX treatment on top of image/video, for example, as badge overlay on the image "Live update" Article read duration
Badge - Text	Optional	Title for the badge Note: Either text or image is required for the badge	Free text Recommended text size: max 15 chars
Badge - Image	Optional	Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge	See Image Specifications for guidance.
Content Categories	Optional	Describe the category of the content in the entity.	List of Enums See the Content Category section for guidance.

`ArticleEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	Free text Recommended text size: Max 50 chars
Poster images	Optional	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: Image is highly recommended. If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
Source - Title	Optional	The name of the author, organization, or reporter	Free text Recommended text size: Under 25 chars
Source - Image	Optional	An image of the source like the author, the organization, reporter	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Badges	Optional	Each badge is either free text (max 15 chars) or small image. Special UX treatment on top of image/video, for example as badge overlay on the image "Live update" Article read duration
Badge - Text	Optional	Title for the badge Note: Either text or image is required for the badge	Free text Recommended text size: max 15 chars
Badge - Image	Optional	Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge	See Image Specifications for guidance.
Content Publish Time	Optional	This is the epoch timestamp in milliseconds on when the content was published / updated in the app.	Epoch timestamp in milliseconds
Last Engagement Time	Conditionally Required	The epoch timestamp in milliseconds when the user interacted with this entity last time. Note: This field is required if this entity is part of the continuation cluster.	Epoch timestamp in milliseconds
Progress Percentage	Conditionally Required	The percentage of the full content consumed by the user to date. Note: This field is required if this entity is part of the continuation cluster.	An int value between 0~100 inclusive.
Content Categories	Optional	Describe the category of the content in the entity.	List of Enums See the Content Category section for guidance.

`EventEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	String Recommended text size: Max 50 chars
Start time	Required	The epoch timestamp when the event is expected to start. Note:This will be represented in milliseconds.	Epoch timestamp in milliseconds
Event mode	Required	A field to indicate whether the event will be virtual, in-person or both.	Enum: VIRTUAL, IN_PERSON, or HYBRID
Poster images	Required	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: Image is highly recommended. If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
Location - Country	Conditionally Required	The country in which the event is happening. Note: This is required for events which are IN_PERSON or HYBRID	Free text Recommended text size: max ~20 chars
Location - City	Conditionally Required	The city in which the event is happening. Note: This is required for events which are IN_PERSON or HYBRID	Free text Recommended text size: max ~20 chars
Location - Display Address	Conditionally Required	The address or venue name where the event will take place that should be displayed to the user. Note: This is required for events which are IN_PERSON or HYBRID	Free text Recommended text size: max ~20 chars
Location - Street Address	Optional	The street address (if applicable) of the location at which event is being hosted.	Free text Recommended text size: max ~20 chars
Location - State	Optional	The state or province (if applicable) in which the event is being hosted.	Free text Recommended text size: max ~20 chars
Location - Zip code	Optional	The zip code (if applicable) of the location in which the event is being hosted.	Free text Recommended text size: max ~20 chars
Location - Neighborhood	Optional	The neighborhood (if applicable) in which the event is being hosted.	Free text Recommended text size: max ~20 chars
End time	Optional	The epoch timestamp when the event is expected to end. Note:This will be represented in milliseconds.	Epoch timestamp in milliseconds
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Badges	Optional	Each badge is either free text (max 15 chars) or small image.
Badge - Text	Optional	Title for the badge Note: Either text or image is required for the badge	Free text Recommended text size: max 15 chars
Badge - Image	Optional	Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge	See Image Specifications for guidance.
Price - CurrentPrice	Conditionally required	The current price of the ticket/pass for the event. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Optional	The original price of the ticket/pass for the event.	Free text
Price Callout	Optional	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Content Categories	Optional	Describe the category of the content in the entity.	List of Eligible Enums TYPE_MOVIES_AND_TV_SHOWS (Example - Cinema) TYPE_DIGITAL_GAMES (Example - eSports) TYPE_MUSIC (Example - Concert) TYPE_TRAVEL_AND_LOCAL (Example - Tour, festival) TYPE_HEALTH_AND_FITENESS (Example - Yoga class) TYPE_EDUCATION (Example - Class) TYPE_SPORTS (Example - Football game) TYPE_DATING (Example - meetup) See the Content Category section for guidance.

`LodgingEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	String Recommended text size: Max 50 chars
Poster images	Required	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
Location - Country	Required	The country in which the lodging is happening.	Free text Recommended text size: max ~20 chars
Location - City	Required	The city in which the lodging is happening.	Free text Recommended text size: max ~20 chars
Location - Display Address	Required	The address of the lodging that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Location - Street Address	Optional	The street address (if applicable) of the lodging.	Free text Recommended text size: max ~20 chars
Location - State	Optional	The state or province (if applicable) in which the lodging is located.	Free text Recommended text size: max ~20 chars
Location - Zip code	Optional	The zip code (if applicable) of the lodging.	Free text Recommended text size: max ~20 chars
Location - Neighborhood	Optional	The neighborhood (if applicable) of the lodging.	Free text Recommended text size: max ~20 chars
Badges	Optional	Each badge is either free text (max 15 chars) or small image.
Badge - Text	Optional	Title for the badge Note: Either text or image is required for the badge	Free text Recommended text size: max 15 chars
Badge - Image	Optional	Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
AvailabilityTimeWindow - Start Time	Optional	The epoch timestamp in milliseconds when the lodging is expected to be open/available.	Epoch timestamp in milliseconds
AvailabilityTimeWindow - End Time	Optional	The epoch timestamp in milliseconds until which the lodging is expected to be open/available.	Epoch timestamp in milliseconds
Rating - Max value	Optional	The maximum value of the rating scale. Must be provided if current value of rating is also provided.	Number >= 0.0
Rating - Current value	Optional	The current value of the rating scale. Must be provided if maximum value of rating is also provided.	Number >= 0.0
Rating - Count	Optional	The count of the ratings for the lodging. Note: Provide this field if your app controls how the count is displayed to the users. Use a concise string. For example, if the count is 1,000,000, consider using an abbreviation like 1M so that the count isn't truncated on smaller display sizes.	String
Rating - Count Value	Optional	The count of the ratings for the lodging. Note: Provide this field if you aren't handling the display abbreviation logic yourself. If both Count and Count Value are present, Count is displayed to users.	Long
Price - CurrentPrice	Conditionally required	The current price of the lodging. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Optional	The original price of the lodging, which is be struck-through in the UI.	Free text
Price Callout	Optional	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)

`StoreEntity`

The StoreEntity object represents an individual store that developer partners want to publish, such as a restaurant or a grocery store.

Attribute	Requirement	Description	Format
Poster images	Required	At least one image must be provided.	See Image Specifications for guidance.
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Optional	The name of the store.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Location	Optional	The location of the store.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Callout	Optional	Callout to feature a promo, event, or update for the store, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Callout fine print	Optional	Fine print text for the callout.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Description	Optional	A description of the store.	Free text Recommended text size: under 90 chars (Text that is too long may show ellipses)
Rating - Max value	Optional	The maximum value of the rating scale. Must be provided if current value of rating is also provided.	Number >= 0.0
Rating - Current value	Optional	The current value of the rating scale. Must be provided if maximum value of rating is also provided.	Number >= 0.0
Rating - Count	Optional	The count of the ratings for the lodging. Note: Provide this field if your app wants to control how this is displayed to the users. Provide the concise string that can be displayed to the user. For example, if the count is 1,000,000, consider using abbreviations like 1M, so that it won't be truncated on smaller display sizes.	String
Rating - Count Value	Optional	The count of the ratings for the lodging. Note: Provide this field if you don't want to handle the display abbreviation logic yourself. If both Count and Count Value are present, we will use the Count to display to users	Long

`PointOfInterestEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	String Recommended text size: Max 50 chars
Poster images	Required	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: Image is highly recommended. If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
Location - Country	Required	The country in which the point of interest is happening.	Free text Recommended text size: max ~20 chars
Location - City	Required	The city in which the point of interest is happening.	Free text Recommended text size: max ~20 chars
Location - Display Address	Required	The address of the point of interest that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Location - Street Address	Optional	The street address (if applicable) of the point of interest.	Free text Recommended text size: max ~20 chars
Location - State	Optional	The state or province (if applicable) in which the point of interest is located.	Free text Recommended text size: max ~20 chars
Location - Zip code	Optional	The zip code (if applicable) of the point of interest.	Free text Recommended text size: max ~20 chars
Location - Neighborhood	Optional	The neighborhood (if applicable) of the point of interest.	Free text Recommended text size: max ~20 chars
AvailabilityTimeWindow - Start Time	Optional	The epoch timestamp in milliseconds when the point of interest is expected to be open/available.	Epoch timestamp in milliseconds
AvailabilityTimeWindow - End Time	Optional	The epoch timestamp in milliseconds until which the point of interest is expected to be open/available.	Epoch timestamp in milliseconds
Badges	Optional	Each badge is either free text (max 15 chars) or small image.
Badge - Text	Optional	Title for the badge Note: Either text or image is required for the badge	Free text Recommended text size: max 15 chars
Badge - Image	Optional	Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Rating - Max value	Optional	The maximum value of the rating scale. Must be provided if current value of rating is also provided.	Number >= 0.0
Rating - Current value	Optional	The current value of the rating scale. Must be provided if maximum value of rating is also provided.	Number >= 0.0
Rating - Count	Optional	The count of the ratings for the point of interest. Note: Provide this field if your app controls how the count is displayed to the users. Use a concise string. For example, if the count is 1,000,000, consider using an abbreviation like 1M so that the count isn't truncated on smaller display sizes.	String
Rating - Count Value	Optional	The count of the ratings for the point of interest. Note: Provide this field if you aren't handling display abbreviation logic yourself. If both Count and Count Value are present, Count is displayed to users	Long
Price - CurrentPrice	Conditionally required	The current price of the tickets/entry pass for the point of interest. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Optional	The original price of the tickets/entry pass for the point of interest.	Free text
Price Callout	Optional	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Content Categories	Optional	Describe the category of the content in the entity.	List of Eligible Enums TYPE_TRAVEL_AND_LOCAL TYPE_MOVIES_AND_TV_SHOWS (Example - theater) TYPE_MEDICAL (Example - hospital) TYPE_EDUCATION (Example - school) TYPE_SPORTS (Example - stadium) See the Content Category section for guidance.

`PersonEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Profile - Name	Required	Profile name or id or handle, eg "John Doe", "@TeamPixel", etc.	String Recommended text size: Max 50 chars
Profile - Avatar	Required	Profile picture or avatar image of the user. Note:Must be Square 1:1 image.	See Image Specifications for guidance.
Profile - Additional Text	Optional	Free text like the profile handle.	Free text Recommended text size: Max 15 chars
Profile - Additional Image	Optional	Small image like a verified badge.	See Image Specifications for guidance.
Header image	Optional	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: Image is highly recommended. If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
Popularity - Count	Optional	Indicate the number of followers or popularity value, for example - "3.7 M". Note: If both Count and Count Value are provided, Count will be used	String Recommended text size: max 20 chars for count + label combined
Popularity - Count Value	Optional	The number of followers or popularity value. Note: Provide Count Value if your app doesn't want to handle logic on how a large number should be optimized for different display sizes. If both Count and Count Value are provided, Count will be used.	Long
Popularity - Label	Optional	Indicate what the popularity label is. For example - "Likes".	String Recommended text size: Max 20 chars for count + label combined
Popularity - Visual	Optional	Indicate what the interaction is for. For example - Image showing Likes icon, Emojis. Can provide more than 1 image, though not all may not be shown on all form factors. Note: Must be Square 1:1 image	See Image Specifications for guidance.
Rating - Max value	Required	The maximum value of the rating scale. Must be provided if current value of rating is also provided.	Number >= 0.0
Rating - Current value	Required	The current value of the rating scale. Must be provided if maximum value of rating is also provided.	Number >= 0.0
Rating - Count	Optional	The count of the ratings for the entity. Note: Provide this field if your app wants to control how this is displayed to the users. Provide the concise string that can be displayed to the user. For example, if the count is 1,000,000, consider using abbreviations like 1M, so that it won't be truncated on smaller display sizes.	String
Rating - Count Value	Optional	The count of the ratings for the entity. Note: Provide this field if you don't want to handle the display abbreviation logic yourself. If both Count and Count Value are present, we will use the Count to display to users	Long
Location - Country	Optional	The country where the person is located or serving.	Free text Recommended text size: max ~20 chars
Location - City	Optional	The city where the person is located or serving.	Free text Recommended text size: max ~20 chars
Location - Display Address	Optional	The address where the person is located or serving will be displayed to the user.	Free text Recommended text size: max ~20 chars
Location - Street Address	Optional	The street address (if applicable) where the person is located or serving.	Free text Recommended text size: max ~20 chars
Location - State	Optional	The state (if applicable) where the person is located or serving.	Free text Recommended text size: max ~20 chars
Location - Zip code	Optional	The zip code (if applicable) where the person is located or serving.	Free text Recommended text size: max ~20 chars
Location - Neighborhood	Optional	The neighborhood (if applicable) where the person is located or serving.	Free text Recommended text size: max ~20 chars
Badges	Optional	Each badge is either free text (max 15 chars) or small image.
Badge - Text	Optional	Title for the badge Note: Either text or image is required for the badge	Free text Recommended text size: max 15 chars
Badge - Image	Optional	Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Content Categories	Optional	Describe the category of the content in the entity.	List of Eligible Enums TYPE_HEALTH_AND_FITENESS (Example - Yoga/fitness trainer) TYPE_HOME_AND_AUTO (Example - Plumber) TYPE_SPORTS (Example - Player) TYPE_DATING See the Content Category section for guidance.

`RestaurantReservationEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	String Recommended text size: Max 50 chars
Reservation Start Time	Required	The epoch timestamp in milliseconds when the reservation is expected to start.	Epoch timestamp in milliseconds
Location - Country	Required	The country in which the restaurant is happening.	Free text Recommended text size: max ~20 chars
Location - City	Required	The city in which the restaurant is happening.	Free text Recommended text size: max ~20 chars
Location - Display Address	Required	The address of the prestaurant that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Location - Street Address	Optional	The street address (if applicable) of the restaurant.	Free text Recommended text size: max ~20 chars
Location - State	Optional	The state or province (if applicable) in which the restaurant is located.	Free text Recommended text size: max ~20 chars
Location - Zip code	Optional	The zip code (if applicable) of the restaurant.	Free text Recommended text size: max ~20 chars
Location - Neighborhood	Optional	The neighborhood (if applicable) of the restaurant.	Free text Recommended text size: max ~20 chars
Poster images	Optional	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Table Size	Optional	The number of people in the reservation group	Integer > 0

`EventReservationEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	String Recommended text size: Max 50 chars
Start time	Required	The epoch timestamp when the event is expected to start. Note:This will be represented in milliseconds.	Epoch timestamp in milliseconds
Event mode	Required	A field to indicate whether the event will be virtual, in-person or both.	Enum: VIRTUAL, IN_PERSON, or HYBRID
Location - Country	Conditionally Required	The country in which the event is happening. Note: This is required for events which are IN_PERSON or HYBRID	Free text Recommended text size: max ~20 chars
Location - City	Conditionally Required	The city in which the event is happening. Note: This is required for events which are IN_PERSON or HYBRID	Free text Recommended text size: max ~20 chars
Location - Display Address	Conditionally Required	The address or venue name where the event will take place that should be displayed to the user. Note: This is required for events which are IN_PERSON or HYBRID	Free text Recommended text size: max ~20 chars
Location - Street Address	Optional	The street address (if applicable) of the location at which event is being hosted.	Free text Recommended text size: max ~20 chars
Location - State	Optional	The state or province (if applicable) in which the event is being hosted.	Free text Recommended text size: max ~20 chars
Location - Zip code	Optional	The zip code (if applicable) of the location in which the event is being hosted.	Free text Recommended text size: max ~20 chars
Location - Neighborhood	Optional	The neighborhood (if applicable) in which the event is being hosted.	Free text Recommended text size: max ~20 chars
Poster images	Optional	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: Image is highly recommended. If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
End time	Optional	The epoch timestamp when the event is expected to end. Note:This will be represented in milliseconds.	Epoch timestamp in milliseconds
Service Provider - Name	Optional	The name of the service provider. Note:Either text or image is required for the service provider.	Free text. For example, name of the event organizer/tour
Service Provider - Image	Optional	The logo/image of the service provider. Note:Either text or image is required for the service provider.	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Badges	Optional	Each badge is either free text (max 15 chars) or small image.
Badge - Text	Optional	Title for the badge Note: Either text or image is required for the badge	Free text Recommended text size: max 15 chars
Badge - Image	Optional	Small image Special UX treatment, for example as badge overlay on the image/video thumbnail. Note: Either text or image is required for the badge	See Image Specifications for guidance.
Reservation ID	Optional	The reservation ID for the event reservation.	Free text
Price - CurrentPrice	Conditionally required	The current price of the ticket/pass for the event. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Optional	The original price of the ticket/pass for the event.	Free text
Price Callout	Optional	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Rating - Max value	Optional	The maximum value of the rating scale. Must be provided if current value of rating is also provided.	Number >= 0.0
Rating - Current value	Optional	The current value of the rating scale. Must be provided if maximum value of rating is also provided.	Number >= 0.0
Rating - Count	Optional	The count of the ratings for the event. Note: Provide this field if your app wants to control how this is displayed to the users. Provide the concise string that can be displayed to the user. For example, if the count is 1,000,000, consider using abbreviations like 1M, so that it won't be truncated on smaller display sizes.	String
Rating - Count Value	Optional	The count of the ratings for the event. Note: Provide this field if you don't want to handle the display abbreviation logic yourself. If both Count and Count Value are present, we will use the Count to display to users	Long
Content Categories	Optional	Describe the category of the content in the entity.	List of Eligible Enums TYPE_MOVIES_AND_TV_SHOWS (Example - Cinema) TYPE_DIGITAL_GAMES (Example - eSports) TYPE_MUSIC (Example - Concert) TYPE_TRAVEL_AND_LOCAL (Example - Tour, festival) TYPE_HEALTH_AND_FITENESS (Example - Yoga class) TYPE_EDUCATION (Example - Class) TYPE_SPORTS (Example - Football game) TYPE_DATING (Example - meetup) See the Content Category section for guidance.

`LodgingReservationEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	Free text. For example, "Your Stay from Dec 12th" Recommended text size: Max 50 chars
Check-in Time	Required	The epoch timestamp in milliseconds that represents the check in time for the reservation.	Epoch timestamp in milliseconds
Check-out Time	Required	The epoch timestamp in milliseconds that represents the check out time for the reservation.	Epoch timestamp in milliseconds
Location - Country	Required	The country in which the lodging is located.	Free text Recommended text size: max ~20 chars
Location - City	Required	The city in which the lodging is located.	Free text Recommended text size: max ~20 chars
Location - Display Address	Required	The address of the lodging that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Location - Street Address	Optional	The street address (if applicable) of the lodging.	Free text Recommended text size: max ~20 chars
Location - State	Optional	The state or province (if applicable) in which the lodging is located.	Free text Recommended text size: max ~20 chars
Location - Zip code	Optional	The zip code (if applicable) of the lodging.	Free text Recommended text size: max ~20 chars
Location - Neighborhood	Optional	The neighborhood (if applicable) of the lodging.	Free text Recommended text size: max ~20 chars
Poster images	Optional	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9 Note: If a badge is provided, ensure safe space of 24 dps at both the top and bottom of the image	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Reservation ID	Optional	The reservation ID for the lodging reservation.	Free text
Rating - Max value	Optional	The maximum value of the rating scale. Must be provided if current value of rating is also provided.	Number >= 0.0
Rating - Current value	Optional	The current value of the rating scale. Must be provided if maximum value of rating is also provided.	Number >= 0.0
Rating - Count	Optional	The count of the ratings for the lodging. Note: Provide this field if your app wants to control how this is displayed to the users. Provide the concise string that can be displayed to the user. For example, if the count is 1,000,000, consider using abbreviations like 1M, so that it won't be truncated on smaller display sizes.	String
Rating - Count Value	Optional	The count of the ratings for the lodging. Note: Provide this field if you don't want to handle the display abbreviation logic yourself. If both Count and Count Value are present, we will use the Count to display to users	Long
Price - CurrentPrice	Conditionally required	The current price of the lodging. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Optional	The original price of the lodging, which is be struck-through in the UI.	Free text
Price Callout	Optional	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)

`TransportationReservationEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	Free text. For example, "SFO to SAN" Recommended text size: Max 50 chars
Transportation Type	Required	The mode/type of transportation for the reservation.	Enum: FLIGHT, TRAIN, BUS, or FERRY
Departure Time	Required	The epoch timestamp in milliseconds that represents the departure time.	Epoch timestamp in milliseconds
Arrival Time	Required	The epoch timestamp in milliseconds that represents the arrival time.	Epoch timestamp in milliseconds
Departure Location - Country	Optional	The country of departure.	Free text Recommended text size: max ~20 chars
Departure Location - City	Optional	The city of departure.	Free text Recommended text size: max ~20 chars
Departure Location - Display Address	Optional	The location of departure that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Departure Location - Street Address	Optional	The street address (if applicable) of the departure location.	Free text Recommended text size: max ~20 chars
Departure Location - State	Optional	The state or province (if applicable) of the departure location.	Free text Recommended text size: max ~20 chars
Departure Location - Zip code	Optional	The zip code (if applicable) of the departure location.	Free text Recommended text size: max ~20 chars
Departure Location - Neighborhood	Optional	The neighborhood (if applicable) of the departure location.	Free text Recommended text size: max ~20 chars
Arrival Location - Country	Optional	The country of arrival.	Free text Recommended text size: max ~20 chars
Arrival Location - City	Optional	The city of arrival.	Free text Recommended text size: max ~20 chars
Arrival Location - Display Address	Optional	The location of arrival that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Arrival Location - Street Address	Optional	The street address (if applicable) of the arrival location.	Free text Recommended text size: max ~20 chars
Arrival Location - State	Optional	The state or province (if applicable) of the arrival location.	Free text Recommended text size: max ~20 chars
Arrival Location - Zip code	Optional	The zip code (if applicable) of the arrival location.	Free text Recommended text size: max ~20 chars
Arrival Location - Neighborhood	Optional	The neighborhood (if applicable) of the arrival location.	Free text Recommended text size: max ~20 chars
Service Provider - Name	Optional	The name of the service provider. Note:Either text or image is required for the service provider.	Free text. For example, Airline name
Service Provider - Image	Optional	The logo/image of the service provider. Note:Either text or image is required for the service provider.	See Image Specifications for guidance.
Poster images	Optional	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Reservation ID	Optional	The reservation ID for the transportation reservation.	Free text
Price - CurrentPrice	Conditionally required	The current price of the reservation. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Optional	The original price of the reservation, which is be struck-through in the UI.	Free text
Price Callout	Optional	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)
Transportation Number	Required	The flight number, bus number, train number, or ferry/cruise number.	Free text
Boarding Time	Required	The epoch timestamp that represents the boarding time for the reservation (if applicable)	Epoch timestamp in milliseconds

`VehicleRentalReservationEntity`

Attribute	Requirement	Description	Format
Action Uri	Required	Deep Link to the entity in the provider app. Note: You can use deep links for attribution. Refer to this FAQ	Uri
Title	Required	Title of the entity.	Free text. For example, "Avis Union Square SF" Recommended text size: Max 50 chars
Pickup Time	Required	The epoch timestamp that represents the pick up time for the reservation.	Epoch timestamp in milliseconds
Return Time	Optional	The epoch timestamp that represents the check out time for the reservation.	Epoch timestamp in milliseconds
Pickup Address - Country	Optional	The country of the pickup location.	Free text Recommended text size: max ~20 chars
Pickup Address - City	Optional	The city of the pickup location.	Free text Recommended text size: max ~20 chars
Pickup Address - Display Address	Optional	The pickup location that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Pickup Address - Street Address	Optional	The street address (if applicable) of the pickup location.	Free text Recommended text size: max ~20 chars
Pickup Address - State	Optional	The state or province (if applicable) of the pickup location.	Free text Recommended text size: max ~20 chars
Pickup Address - Zip code	Optional	The zip code (if applicable) of the pickup location.	Free text Recommended text size: max ~20 chars
Pickup Address - Neighborhood	Optional	The neighborhood (if applicable) of the pickup location.	Free text Recommended text size: max ~20 chars
Return Address - Country	Optional	The country of return location.	Free text Recommended text size: max ~20 chars
Return Address - City	Optional	The city of return location.	Free text Recommended text size: max ~20 chars
Return Address - Display Address	Optional	The return location that will be displayed to the user.	Free text Recommended text size: max ~20 chars
Return Address - Street Address	Optional	The street address (if applicable) of the return location.	Free text Recommended text size: max ~20 chars
Return Address - State	Optional	The state or province (if applicable) of the return location.	Free text Recommended text size: max ~20 chars
Return Address - Zip code	Optional	The zip code (if applicable) of the return location.	Free text Recommended text size: max ~20 chars
Return Address - Neighborhood	Optional	The neighborhood (if applicable) of the return location.	Free text Recommended text size: max ~20 chars
Service Provider - Name	Optional	The name of the service provider. Note:Either text or image is required for the service provider.	Free text. For example, "Avis Car Rental"
Service Provider - Image	Optional	The logo/image of the service provider. Note:Either text or image is required for the service provider.	See Image Specifications for guidance.
Poster images	Optional	We will show only 1 image when multiple images are provided. Recommended aspect ratio is 16:9	See Image Specifications for guidance.
Description	Optional	A single paragraph of text to describe the entity. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size: 180 chars
Subtitle list	Optional	Up to 3 subtitles, with each subtitle a single line of text. Note: Either description or subtitle list will be displayed to the user, not both.	Free text Recommended text size for each subtitle: max 50 chars
Confirmation ID	Optional	The confirmation ID for the vehicle rental reservation.	Free text
Price - CurrentPrice	Conditionally required	The current price of the reservation. Must be provided if strikethrough price is provided.	Free text
Price - StrikethroughPrice	Optional	The original price of the reservation, which is be struck-through in the UI.	Free text
Price Callout	Optional	Price callout to feature a promo, event, member discount, if available.	Free text Recommended text size: under 45 chars (Text that is too long may show ellipses)

Image specifications

Required specifications for image assets are listed in this table:

Aspect ratio	Minimum pixels	Recommended pixels
Square (1x1) Preferred	300x300	1200x1200
Landscape (1.91x1)	600x314	1200x628
Portrait (4x5)	480x600	960x1200

Aspect ratio

Minimum pixels

Recommended pixels

Square (1x1)

Preferred

300x300

1200x1200

Landscape (1.91x1)

600x314

1200x628

Portrait (4x5)

480x600

960x1200

The images are required to be hosted on public CDNs so that Google can access them.

File formats

PNG, JPG, static GIF, WebP

Maximum file size

5120 KB

Additional recommendations

Image safe area: Put your important content in the center 80% of the image.
Use a transparent background so that the image can be properly displayed in Dark and Light theme settings.

Content Category

The content category allows apps to publish content belonging to multiple categories. This maps the content with some of the predefined categories namely:

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

The images are required to be hosted on public CDNs so that Google can access them.

Guidelines to use the content categories

Some entities like ArticleEntity and GenericFeaturedEntity are eligible to use any of the content categories. For other entities like EventEntity, EventReservationEntity, PointOfInterestEntity, only a subset of these categories are eligible. Check the list of categories eligible for an entity type before populating the list.
Use the specific entity type for some content categories over a combination of the Generic entities and the ContentCategory:
- TYPE_MOVIES_AND_TV_SHOWS - Check out the entities from Watch integration guide before using the generic entities.
- TYPE_BOOKS - Check out the EbookEntity before using the generic entities.
- TYPE_AUDIOBOOKS - Check out AudiobookEntity before using the generic entities.
- TYPE_SHOPPING - Check out ShoppingEntity before using the generic entities.
- TYPE_FOOD_AND_DRINK - Check out entities from Food Integration guide before using the generic entities.
The ContentCategory field is optional and should be left blank if the content doesn't belong to any of the categories mentioned earlier.
In case multiple content categories are provided, provide them in the order of relevance to the content with the most relevant content category placed first in the list.

Step 2: Provide Cluster data

It is recommended to have the content publish job executed in the background (for example, using WorkManager) and scheduled on a regular basis or on an event basis (for example, every time the user opens the app or when the user just added something to their cart).

AppEngagePublishClient is responsible for publishing clusters.

There are following APIs to publish clusters in the client:

isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters

`isServiceAvailable`

This API is used to check if the service is available for integration and whether the content can be presented on the device.

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.
    }
});

`publishRecommendationClusters`

This API is used to publish a list of RecommendationCluster objects.

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());

When the service receives the request, the following actions take place within one transaction:

Existing RecommendationCluster data from the developer partner is removed.
Data from the request is parsed and stored in the updated Recommendation Cluster.

In case of an error, the entire request is rejected and the existing state is maintained.

`publishFeaturedCluster`

This API is used to publish a list of FeaturedCluster objects.

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());

When the service receives the request, the following actions take place within one transaction:

Existing FeaturedCluster data from the developer partner is removed.
Data from the request is parsed and stored in the updated Featured Cluster.

In case of an error, the entire request is rejected and the existing state is maintained.

`publishContinuationCluster`

This API is used to publish a ContinuationCluster object.

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());

When the service receives the request, the following actions take place within one transaction:

Existing ContinuationCluster data from the developer partner is removed.
Data from the request is parsed and stored in the updated Continuation Cluster.

In case of an error, the entire request is rejected and the existing state is maintained.

`publishUserAccountManagementRequest`

This API is used to publish a Sign In card . The signin action directs users to the app's sign in page so that the app can publish content (or provide more personalized content)

The following metadata is part of the Sign In Card -

Attribute	Requirement	Description
Action Uri	Required	Deeplink to Action (i.e. navigates to app sign in page)
Image	Optional - If not provided, Title must be provided	Image Shown on the Card 16x9 aspect ratio images with a resolution of 1264x712
Title	Optional - If not provided, Image must be provided	Title on the Card
Action Text	Optional	Text Shown on the CTA (i.e. Sign in)
Subtitle	Optional	Optional Subtitle on the Card

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());

When the service receives the request, the following actions take place within one transaction:

Existing UserAccountManagementCluster data from the developer partner is removed.
Data from the request is parsed and stored in the updated UserAccountManagementCluster Cluster.

In case of an error, the entire request is rejected and the existing state is maintained.

`updatePublishStatus`

If for any internal business reason, none of the clusters is published, we strongly recommend updating the publish status using the updatePublishStatus API. This is important because :

Providing the status in all scenarios, even when the content is published (STATUS == PUBLISHED), is critical to populate dashboards that use this explicit status to convey the health and other metrics of your integration.
If no content is published but the integration status isn't broken (STATUS == NOT_PUBLISHED), Google can avoid triggering alerts in the app health dashboards. It confirms that content is not published due to an expected situation from the provider's standpoint.
It helps developers provide insights into when the data is published versus not.
Google may use the status codes to nudge the user to do certain actions in the app so they can see the app content or overcome it.

The list of eligible publish status codes are :

// 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

If the content is not published due to a user not logged in, Google would recommend publishing the Sign In Card. If for any reason providers are not able to publish the Sign In Card then we recommend calling the updatePublishStatus API with the status code 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`

This API is used to delete the content of Recommendation Clusters.

Kotlin


client.deleteRecommendationClusters()

Java


client.deleteRecommendationClusters();

When the service receives the request, it removes the existing data from the Recommendation Clusters. In case of an error, the entire request is rejected and the existing state is maintained.

`deleteFeaturedCluster`

This API is used to delete the content of Featured Cluster.

Kotlin


client.deleteFeaturedCluster()

Java


client.deleteFeaturedCluster();

When the service receives the request, it removes the existing data from the Featured Cluster. In case of an error, the entire request is rejected and the existing state is maintained.

`deleteContinuationCluster`

This API is used to delete the content of Continuation Cluster.

Kotlin


client.deleteContinuationCluster()

Java


client.deleteContinuationCluster();

When the service receives the request, it removes the existing data from the Continuation Cluster. In case of an error, the entire request is rejected and the existing state is maintained.

`deleteUserManagementCluster`

This API is used to delete the content of UserAccountManagement Cluster.

Kotlin


client.deleteUserManagementCluster()

Java


client.deleteUserManagementCluster();

When the service receives the request, it removes the existing data from the UserAccountManagement Cluster. In case of an error, the entire request is rejected and the existing state is maintained.

`deleteClusters`

This API is used to delete the content of a given cluster type.

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());

When the service receives the request, it removes the existing data from all clusters matching the specified cluster types. Clients can choose to pass one or many cluster types. In case of an error, the entire request is rejected and the existing state is maintained.

Error handling

It is highly recommended to listen to the task result from the publish APIs such that a follow-up action can be taken to recover and resubmit an successful task.

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
                    }
                  }
                }
              });

The error is returned as an AppEngageException with the cause included as an error code.

Error code	Error name	Note
`1`	`SERVICE_NOT_FOUND`	The service is not available on the given device.
`2`	`SERVICE_NOT_AVAILABLE`	The service is available on the given device, but it is not available at the time of the call (for example, it is explicitly disabled).
`3`	`SERVICE_CALL_EXECUTION_FAILURE`	The task execution failed due to threading issues. In this case, it can be retried.
`4`	`SERVICE_CALL_PERMISSION_DENIED`	The caller is not allowed to make the service call.
`5`	`SERVICE_CALL_INVALID_ARGUMENT`	The request contains invalid data (for example, more than the allowed number of clusters).
`6`	`SERVICE_CALL_INTERNAL`	There is an error on the service side.
`7`	`SERVICE_CALL_RESOURCE_EXHAUSTED`	The service call is made too frequently.

Step 3: Handle broadcast intents

In addition to making publish content API calls through a job, it is also required to set up a BroadcastReceiver to receive the request for a content publish.

The goal of broadcast intents is mainly for app reactivation and forcing data sync. Broadcast intents are not designed to be sent very frequently. It is only triggered when the Engage Service determines the content might be stale (for example, a week old). That way, there is more confidence that the user can have a fresh content experience, even if the application has not been executed for a long period of time.

The BroadcastReceiver must be set up in the following two ways:

Dynamically register an instance of the BroadcastReceiver class using Context.registerReceiver(). This enables communication from applications that are still live in memory.

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));

}

Statically declare an implementation with the <receiver> tag in your AndroidManifest.xml file. This allows the application to receive broadcast intents when it is not running, and also allows the application to publish the content.

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

The following intents is sent by the service:

com.google.android.engage.action.PUBLISH_RECOMMENDATION It is recommended to start a publishRecommendationClusters call when receiving this intent.
com.google.android.engage.action.PUBLISH_FEATURED It is recommended to start a publishFeaturedCluster call when receiving this intent.
com.google.android.engage.action.PUBLISH_CONTINUATION It is recommended to start a publishContinuationCluster call when receiving this intent.

Integration workflow

For a step-by-step guide on verifying your integration after it is complete, see Engage developer integration workflow.

FAQs

See Engage SDK Frequently Asked Questions for FAQs.

Contact

Contact [email protected] if there are any questions during the integration process.

Next steps

After completing this integration, your next steps are as follows:

Send an email to [email protected] and attach your integrated APK that is ready for testing by Google.
Google performs a verification and reviews internally to make sure the integration works as expected. If changes are needed, Google contacts you with any necessary details.
When testing is complete and no changes are needed, Google contacts you to notify you that you can start publishing the updated and integrated APK to the Play Store.
After Google has confirmed that your updated APK has been published to the Play Store, your Recommendation, Featured, and Continuation clusters may be published and visible to users.