Engage SDK Health and Fitness: Hướng dẫn tích hợp kỹ thuật của bên thứ ba

Google đang xây dựng một nền tảng trên thiết bị giúp sắp xếp các ứng dụng của người dùng theo ngành dọc, đồng thời đem lại trải nghiệm mới mẻ và chân thực để người dùng khám phá và xem nội dung ứng dụng được cá nhân hoá. Trải nghiệm toàn màn hình này mang đến cho các đối tác nhà phát triển cơ hội giới thiệu nội dung đa dạng thức hay nhất của họ trên một kênh riêng bên ngoài ứng dụng của họ.Hướng dẫn này cung cấp cho các đối tác nhà phát triển hướng dẫn tích hợp nội dung về sức khoẻ và thể hình, bằng cách sử dụng Engage SDK để điền sẵn khu vực nền tảng mới này.

Thông tin chi tiết về quy trình tích hợp

Thuật ngữ

Quy trình tích hợp bao gồm 3 loại cụm sau: Đề xuất, Nổi bật và Tiếp tục.

• Cụm Đề xuất hiển thị các đề xuất về sức khoẻ và thể hình cho từng cá nhân từ từng đối tác nhà phát triển. Những đề xuất này có thể dành riêng cho từng người dùng hoặc cho tất cả người dùng (ví dụ: sức khoẻ và thể hình đang thịnh hành). Sử dụng các đối tượng này để hiển thị các bài viết hoặc những người liên quan đến sức khoẻ và thể hình.

  • Cụm Đề xuất có thể được tạo từ ArticleEntity, PersonEntity hoặc EventEntity, nhưng không thể kết hợp các loại thực thể khác nhau.

  Các đề xuất của bạn có cấu trúc sau:

  • Cụm Đề xuất: Khung hiển thị giao diện người dùng chứa một nhóm các đề xuất từ cùng một đối tác nhà phát triển.

  • Thực thể: Một đối tượng đại diện cho mỗi nội dung trong một cụm. Quy trình tích hợp này cung cấp một số thực thể sẽ xuất hiện bằng cụm Đề xuất:

    • ArticleEntity: ArticleEntity đề xuất cho nội dung dựa trên văn bản liên quan đến sức khoẻ và hoạt động thể dục. Bạn có thể sử dụng đối tượng này cho các bài viết, bài đăng trên blog, nội dung tiếp thị, đoạn trích tin tức, v.v.

      

      Hình 1: Giao diện người dùng cho thấy một ArticleEntity duy nhất trong cụm Đề xuất.

    • PersonEntity: PersonEntity đại diện cho một người. Nội dung đề xuất có thể là nêu bật một huấn luyện viên hoặc bất kỳ người nào liên quan đến sức khoẻ và thể hình, v.v.

      

      Hình 2: Giao diện người dùng cho thấy một PersonEntity duy nhất trong cụm Đề xuất.

    • EventEntity: EventEntity đại diện cho một sự kiện xảy ra trong tương lai. Thời gian bắt đầu sự kiện là một thông tin quan trọng cần truyền tải cho người dùng. Thực thể này có thể được dùng cho các sự kiện như cắm trại hiến máu, buổi tập luyện, phòng tập thể dục hoặc lớp học yoga, v.v. liên quan đến sức khoẻ và thể hình.

      

      Hình 3: Giao diện người dùng hiển thị một EventEntity duy nhất trong cụm Đề xuất.

• Cụm Tiếp tục hiển thị nội dung mà người dùng đã tương tác gần đây từ nhiều đối tác nhà phát triển trong một nhóm giao diện người dùng. Mỗi đối tác nhà phát triển sẽ được phép thông báo về tối đa 10 thực thể trong cụm Tiếp tục.

  Nội dung nối tiếp có thể có cấu trúc như sau:

  • ArticleEntity: ArticleEntity đề xuất cho nội dung dạng văn bản liên quan đến sức khoẻ và hoạt động thể dục. Thực thể này có thể được dùng để đại diện cho các tin bài đang xem dở hoặc nội dung khác mà người dùng muốn tiếp tục xem từ nơi họ đã dừng lại. Ví dụ: Đoạn trích tin tức, đoạn trích trên bài đăng trên blog về các chủ đề liên quan đến sức khoẻ hoặc thể hình.

    

    Hình 6. Giao diện người dùng cho thấy một ArticleEntity duy nhất trong một cụm Tiếp tục.

  • Event ReserveEntity: EventResetEntity đại diện để đặt trước cho một sự kiện và giúp người dùng theo dõi các yêu cầu đặt chỗ về sức khoẻ và hoạt động thể dục sắp tới hoặc đang diễn ra. Ví dụ: Phiên đào tạo

    

    Hình 8. Giao diện người dùng cho thấy một Event ReserveEntity duy nhất trong cụm Tiếp tục.

• Cụm Nổi bật là một khung hiển thị giao diện người dùng giới thiệu GenericFeaturedEntity chủ chốt được chọn từ nhiều đối tác nhà phát triển trong một nhóm giao diện người dùng. Có một cụm Nổi bật duy nhất xuất hiện gần đầu giao diện người dùng và có vị trí ưu tiên phía trên tất cả các cụm Đề xuất. Mỗi đối tác nhà phát triển được phép thông báo về một thực thể duy nhất thuộc một loại được hỗ trợ trong cụm Nổi bật, với nhiều thực thể (có thể thuộc nhiều loại) từ nhiều nhà phát triển ứng dụng trong cụm Nổi bật.

  • GenericFeatureEntity: GenericFeaturedEntity khác với mục Đề xuất ở chỗ Mục nổi bật phải được dùng cho một nội dung hàng đầu của các nhà phát triển và phải đại diện cho một nội dung quan trọng nhất và thú vị và phù hợp với người dùng.

    

    Hình 12: Giao diện người dùng hiển thị một thẻ GenericFeaturedEntity duy nhất trong một cụm Nổi bật

Chuẩn bị trước

Cấp độ API tối thiểu: 19

Thêm thư viện com.google.android.play:engage vào ứng dụng của bạn:

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

Tóm tắt

Thiết kế này dựa trên việc triển khai dịch vụ ràng buộc.

Dữ liệu mà ứng dụng có thể phát hành phải tuân theo các giới hạn sau cho các loại cụm khác nhau:

Loại cụm	Giới hạn về cụm	Giới hạn số lượng thực thể tối thiểu trong một cụm	Giới hạn số lượng thực thể tối đa trong một cụm
Cụm Đề xuất	Tối đa 5	Ít nhất là 5	Tối đa 25 (ArticleEntity, PersonEntity hoặc EventEntity)
Cụm Tiếp tục	Tối đa 1	Ít nhất 1	Tối đa 10 (ArticleEntity hoặc EventReservationEntity)
Cụm Nổi bật	Tối đa 1	Ít nhất 1	Tối đa 10 (GenericFeaturedEntity)

Bước 1: Cung cấp dữ liệu về thực thể

SDK đã xác định các thực thể khác nhau để đại diện cho từng loại nội dung. Chúng tôi hỗ trợ các thực thể sau cho danh mục Sức khoẻ và thể hình:

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

Các biểu đồ bên dưới nêu ra các thuộc tính hiện có và yêu cầu cho từng loại.

GenericFeaturedEntity

Thuộc tính	Yêu cầu	Nội dung mô tả	Định dạng
URI hành động	Bắt buộc	Đường liên kết sâu đến thực thể trong ứng dụng của nhà cung cấp. Lưu ý: Bạn có thể sử dụng đường liên kết sâu để phân bổ. Hãy tham khảo phần Câu hỏi thường gặp này	URI
Hình ảnh áp phích	Bắt buộc	Chúng tôi sẽ chỉ hiển thị 1 hình ảnh khi bạn cung cấp nhiều hình ảnh. Tỷ lệ khung hình đề xuất là 16:9 Lưu ý: Nếu có huy hiệu, hãy đảm bảo không gian an toàn là 24 dp ở cả phần đầu và cuối hình ảnh	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Tiêu đề	Không bắt buộc	Tiêu đề của thực thể.	Văn bản tự do Kích thước văn bản nên dùng: 50 ký tự
Nội dung mô tả	Không bắt buộc	Một đoạn văn bản để mô tả đối tượng. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng: 180 ký tự
Danh sách phụ đề	Không bắt buộc	Tối đa 3 phụ đề, mỗi phụ đề có một dòng văn bản. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng cho mỗi tiêu đề phụ: tối đa 50 ký tự
Huy hiệu	Không bắt buộc	Mỗi huy hiệu là văn bản tự do (tối đa 15 ký tự) hoặc hình ảnh nhỏ. Cách xử lý đặc biệt về trải nghiệm người dùng trên hình ảnh/video, chẳng hạn như lớp phủ huy hiệu trên hình ảnh Ví dụ: "Live update" (Cập nhật trực tiếp) Ví dụ: Thời lượng đọc bài viết
Huy hiệu - Văn bản	Không bắt buộc	Tiêu đề của huy hiệu Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Văn bản tự do Kích thước văn bản nên dùng: tối đa 15 ký tự
Huy hiệu - Hình ảnh	Không bắt buộc	Hình ảnh nhỏ Cách xử lý đặc biệt về trải nghiệm người dùng, chẳng hạn như lớp phủ huy hiệu trên hình thu nhỏ của hình ảnh/video. Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Danh mục nội dung	Không bắt buộc	Mô tả danh mục nội dung của đối tượng.	Danh sách Enum Hãy xem phần Danh mục nội dung để biết hướng dẫn.

ArticleEntity

Thuộc tính	Yêu cầu	Nội dung mô tả	Định dạng
URI hành động	Bắt buộc	Đường liên kết sâu đến thực thể trong ứng dụng của nhà cung cấp. Lưu ý: Bạn có thể sử dụng đường liên kết sâu để phân bổ. Hãy tham khảo phần Câu hỏi thường gặp này	URI
Tiêu đề	Bắt buộc	Tiêu đề của thực thể.	Văn bản tự do Kích thước văn bản nên dùng: Tối đa 50 ký tự
Hình ảnh áp phích	Không bắt buộc	Chúng tôi sẽ chỉ hiển thị 1 hình ảnh khi bạn cung cấp nhiều hình ảnh. Tỷ lệ khung hình đề xuất là 16:9 Lưu ý: Bạn nên sử dụng hình ảnh. Nếu bạn cung cấp huy hiệu, hãy đảm bảo không gian an toàn 24 dp ở cả phần đầu và cuối hình ảnh	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Nguồn – Tiêu đề	Không bắt buộc	Tên của tác giả, tổ chức hoặc phóng viên	Văn bản tự do Kích thước văn bản nên dùng: Dưới 25 ký tự
Nguồn – Hình ảnh	Không bắt buộc	Hình ảnh của nguồn tin, chẳng hạn như tác giả, tổ chức, phóng viên	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Nội dung mô tả	Không bắt buộc	Một đoạn văn bản để mô tả đối tượng. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng: 180 ký tự
Danh sách phụ đề	Không bắt buộc	Tối đa 3 phụ đề, mỗi phụ đề có một dòng văn bản. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng cho mỗi tiêu đề phụ: tối đa 50 ký tự
Huy hiệu	Không bắt buộc	Mỗi huy hiệu là văn bản tự do (tối đa 15 ký tự) hoặc hình ảnh nhỏ. Cách xử lý đặc biệt về trải nghiệm người dùng trên hình ảnh/video, chẳng hạn như lớp phủ huy hiệu trên hình ảnh Ví dụ: "Live update" (Cập nhật trực tiếp) Ví dụ: Thời lượng đọc bài viết
Huy hiệu - Văn bản	Không bắt buộc	Tiêu đề của huy hiệu Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Văn bản tự do Kích thước văn bản nên dùng: tối đa 15 ký tự
Huy hiệu - Hình ảnh	Không bắt buộc	Hình ảnh nhỏ Cách xử lý đặc biệt về trải nghiệm người dùng, chẳng hạn như lớp phủ huy hiệu trên hình thu nhỏ của hình ảnh/video. Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Thời gian xuất bản nội dung	Không bắt buộc	Đây là dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) khi nội dung được xuất bản / cập nhật trong ứng dụng.	Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Thời gian tương tác gần đây nhất	Bắt buộc có điều kiện	Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) khi người dùng tương tác với thực thể này vào lần gần đây nhất. Lưu ý: Bạn bắt buộc phải sử dụng trường này nếu thực thể này thuộc cụm tiếp tục.	Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Tỷ lệ phần trăm tiến trình	Bắt buộc có điều kiện	Tỷ lệ phần trăm toàn bộ nội dung mà người dùng đã xem cho đến nay. Lưu ý: Bạn bắt buộc phải sử dụng trường này nếu thực thể này thuộc cụm tiếp tục.	Một giá trị int nằm trong khoảng từ 0 đến 100.
Danh mục nội dung	Không bắt buộc	Mô tả danh mục nội dung của đối tượng.	Danh sách Enum Hãy xem phần Danh mục nội dung để biết hướng dẫn.

PersonEntity

Thuộc tính	Yêu cầu	Nội dung mô tả	Định dạng
URI hành động	Bắt buộc	Đường liên kết sâu đến thực thể trong ứng dụng của nhà cung cấp. Lưu ý: Bạn có thể sử dụng đường liên kết sâu để phân bổ. Hãy tham khảo phần Câu hỏi thường gặp này	URI
Hồ sơ - Tên	Bắt buộc	Tên trên hồ sơ/tên nhận dạng hoặc tên người dùng, ví dụ: "John Doe", "@TeamPixel", v.v.	Chuỗi Kích thước văn bản nên dùng: Tối đa 50 ký tự
Hồ sơ – Hình đại diện	Bắt buộc	Ảnh hồ sơ hoặc hình đại diện của người dùng. Lưu ý: Phải là ảnh vuông có tỷ lệ 1:1.	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Hồ sơ – Văn bản bổ sung	Không bắt buộc	Văn bản tự do, chẳng hạn như tên người dùng hồ sơ.	Văn bản tự do Kích thước văn bản nên dùng: Tối đa 15 ký tự
Hồ sơ - Hình ảnh bổ sung	Không bắt buộc	Hình ảnh nhỏ như huy hiệu xác minh.	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Hình ảnh tiêu đề	Không bắt buộc	Chúng tôi sẽ chỉ hiển thị 1 hình ảnh khi bạn cung cấp nhiều hình ảnh. Tỷ lệ khung hình đề xuất là 16:9 Lưu ý: Bạn nên sử dụng hình ảnh. Nếu bạn cung cấp huy hiệu, hãy đảm bảo không gian an toàn 24 dp ở cả phần đầu và cuối hình ảnh	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mức độ phổ biến – Số lượng	Không bắt buộc	Đại diện cho hình ảnh Tiêu đề. Phải khác với ảnh hồ sơ. Cách này có thể dùng nếu có hình ảnh bổ sung giúp làm nổi bật một người giống như tác phẩm của họ. Lưu ý: Phải là hình ảnh có tỷ lệ 16:9. Nếu bạn cung cấp huy hiệu, hãy đảm bảo không gian an toàn 24 dp ở cả phần đầu và cuối hình ảnh	Chuỗi Kích thước văn bản nên dùng: Tối đa 20 ký tự cho cả số lượt và nhãn
Mức độ phổ biến – Số lượng giá trị	Không bắt buộc	Số lượng người theo dõi hoặc giá trị về mức độ phổ biến. Lưu ý: Hãy cung cấp giá trị đếm nếu ứng dụng của bạn không muốn xử lý logic về cách tối ưu hoá một số lớn cho nhiều kích thước màn hình. Nếu bạn cung cấp cả giá trị Đếm và Giá trị đếm, thì Đếm sẽ được sử dụng.	Dài
Mức độ phổ biến - Nhãn	Không bắt buộc	Cho biết nhãn mức độ phổ biến là gì. Ví dụ: "Thích".	Chuỗi Kích thước văn bản nên dùng: Tối đa 20 ký tự cho cả số lượt và nhãn
Mức độ phổ biến – Hình ảnh	Không bắt buộc	Cho biết mục đích tương tác. Ví dụ: Hình ảnh biểu tượng Thích, Biểu tượng cảm xúc. Có thể cung cấp nhiều hình ảnh, mặc dù không phải hình ảnh nào cũng hiện được trên mọi hệ số hình dạng. Lưu ý: Phải là ảnh hình vuông có tỷ lệ 1:1	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Điểm xếp hạng – Giá trị tối đa	Bắt buộc	Giá trị tối đa của thang điểm xếp hạng. Phải cung cấp nếu bạn cũng cung cấp giá trị hiện tại của điểm xếp hạng.	Số >= 0,0
Điểm xếp hạng – Giá trị hiện tại	Bắt buộc	Giá trị hiện tại của thang điểm xếp hạng. Phải cung cấp nếu bạn cũng cung cấp giá trị tối đa của điểm xếp hạng.	Số >= 0,0
Điểm xếp hạng – Tổng số	Không bắt buộc	Tổng số điểm xếp hạng cho thực thể. Lưu ý: Hãy cung cấp trường này nếu ứng dụng của bạn muốn kiểm soát cách trường này hiển thị với người dùng. Vui lòng cung cấp chuỗi ngắn gọn mà người dùng có thể thấy. Ví dụ: nếu số lượng là 1.000.000, hãy cân nhắc dùng các chữ viết tắt như 1 triệu để không bị cắt bớt trên màn hình có kích thước nhỏ hơn.	Chuỗi
Điểm xếp hạng – Giá trị tổng số	Không bắt buộc	Tổng số điểm xếp hạng cho thực thể. Lưu ý: Hãy cung cấp trường này nếu bạn không muốn tự xử lý logic viết tắt hiển thị. Nếu có cả giá trị Đếm và Giá trị đếm, chúng ta sẽ dùng Đếm để hiển thị cho người dùng	Dài
Vị trí – Quốc gia	Không bắt buộc	Quốc gia nơi người đó sinh sống hoặc phục vụ.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Thành phố	Không bắt buộc	Thành phố nơi người đó sinh sống hoặc phục vụ.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí - Địa chỉ hiển thị	Không bắt buộc	Địa chỉ nơi người đó ở hoặc đang phục vụ sẽ hiển thị cho người dùng.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Địa chỉ đường phố	Không bắt buộc	Địa chỉ đường phố (nếu có) nơi người đó ở hoặc phục vụ.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Tiểu bang	Không bắt buộc	Tiểu bang (nếu có) nơi người đó ở hoặc đang hoạt động.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Mã bưu chính	Không bắt buộc	Mã bưu chính (nếu có) nơi người đó sinh sống hoặc phục vụ.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí - Vùng lân cận	Không bắt buộc	Vùng lân cận (nếu có) nơi người đó ở hoặc đang phục vụ.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Huy hiệu	Không bắt buộc	Mỗi huy hiệu là văn bản tự do (tối đa 15 ký tự) hoặc hình ảnh nhỏ.
Huy hiệu - Văn bản	Không bắt buộc	Tiêu đề của huy hiệu Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Văn bản tự do Kích thước văn bản nên dùng: tối đa 15 ký tự
Huy hiệu - Hình ảnh	Không bắt buộc	Hình ảnh nhỏ Cách xử lý đặc biệt về trải nghiệm người dùng, chẳng hạn như lớp phủ huy hiệu trên hình thu nhỏ của hình ảnh/video. Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Nội dung mô tả	Không bắt buộc	Một đoạn văn bản để mô tả đối tượng. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng: 180 ký tự
Danh sách phụ đề	Không bắt buộc	Tối đa 3 phụ đề, mỗi phụ đề có một dòng văn bản. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng cho mỗi tiêu đề phụ: tối đa 50 ký tự
Danh mục nội dung	Không bắt buộc	Mô tả danh mục nội dung của đối tượng.	Danh sách Enum đủ điều kiện TYPE_HEALTH_AND_FITENESS (Ví dụ: Huấn luyện viên yoga/thể dục) TYPE_HOME_AND_auto (Ví dụ: Thợ sửa ống nước) TYPE_SPORTS (Ví dụ: Trình phát) TYPE_DATING Hãy xem phần Danh mục nội dung để biết hướng dẫn.

EventEntity

Thuộc tính	Yêu cầu	Nội dung mô tả	Định dạng
URI hành động	Bắt buộc	Đường liên kết sâu đến thực thể trong ứng dụng của nhà cung cấp. Lưu ý: Bạn có thể sử dụng đường liên kết sâu để phân bổ. Hãy tham khảo phần Câu hỏi thường gặp này	URI
Tiêu đề	Bắt buộc	Tiêu đề của thực thể.	Chuỗi Kích thước văn bản nên dùng: Tối đa 50 ký tự
Thời gian bắt đầu	Bắt buộc	Dấu thời gian bắt đầu của hệ thống khi sự kiện dự kiến bắt đầu. Lưu ý: Tham số này sẽ được biểu thị bằng mili giây.	Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Chế độ sự kiện	Bắt buộc	Một trường để cho biết sự kiện sẽ diễn ra trên mạng, trực tiếp hay cả hai.	Enum: VIRTUAL, IN_PERSON hoặc HYBRID
Hình ảnh áp phích	Bắt buộc	Chúng tôi sẽ chỉ hiển thị 1 hình ảnh khi bạn cung cấp nhiều hình ảnh. Tỷ lệ khung hình đề xuất là 16:9 Lưu ý: Bạn nên sử dụng hình ảnh. Nếu bạn cung cấp huy hiệu, hãy đảm bảo không gian an toàn 24 dp ở cả phần đầu và cuối hình ảnh	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Vị trí – Quốc gia	Bắt buộc có điều kiện	Quốc gia nơi sự kiện đang diễn ra. Lưu ý: Đây là yêu cầu bắt buộc cho các sự kiện IN_PERSON hoặc HYBRID	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Thành phố	Bắt buộc có điều kiện	Thành phố nơi sự kiện đang diễn ra. Lưu ý: Đây là yêu cầu bắt buộc cho các sự kiện IN_PERSON hoặc HYBRID	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí - Địa chỉ hiển thị	Bắt buộc có điều kiện	Địa chỉ hoặc tên địa điểm nơi sự kiện sẽ diễn ra phải được hiển thị cho người dùng. Lưu ý: Đây là yêu cầu bắt buộc cho các sự kiện IN_PERSON hoặc HYBRID	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Địa chỉ đường phố	Không bắt buộc	Địa chỉ đường phố (nếu có) của địa điểm tổ chức sự kiện.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Tiểu bang	Không bắt buộc	Tiểu bang hoặc tỉnh (nếu có) nơi tổ chức sự kiện.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Mã bưu chính	Không bắt buộc	Mã bưu chính (nếu có) của địa điểm tổ chức sự kiện.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí - Vùng lân cận	Không bắt buộc	Vùng lân cận (nếu có) nơi sự kiện đang được tổ chức.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Thời gian kết thúc	Không bắt buộc	Dấu thời gian bắt đầu của hệ thống khi sự kiện dự kiến sẽ kết thúc. Lưu ý: Tham số này sẽ được biểu thị bằng mili giây.	Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Nội dung mô tả	Không bắt buộc	Một đoạn văn bản để mô tả đối tượng. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng: 180 ký tự
Danh sách phụ đề	Không bắt buộc	Tối đa 3 phụ đề, mỗi phụ đề có một dòng văn bản. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng cho mỗi tiêu đề phụ: tối đa 50 ký tự
Huy hiệu	Không bắt buộc	Mỗi huy hiệu là văn bản tự do (tối đa 15 ký tự) hoặc hình ảnh nhỏ.
Huy hiệu - Văn bản	Không bắt buộc	Tiêu đề của huy hiệu Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Văn bản tự do Kích thước văn bản nên dùng: tối đa 15 ký tự
Huy hiệu - Hình ảnh	Không bắt buộc	Hình ảnh nhỏ Cách xử lý đặc biệt về trải nghiệm người dùng, chẳng hạn như lớp phủ huy hiệu trên hình thu nhỏ của hình ảnh/video. Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Giá – Giá hiện tại	Bắt buộc trong một số điều kiện	Giá hiện tại của vé/vé tham dự sự kiện. Bạn phải cung cấp nếu cung cấp giá gốc được gạch ngang.	Văn bản tự do
Giá - Giá gạch ngang	Không bắt buộc	Giá gốc của vé/vé tham dự sự kiện.	Văn bản tự do
Chú thích giá	Không bắt buộc	Chú thích giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu dành cho thành viên (nếu có).	Văn bản tự do Kích thước văn bản nên dùng: dưới 45 ký tự (Văn bản quá dài có thể hiển thị dấu ba chấm)
Danh mục nội dung	Không bắt buộc	Mô tả danh mục nội dung của đối tượng.	Danh sách Enum đủ điều kiện TYPE_MOVIES_AND_TV_SHOWS (Ví dụ: Rạp chiếu phim) TYPE_DIGITAL_GAMES (Ví dụ: Thể thao điện tử) TYPE_MUSIC (Ví dụ: Buổi hoà nhạc) TYPE_CENTER_AND_LOCAL (Ví dụ: Tham quan, lễ hội) TYPE_HEALTH_AND_FITENESS (Ví dụ: lớp Yoga) TYPE_EDUCATION (Ví dụ: Lớp) TYPE_SPORTS (Ví dụ: Trò chơi bóng đá) TYPE_DATING (Ví dụ: buổi gặp mặt) Hãy xem phần Danh mục nội dung để biết hướng dẫn.

EventReservationEntity

Thuộc tính	Yêu cầu	Nội dung mô tả	Định dạng
URI hành động	Bắt buộc	Đường liên kết sâu đến thực thể trong ứng dụng của nhà cung cấp. Lưu ý: Bạn có thể sử dụng đường liên kết sâu để phân bổ. Hãy tham khảo phần Câu hỏi thường gặp này	URI
Tiêu đề	Bắt buộc	Tiêu đề của thực thể.	Chuỗi Kích thước văn bản nên dùng: Tối đa 50 ký tự
Thời gian bắt đầu	Bắt buộc	Dấu thời gian bắt đầu của hệ thống khi sự kiện dự kiến bắt đầu. Lưu ý: Tham số này sẽ được biểu thị bằng mili giây.	Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Chế độ sự kiện	Bắt buộc	Một trường để cho biết sự kiện sẽ diễn ra trên mạng, trực tiếp hay cả hai.	Enum: VIRTUAL, IN_PERSON hoặc HYBRID
Vị trí – Quốc gia	Bắt buộc có điều kiện	Quốc gia nơi sự kiện đang diễn ra. Lưu ý: Đây là yêu cầu bắt buộc cho các sự kiện IN_PERSON hoặc HYBRID	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Thành phố	Bắt buộc có điều kiện	Thành phố nơi sự kiện đang diễn ra. Lưu ý: Đây là yêu cầu bắt buộc cho các sự kiện IN_PERSON hoặc HYBRID	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí - Địa chỉ hiển thị	Bắt buộc có điều kiện	Địa chỉ hoặc tên địa điểm nơi sự kiện sẽ diễn ra phải được hiển thị cho người dùng. Lưu ý: Đây là yêu cầu bắt buộc cho các sự kiện IN_PERSON hoặc HYBRID	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Địa chỉ đường phố	Không bắt buộc	Địa chỉ đường phố (nếu có) của địa điểm tổ chức sự kiện.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Tiểu bang	Không bắt buộc	Tiểu bang hoặc tỉnh (nếu có) nơi tổ chức sự kiện.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí – Mã bưu chính	Không bắt buộc	Mã bưu chính (nếu có) của địa điểm tổ chức sự kiện.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Vị trí - Vùng lân cận	Không bắt buộc	Vùng lân cận (nếu có) nơi sự kiện đang được tổ chức.	Văn bản tự do Kích thước văn bản nên dùng: tối đa ~20 ký tự
Hình ảnh áp phích	Không bắt buộc	Chúng tôi sẽ chỉ hiển thị 1 hình ảnh khi bạn cung cấp nhiều hình ảnh. Tỷ lệ khung hình đề xuất là 16:9 Lưu ý: Bạn nên sử dụng hình ảnh. Nếu bạn cung cấp huy hiệu, hãy đảm bảo không gian an toàn 24 dp ở cả phần đầu và cuối hình ảnh	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Thời gian kết thúc	Không bắt buộc	Dấu thời gian bắt đầu của hệ thống khi sự kiện dự kiến sẽ kết thúc. Lưu ý: Tham số này sẽ được biểu thị bằng mili giây.	Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Nhà cung cấp dịch vụ – Tên	Không bắt buộc	Tên của nhà cung cấp dịch vụ. Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho nhà cung cấp dịch vụ.	Văn bản tự do. Ví dụ: Tên của người tổ chức/chuyến tham quan sự kiện
Nhà cung cấp dịch vụ – Hình ảnh	Không bắt buộc	Biểu trưng/hình ảnh của nhà cung cấp dịch vụ. Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho nhà cung cấp dịch vụ.	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Nội dung mô tả	Không bắt buộc	Một đoạn văn bản để mô tả đối tượng. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng: 180 ký tự
Danh sách phụ đề	Không bắt buộc	Tối đa 3 phụ đề, mỗi phụ đề có một dòng văn bản. Lưu ý: Nội dung mô tả hoặc danh sách phụ đề chỉ hiển thị cho người dùng chứ không hiển thị cả hai.	Văn bản tự do Kích thước văn bản nên dùng cho mỗi tiêu đề phụ: tối đa 50 ký tự
Huy hiệu	Không bắt buộc	Mỗi huy hiệu là văn bản tự do (tối đa 15 ký tự) hoặc hình ảnh nhỏ.
Huy hiệu - Văn bản	Không bắt buộc	Tiêu đề của huy hiệu Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Văn bản tự do Kích thước văn bản nên dùng: tối đa 15 ký tự
Huy hiệu - Hình ảnh	Không bắt buộc	Hình ảnh nhỏ Cách xử lý đặc biệt về trải nghiệm người dùng, chẳng hạn như lớp phủ huy hiệu trên hình thu nhỏ của hình ảnh/video. Lưu ý: Bạn phải cung cấp văn bản hoặc hình ảnh cho huy hiệu	Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mã đặt trước	Không bắt buộc	Mã đặt chỗ cho yêu cầu đặt chỗ trước sự kiện.	Văn bản tự do
Giá – Giá hiện tại	Bắt buộc trong một số điều kiện	Giá hiện tại của vé/vé tham dự sự kiện. Bạn phải cung cấp nếu cung cấp giá gốc được gạch ngang.	Văn bản tự do
Giá - Giá gạch ngang	Không bắt buộc	Giá gốc của vé/vé tham dự sự kiện.	Văn bản tự do
Chú thích giá	Không bắt buộc	Chú thích giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu dành cho thành viên (nếu có).	Văn bản tự do Kích thước văn bản nên dùng: dưới 45 ký tự (Văn bản quá dài có thể hiển thị dấu ba chấm)
Điểm xếp hạng – Giá trị tối đa	Không bắt buộc	Giá trị tối đa của thang điểm xếp hạng. Phải cung cấp nếu bạn cũng cung cấp giá trị hiện tại của điểm xếp hạng.	Số >= 0,0
Điểm xếp hạng – Giá trị hiện tại	Không bắt buộc	Giá trị hiện tại của thang điểm xếp hạng. Phải cung cấp nếu bạn cũng cung cấp giá trị tối đa của điểm xếp hạng.	Số >= 0,0
Điểm xếp hạng – Tổng số	Không bắt buộc	Tổng số lượt xếp hạng cho sự kiện. Lưu ý: Hãy cung cấp trường này nếu ứng dụng của bạn muốn kiểm soát cách trường này hiển thị với người dùng. Vui lòng cung cấp chuỗi ngắn gọn mà người dùng có thể thấy. Ví dụ: nếu số lượng là 1.000.000, hãy cân nhắc dùng các chữ viết tắt như 1 triệu để không bị cắt bớt trên màn hình có kích thước nhỏ hơn.	Chuỗi
Điểm xếp hạng – Giá trị tổng số	Không bắt buộc	Tổng số lượt xếp hạng cho sự kiện. Lưu ý: Hãy cung cấp trường này nếu bạn không muốn tự xử lý logic viết tắt hiển thị. Nếu có cả giá trị Đếm và Giá trị đếm, chúng ta sẽ dùng Đếm để hiển thị cho người dùng	Dài
Danh mục nội dung	Không bắt buộc	Mô tả danh mục nội dung của đối tượng.	Danh sách Enum đủ điều kiện TYPE_MOVIES_AND_TV_SHOWS (Ví dụ: Rạp chiếu phim) TYPE_DIGITAL_GAMES (Ví dụ: Thể thao điện tử) TYPE_MUSIC (Ví dụ: Buổi hoà nhạc) TYPE_CENTER_AND_LOCAL (Ví dụ: Tham quan, lễ hội) TYPE_HEALTH_AND_FITENESS (Ví dụ: lớp Yoga) TYPE_EDUCATION (Ví dụ: Lớp) TYPE_SPORTS (Ví dụ: Trò chơi bóng đá) TYPE_DATING (Ví dụ: buổi gặp mặt) Hãy xem phần Danh mục nội dung để biết hướng dẫn.

Thông số kỹ thuật của hình ảnh

Bảng này liệt kê thông số kỹ thuật bắt buộc cho thành phần hình ảnh:

Tỷ lệ khung hình	Số điểm ảnh tối thiểu	Số điểm ảnh đề xuất
Vuông (1 x 1) Ưa thích	300 x 300	1200 x 1200
Ngang (1,91 x 1)	600 x 314	1200 x 628
Dọc (4 x 5)	480 x 600	960 x 1200

Hình ảnh phải được lưu trữ trên CDN công khai để Google có thể truy cập.

Định dạng tệp

PNG, JPG, GIF tĩnh, WebP

Kích thước tệp tối đa

5120 KB

Đề xuất khác

• Khu vực an toàn cho hình ảnh: Đặt nội dung quan trọng của bạn vào phần chiếm 80% trung tâm của hình ảnh.
• Sử dụng nền trong suốt để hình ảnh có thể hiển thị chính xác trong phần cài đặt Giao diện sáng và tối.

Danh mục nội dung

Danh mục nội dung cho phép các ứng dụng xuất bản nội dung thuộc nhiều danh mục. Thao tác này sẽ liên kết nội dung với một số danh mục được xác định trước, cụ thể là:

• 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

Hình ảnh phải được lưu trữ trên CDN công khai để Google có thể truy cập.

Nguyên tắc sử dụng danh mục nội dung

1. Một số thực thể như ArticleEntity và GenericFeaturedEntity đủ điều kiện để sử dụng bất kỳ danh mục nội dung nào. Đối với các thực thể khác như EventEntity, EventIssueEntity, PersonEntity, chỉ một nhóm nhỏ các danh mục này đủ điều kiện. Hãy kiểm tra danh sách các danh mục đủ điều kiện cho một loại thực thể trước khi điền danh sách.

2. Sử dụng loại thực thể cụ thể cho một số danh mục nội dung thay vì kết hợp các thực thể Chung và ContentCategory:

   • TYPE_MOVIES_AND_TV_SHOWS – Xem các thực thể trong Hướng dẫn tích hợp xem trước khi sử dụng các thực thể chung.
   • TYPE_BOOKS – Xem EbookEntity trước khi sử dụng các thực thể chung.
   • TYPE_AUDIOBOOKS – Hãy xem AudiobookEntity trước khi sử dụng các thực thể chung.
   • TYPE_SHOPPING – Hãy xem ShoppingEntity trước khi sử dụng các thực thể chung.
   • TYPE_FOOD_AND_DRINK – Xem các thực thể trong Hướng dẫn tích hợp thực phẩm trước khi sử dụng các thực thể chung.

3. Trường ContentCategory là trường không bắt buộc và nên để trống nếu nội dung không thuộc danh mục nào nêu trên.

4. Trong trường hợp bạn cung cấp nhiều danh mục nội dung, hãy cung cấp các danh mục đó theo thứ tự mức độ liên quan đến nội dung, trong đó danh mục nội dung phù hợp nhất được xếp đầu tiên trong danh sách.

Bước 2: Cung cấp dữ liệu các Cluster

Bạn nên thực hiện tác vụ xuất bản nội dung trong nền (ví dụ: sử dụng WorkManager) và lên lịch thường xuyên hoặc theo sự kiện (ví dụ: mỗi khi người dùng mở ứng dụng hoặc khi người dùng vừa thêm mặt hàng nào vào giỏ hàng).

AppEngagePublishClient chịu trách nhiệm xuất bản cụm.

Các API dưới dây dùng để xuất bản cụm trong ứng dụng:

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

isServiceAvailable

API này dùng để kiểm tra xem dịch vụ có thể tích hợp và nội dung có xuất hiện trên thiết bị hay không.

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

Lưu ý: Bạn nên kiểm tra định kỳ để xem dịch vụ có được cung cấp vào lúc khác hay không. Khả năng cung cấp dịch vụ có thể thay đổi khi nâng cấp phiên bản Android, nâng cấp ứng dụng, cài đặt và gỡ cài đặt. Bằng cách đảm bảo việc kiểm tra định kỳ trong một khoảng thời gian nhất định, dữ liệu có thể được xuất bản khi có dịch vụ.

publishRecommendationClusters

API này được dùng để phát hành danh sách đối tượng RecommendationCluster.

Lưu ý quan trọng: API xuất bản là các API chèn và cập nhật; sẽ thay thế nội dung hiện tại. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó.

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

Khi dịch vụ nhận được yêu cầu, các hành động sau đây sẽ diễn ra trong một giao dịch:

• Dữ liệu RecommendationCluster hiện có của đối tác nhà phát triển sẽ bị xoá.
• Dữ liệu của yêu cầu được phân tích cú pháp và lưu trữ trong cụm Đề xuất đã cập nhật.

Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

publishFeaturedCluster

API này được dùng để phát hành danh sách đối tượng FeaturedCluster.

Lưu ý quan trọng: API xuất bản là các API chèn và cập nhật; sẽ thay thế nội dung hiện tại. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó.

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

Khi dịch vụ nhận được yêu cầu, các hành động sau đây sẽ diễn ra trong một giao dịch:

• Dữ liệu FeaturedCluster hiện có của đối tác nhà phát triển sẽ bị xoá.
• Dữ liệu của yêu cầu được phân tích cú pháp và lưu trữ trong cụm Nổi bật đã cập nhật.

Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

publishContinuationCluster

API này được dùng để phát hành đối tượng ContinuationCluster.

Lưu ý quan trọng: API xuất bản là các API chèn và cập nhật; sẽ thay thế nội dung hiện tại. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó.

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

Khi dịch vụ nhận được yêu cầu, các hành động sau đây sẽ diễn ra trong một giao dịch:

• Dữ liệu ContinuationCluster hiện có của đối tác nhà phát triển sẽ bị xoá.
• Dữ liệu của yêu cầu được phân tích cú pháp và lưu trữ trong cụm Tiếp tục đã cập nhật.

Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

publishUserAccountManagementRequest

API này dùng để xuất bản thẻ Đăng nhập. Thao tác đăng nhập sẽ đưa người dùng đến trang đăng nhập của ứng dụng để ứng dụng có thể xuất bản nội dung (hoặc cung cấp nội dung phù hợp hơn cho cá nhân)

Siêu dữ liệu sau đây là một phần của Thẻ đăng nhập –

Thuộc tính	Yêu cầu	Nội dung mô tả
URI hành động	Bắt buộc	Đường liên kết sâu đến hành động (chẳng hạn như điều hướng đến trang đăng nhập ứng dụng)
Ảnh	Không bắt buộc – Nếu không cung cấp thì bạn phải cung cấp Tiêu đề	Hình ảnh hiện trên thẻ Hình ảnh có tỷ lệ khung hình 16x9 với độ phân giải 1264x712
Tiêu đề	Không bắt buộc – Nếu không cung cấp thì bạn phải cung cấp Hình ảnh	Tiêu đề trên thẻ
Văn bản hành động	Không bắt buộc	Văn bản hiện trên CTA (chẳng hạn như Đăng nhập)
Phụ đề	Không bắt buộc	Phụ đề không bắt buộc trên thẻ

Lưu ý quan trọng: API xuất bản là các API chèn và cập nhật; sẽ thay thế nội dung hiện tại. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó.

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

Khi dịch vụ nhận được yêu cầu, các hành động sau đây sẽ diễn ra trong một giao dịch:

• Dữ liệu UserAccountManagementCluster hiện có của đối tác nhà phát triển sẽ bị xoá.
• Dữ liệu của yêu cầu được phân tích cú pháp và lưu trữ trong cụm UserAccountManagementCluster đã cập nhật.

Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

updatePublishStatus

Nếu vì một lý do kinh doanh nội bộ bất kỳ mà không có cụm nào được xuất bản, bạn nên cập nhật trạng thái xuất bản bằng cách sử dụng API updatePublishStatus. Việc này quan trọng vì:

• Trong mọi trường hợp, ngay cả khi nội dung được xuất bản (STATUS == PUBLISHED), bạn phải cho biết trạng thái để điền trang tổng quan. Trạng thái rõ ràng này sẽ được trang tổng quan sử dụng để truyền tải tình trạng và các chỉ số khác của quá trình tích hợp.
• Nếu không có nội dung nào được xuất bản nhưng trạng thái tích hợp không phải là bị lỗi (STATUS == NOT_PUBLISHED), Google có thể tránh kích hoạt cảnh báo trong trang tổng quan về tình trạng của ứng dụng. Phương thức này xác nhận rằng nội dung chưa được xuất bản do tình huống dự kiến theo quan điểm của nhà cung cấp.
• Theo đó, nhà phát triển có thể cung cấp thông tin chi tiết về thời điểm công bố hoặc không công bố dữ liệu.
• Google có thể sử dụng các mã trạng thái nhắc người dùng thực hiện một số thao tác trong ứng dụng để họ có thể xem hoặc bỏ qua nội dung ứng dụng.

Dưới đây là danh sách mã trạng thái xuất bản đủ điều kiện:

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

Nếu nội dung chưa được xuất bản do người dùng chưa đăng nhập, thì bạn nên xuất bản Thẻ đăng nhập. Nếu vì một lý do bất kỳ mà nhà cung cấp không thể xuất bản Thẻ đăng nhập, bạn nên gọi API updatePublishStatus kèm theo mã trạng thái 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

API này dùng để xoá nội dung của cụm Recommendation (Đề xuất).

Lưu ý quan trọng: Bạn chỉ nên gọi API xoá khi không có nội dung nào để xuất bản. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó. Hãy liên hệ với engage-developers@ trước khi sử dụng các API xoá.

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Khi nhận được yêu cầu, dịch vụ sẽ xoá dữ liệu hiện có khỏi cụm Đề xuất. Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

Lưu ý: API này được hỗ trợ từ phiên bản 1.1.0 trở đi.

deleteFeaturedCluster

API này dùng để xoá nội dung của cụm Featured (Nổi bật).

Lưu ý quan trọng: Bạn chỉ nên gọi API xoá khi không có nội dung nào để xuất bản. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó. Hãy liên hệ với engage-developers@ trước khi sử dụng các API xoá.

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Khi nhận được yêu cầu, dịch vụ sẽ xoá dữ liệu hiện có khỏi cụm Nổi bật. Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

Lưu ý: API này được hỗ trợ từ phiên bản 1.1.0 trở đi.

deleteContinuationCluster

API này dùng để xoá nội dung của cụm Continuation (Tiếp tục).

Lưu ý quan trọng: Bạn chỉ nên gọi API xoá khi không có nội dung nào để xuất bản. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó. Hãy liên hệ với engage-developers@ trước khi sử dụng các API xoá.

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

Khi nhận được yêu cầu, dịch vụ sẽ xoá dữ liệu hiện có khỏi cụm Tiếp tục. Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

Lưu ý: API này được hỗ trợ từ phiên bản 1.1.0 trở đi.

deleteUserManagementCluster

API này dùng để xoá nội dung của cụm UserAccountManagement.

Lưu ý quan trọng: Bạn chỉ nên gọi API xoá khi không có nội dung nào để xuất bản. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó. Hãy liên hệ với engage-developers@ trước khi sử dụng các API xoá.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Khi nhận được yêu cầu, dịch vụ sẽ xoá dữ liệu hiện có khỏi cụm UserAccountManagement. Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại vẫn giữ nguyên.

Lưu ý: API này được hỗ trợ từ phiên bản 1.1.0 trở đi.

deleteClusters

API này dùng để xoá nội dung của một loại cụm cụ thể.

Lưu ý quan trọng: Bạn chỉ nên gọi API xoá khi không có nội dung nào để xuất bản. Đừng gọi lần lượt API xoá và API xuất bản để thay thế nội dung, vì các API xuất bản vốn đã thực hiện điều đó. Hãy liên hệ với engage-developers@ trước khi sử dụng các API xoá.

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

Khi nhận được yêu cầu, dịch vụ sẽ xoá dữ liệu hiện có khỏi tất cả các cụm khớp với loại cụm đã chỉ định. Ứng dụng có thể chọn truyền một hoặc nhiều loại cụm. Trong trường hợp xảy ra lỗi, toàn bộ yêu cầu sẽ bị từ chối và trạng thái hiện tại sẽ được duy trì.

Xử lý lỗi

Bạn nên nghe kết quả tác vụ từ các API phát hành để có thể thực hiện thao tác tiếp theo nhằm khôi phục và gửi lại tác vụ thành công.

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

Lỗi được trả về dưới dạng AppEngageException với nguyên nhân được đưa vào dưới dạng mã lỗi.

Mã lỗi	Lưu ý
SERVICE_NOT_FOUND	Dịch vụ này không dùng được trên thiết bị đã cho.
SERVICE_NOT_AVAILABLE	Dịch vụ này hoạt động trên thiết bị đã cho, nhưng không hoạt động tại thời điểm gọi (ví dụ: dịch vụ bị vô hiệu hoá một cách rõ ràng).
SERVICE_CALL_EXECUTION_FAILURE	Không thực hiện được tác vụ do có vấn đề về luồng. Trong trường hợp này, bạn có thể thử lại.
SERVICE_CALL_PERMISSION_DENIED	Trình gọi không được phép thực hiện cuộc gọi dịch vụ.
SERVICE_CALL_INVALID_ARGUMENT	Yêu cầu chứa dữ liệu không hợp lệ (ví dụ: nhiều hơn số cụm được phép).
SERVICE_CALL_INTERNAL	Đã xảy ra lỗi bên phía dịch vụ.
SERVICE_CALL_RESOURCE_EXHAUSTED	Cuộc gọi dịch vụ được thực hiện quá thường xuyên.

Bước 3: Xử lý ý định truyền tin

Ngoài việc thực hiện lệnh gọi API nội dung phát hành thông qua một công việc, bạn cũng phải thiết lập BroadcastReceiver để nhận yêu cầu phát hành nội dung.

Mục tiêu của ý định truyền tin chủ yếu là để kích hoạt lại ứng dụng và buộc đồng bộ hoá dữ liệu. Ý định truyền tin không được thiết kế để gửi quá thường xuyên. Lệnh này chỉ được kích hoạt khi Dịch vụ Engage xác định nội dung có thể đã lỗi thời (ví dụ: một tuần trước). Bằng cách đó, bạn có thể yên tâm hơn rằng người dùng sẽ có trải nghiệm nội dung mới mẻ, ngay cả khi ứng dụng không được sử dụng trong một thời gian dài.

Bạn phải thiết lập BroadcastReceiver theo 2 cách sau:

• Tự động đăng ký một thực thể của lớp BroadcastReceiver bằng cách sử dụng Context.registerReceiver(). Điều này cho phép giao tiếp từ các ứng dụng vẫn còn trong bộ nhớ.

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

}

• Khai báo tĩnh quá trình triển khai bằng thẻ <receiver> trong tệp AndroidManifest.xml. Điều này cho phép ứng dụng nhận được ý định truyền tin khi ứng dụng không chạy, đồng thời cho phép ứng dụng phát hành nội dung đó.

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

Dịch vụ sẽ gửi các ý định sau:

• com.google.android.engage.action.PUBLISH_RECOMMENDATION Bạn nên bắt đầu lệnh gọi publishRecommendationClusters khi nhận được ý định này.
• com.google.android.engage.action.PUBLISH_FEATURED Bạn nên bắt đầu lệnh gọi publishFeaturedCluster khi nhận được ý định này.
• com.google.android.engage.action.PUBLISH_CONTINUATION Bạn nên bắt đầu lệnh gọi publishContinuationCluster khi nhận được ý định này.

Quy trình tích hợp

Để được hướng dẫn từng bước về cách xác minh quy trình tích hợp sau khi hoàn tất, hãy xem Quy trình tích hợp dành cho nhà phát triển Engage.

Câu hỏi thường gặp

Hãy xem mục Câu hỏi thường gặp về Engage SDK để biết các câu hỏi thường gặp.

Thông tin liên hệ

Vui lòng liên hệ qua [e-mail] nếu bạn có câu hỏi trong quá trình tích hợp.

Các bước tiếp theo

Sau khi bạn hoàn tất quá trình tích hợp này, các bước tiếp theo sẽ như sau:

• Gửi email đến [e-mail] và đính kèm APK tích hợp sẵn sàng cho Google kiểm thử.
• Google sẽ xác minh và xem xét trong phạm vi nội bộ để đảm bảo quá trình tích hợp diễn ra như mong đợi. Nếu cần thay đổi, Google sẽ liên hệ với bạn để yêu cầu bạn cung cấp mọi thông tin chi tiết cần thiết.
• Khi quá trình kiểm thử hoàn tất và bạn không cần thay đổi gì, Google sẽ liên hệ với bạn để thông báo rằng bạn có thể bắt đầu phát hành APK tích hợp mới nhất lên Cửa hàng Play.
• Sau khi Google xác nhận rằng APK mới nhất của bạn đã được xuất bản lên Cửa hàng Play, các cụm Đề xuất, Nổi bật và Tiếp tục sẽ được xuất bản và hiển thị cho người dùng.