Engage SDK Các ngành dọc khác: 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 họ thiết kế.

Tài liệu này chứa hướng dẫn dành cho các đối tác nhà phát triển về việc tích hợp nội dung mới như đặt trước, sự kiện, cơ sở lưu trú, địa điểm yêu thích, người dùng và nội dung khác. Nội dung này có thể không thuộc bất kỳ danh mục nào trong số này bằng cách sử dụng Engage SDK để điền dữ liệu cho 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 này bao gồm 3 loại cụm sau: Đề xuất, Nổi bật và Tiếp tục.

  • Cụm Đề xuất cho thấy các đề xuất dành riêng cho từng cá nhân từ từng đối tác nhà phát triển. Đây là 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.

    • ArticleEntity: ArticleEntity đưa ra đề xuất dựa trên văn bản cho nội dung có liên quan đến nhiều danh mục nội dung. Mục ArticleEntity cho phép nhà phát triển cung cấp nhiều nội dung văn bản và hình ảnh có nhiều siêu dữ liệu hơn để trình bày rõ ràng thông tin cho người dùng so với GenericFeaturedEntity. Ví dụ: Nội dung tiếp thị, Đoạn trích tin tức

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

    • EventEntity: EventEntity đại diện cho một sự kiện sẽ diễn 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 được truyền tải đến người dùng.

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

    • LodgingEntity: LodgingEntity đại diện cho một cơ sở lưu trú, chẳng hạn như khách sạn, căn hộ, nhà nghỉ dưỡng cho thuê ngắn hạn và dài hạn.

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

    • StoreEntity: StoreEntity đại diện cho một cửa hàng, nhà hàng, quán cà phê, v.v. Nó làm nổi bật nội dung mà địa điểm ăn uống hoặc cửa hàng là thông tin quan trọng cần được truyền tải đến người dùng.

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

    • PointOfInterestEntity: PointOfInterestEntity đại diện cho một địa điểm yêu thích như trạm xăng, địa điểm tổ chức sự kiện, công viên giải trí, bảo tàng, điểm tham quan, đường mòn đi bộ đường dài, v.v. Lớp này làm nổi bật nội dung mà vị trí là một phần thông tin quan trọng cần được truyền tải đến người dùng. Bạn không nên sử dụng loại hình này cho nhà nghỉ, cửa hàng hoặc nhà hàng.

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

    • PersonEntity: PersonEntity đại diện cho một người. Đề xuất có thể là làm nổi bật một người trong các danh mục như sức khoẻ và thể dục, thể thao, hẹn hò, v.v.

      Hình 5: Giao diện người dùng hiển thị một PersonEntity 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 tiếp tục có thể có cấu trúc như sau:

    • ArticleEntity: ArticleEntity đại diện cho nội dung đề xuất dựa trên văn bản đối với nội dung có liên quan đến nhiều danh mục nội dung. Bạn có thể dùng thực thể này để biểu thị các bài báo tin tức chưa đọc hết 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ụ: Nội dung tiếp thị, Đoạn trích tin tức

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

    • RestaurantĐặt trướcEntity: RestaurantResetEntity đại diện cho hoạt động đặt chỗ tại một nhà hàng hoặc quán cà phê và giúp người dùng theo dõi các yêu cầu đặt chỗ nhà hàng sắp tới hoặc đang diễn ra.

      Hình 7. Giao diện người dùng cho thấy một Restaurant ReserveEntity duy nhất trong cụm Continuation.

    • EventReservationEntity: EventReservationEntity đại diện cho một lượt đặt chỗ cho một sự kiện và giúp người dùng theo dõi các lượt đặt chỗ sự kiện sắp tới hoặc đang diễn ra. Các sự kiện có thể bao gồm nhưng không giới hạn ở:

      • Sự kiện thể thao như đặt chỗ xem trận đấu bóng đá
      • Sự kiện trò chơi như đặt chỗ cho các giải đấu thể thao điện tử
      • Sự kiện giải trí như đặt chỗ xem phim tại rạp chiếu phim, buổi biểu diễn ca nhạc, nhà hát, buổi ký sách
      • Thông tin đặt chỗ cho chuyến đi hoặc điểm tham quan, chẳng hạn như vé tham quan có hướng dẫn viên, vé bảo tàng
      • Yêu cầu đặt chỗ cho sự kiện xã hội/hội thảo/hội nghị
      • Đặt chỗ tham gia các buổi chia sẻ về kiến thức/kỹ năng đào tạo
      Hình 8. Giao diện người dùng hiển thị một EventReservationEntity duy nhất trong cụm Tiếp tục.

    • LodgingReservationEntity: LodgingEntityReservation đại diện cho một lượt đặt phòng cơ sở lưu trú du lịch và giúp người dùng theo dõi các lượt đặt phòng khách sạn hoặc nhà nghỉ dưỡng cho thuê sắp tới hoặc đang diễn ra.

      Hình 9. Giao diện người dùng cho thấy một LodgingKeepEntity duy nhất trong cụm Continuation.

    • TransportationReservationEntity: TransportationReservationEntity đại diện cho một yêu cầu đặt trước phương tiện giao thông bằng bất kỳ phương thức nào và giúp người dùng theo dõi các yêu cầu đặt trước chuyến bay, phà, tàu, xe buýt, dịch vụ gọi xe hoặc tàu du lịch sắp tới hoặc đang diễn ra.

      Hình 10. Giao diện người dùng hiển thị một TransportationReservationEntity duy nhất trong cụm Tiếp tục.

    • VehicleRentalReservationEntity: VehicleRentalReservationEntity đại diện cho một yêu cầu đặt trước xe và giúp người dùng theo dõi các yêu cầu đặt trước xe sắp tới hoặc đang diễn ra.

      Hình 11. Giao diện người dùng cho thấy một ổn định của chính sách xe thuê trong một cụm Continuation (Tiếp tục).

  • Cụm Nổi bật là một thành phần 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.

    • GenericFeaturedEntity: 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 nhà phát triển và phải đại diện cho nội dung quan trọng nhất sẽ 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 của một anh hùng trong 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.engage:engage-core 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.5.2'
}

Tóm tắt

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

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, EventEntity, LodgingEntity, StoreEntity, PointOfInterestEntity hoặc PersonEntity)
Cụm Tiếp tục Tối đa 1 Ít nhất 1 Tối đa 10 (ArticleEntity, EventReservationEntity, LodgingReservationEntity, TransportationReservationEntity hoặc VehicleRentalReservationEntity)
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 mục. Chúng tôi hỗ trợ các thực thể sau cho danh mục khác:

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. EventEntity
  4. LodgingEntity
  5. StoreEntity
  6. PointOfInterestEntity
  7. PersonEntity
  8. RestaurantReservationEntity
  9. EventReservationEntity
  10. LodgingReservationEntity
  11. TransportationReservationEntity
  12. VehicleRentalReservationEntity

Các biểu đồ bên dưới nêu ra các thuộc tính có sẵn 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 có nhiều hình ảnh. Tỷ lệ khung hình được đề xuất là 16:9

Lưu ý: Nếu bạn cung cấp huy hiệu, hãy đảm bảo khoảng an toàn là 24 dps ở cả đầ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ự
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi 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, ví dụ như lớp phủ huy hiệu trên hình ảnh

  • "Cập nhật trực tiếp"
  • 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 đề xuất: 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 trong thực thể.

Danh sách Enums

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ổ. 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 có nhiều hình ảnh. Tỷ lệ khung hình được đề 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 khoảng cách an toàn là 24 dps ở cả đầ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 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.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi 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ý trải nghiệm người dùng đặc biệt trên hình ảnh/video, ví dụ: lớp phủ huy hiệu trên hình ảnh

  • "Live update" (Cập nhật trực tiếp)
  • 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 đề xuất: 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) về thời điểm nội dung được phát hành/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 theo chuẩn Unix tính bằng mili giây khi người dùng tương tác với thực thể này lần gần đây nhất.

Lưu ý: Trường này là bắt buộc nếu thực thể này là một phần của 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 nội dung đầy đủ mà người dùng đã xem cho đến nay.

Lưu ý: Trường này là bắt buộc nếu thực thể này là một phần của 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 trong thực thể.

Danh sách Enums

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ổ. 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 theo chuẩn Unix khi sự kiện dự kiến sẽ bắt đầu.

Lưu ý:Thời gian 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

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 có nhiều hình ảnh. Tỷ lệ khung hình được đề 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 khoảng cách an toàn là 24 dps ở cả đầ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 diễn ra.

Lưu ý: Đây là thông tin bắt buộc đối với các sự kiện có loại 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 diễn ra sự kiện.

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à thông tin bắt buộc đối với các sự kiện có loại 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ã zip (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í – Khu vực xung quanh 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 theo chuẩn Unix khi sự kiện dự kiến sẽ kết thúc.

Lưu ý:Thời gian 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)
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi 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 đề xuất: 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á – CurrentPrice Bắt buộc có đ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 về giá Không bắt buộc Chú thích về giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu 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 trong thực thể.

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ụ: Hòa nhạc)
  • TYPE_TRAVEL_AND_LOCAL (Ví dụ: Chuyến tham quan, lễ hội)
  • TYPE_HEALTH_AND_FITENESS (Ví dụ: Lớp học yoga)
  • TYPE_EDUCATION (Ví dụ – Lớp học)
  • TYPE_SPORTS (Ví dụ: Trò chơi bóng đá)
  • TYPE_DATING (Ví dụ: họp mặt)

Hãy xem phần Danh mục nội dung để biết hướng dẫn.

LodgingEntity

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ổ. 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ự
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 được đề xuất là 16:9

Lưu ý: Nếu bạn có huy hiệu, hãy đảm bảo không gian an toàn 24 dps ở 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 Quốc gia nơi diễn ra hoạt động lưu trú.

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 Thành phố nơi diễn ra sự kiện lưu trú.

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 Địa chỉ của nơi lưu trú mà người dùng sẽ nhìn thấy.

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 cơ sở lưu trú.

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 cơ sở lưu trú tọa lạ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ự
Vị trí – Mã bưu chính Không bắt buộc Mã zip (nếu có) của cơ sở lưu trú.

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í – Khu vực xung quanh Không bắt buộc Khu vực lân cận (nếu có) của cơ sở lưu trú.

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 đề xuất: 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 ý: Huy hiệu bắt buộc phải có văn bản hoặc hình ảnh

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi phụ đề: tối đa 50 ký tự
AvailabilityTimeWindow – Thời gian bắt đầu Không bắt buộc Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) khi cơ sở lưu trú dự kiến sẽ mở cửa/có phò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ồn tại của cửa sổ – 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 (tính bằng mili giây) cho đến thời điểm dự kiến cơ sở lưu trú sẽ mở cửa/có phòng. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Đ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 – Số lượng Không bắt buộc

Số lượt xếp hạng cho cơ sở lưu trú.

Lưu ý: Hãy cung cấp trường này nếu ứng dụng của bạn kiểm soát cách hiển thị số lượt cho người dùng. Sử dụng chuỗi ngắn gọn. Ví dụ: nếu số lượng là 1.000.000, hãy cân nhắc sử dụng chữ viết tắt như 1 triệu để số lượng 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ị số lượng Không bắt buộc

Số lượng điểm xếp hạng của cơ sở lưu trú.

Lưu ý: Cung cấp trường này nếu bạn không tự xử lý logic viết tắt hiển thị. Nếu cả Số lượng và Giá trị số lượng đều có, thì Số lượng sẽ hiển thị cho người dùng.

 Dài
Giá – Giá hiện tại Bắt buộc có điều kiện

Giá hiện tại của cơ sở lưu trú.

Phải cung cấp nếu bạn 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 chỗ ở (sẽ bị gạch ngang trong giao diện người dùng). Văn bản tự do
Chú thích về giá Không bắt buộc Chú thích về giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu 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)

StoreEntity

Đối tượng StoreEntity đại diện cho từng cửa hàng mà các đối tác nhà phát triển muốn xuất bản, chẳng hạn như nhà hàng hoặc cửa hàng tạp hoá.

Thuộc tính Yêu cầu Nội dung mô tả Định dạng
Hình ảnh áp phích Bắt buộc Bạn phải cung cấp ít nhất một hình ảnh. Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
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ổ. Tham khảo phần Câu hỏi thường gặp này

URI
Tiêu đề Không bắt buộc Tên cửa hàng.

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)
Vị trí Không bắt buộc Vị trí cửa hàng.

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)
Chú thích Không bắt buộc Chú thích giới thiệu về một chương trình khuyến mãi, sự kiện hoặc thông tin cập nhật của cửa hàng (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)
Dòng chữ in nhỏ của chú thích Không bắt buộc Văn bản in nhỏ của chú thích.

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)
Nội dung mô tả Không bắt buộc Nội dung mô tả về cửa hàng.

Văn bản tự do

Kích thước văn bản nên dùng: dưới 90 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 – Số lượng Không bắt buộc

Số lượt xếp hạng cho cơ sở lưu trú.

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. Cung cấp chuỗi ngắn gọn có thể hiển thị cho người dùng. Ví dụ: nếu số lượng là 1.000.000, hãy cân nhắc sử dụng các từ viết tắt như 1 triệu để số lượng không bị cắt bớt trên các kích thước màn hình nhỏ hơn.

 Chuỗi
Điểm xếp hạng – Giá trị số lượng Không bắt buộc

Số lượt xếp hạng cho cơ sở lưu trú.

Lưu ý: 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

PointOfInterestEntity

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ổ. 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ự
Hình ảnh áp phích Bắt buộc

Chúng tôi sẽ chỉ hiển thị 1 hình ảnh khi có nhiều hình ảnh. Tỷ lệ khung hình được đề 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 khoảng cách an toàn là 24 dps ở cả đầ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 Quốc gia nơi diễn ra địa điểm yêu thích.

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 Thành phố nơi diễn ra địa điểm yêu thích.

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 Địa chỉ của điểm yêu thích 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ó) của địa điểm yêu thích.

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 điểm tham quan đó nằm.

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ã zip (nếu có) của địa điểm yêu thích.

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í – Khu vực xung quanh Không bắt buộc Khu vực lân cận (nếu có) của địa điểm yêu thích.

Văn bản tự do

Kích thước văn bản nên dùng: tối đa ~20 ký tự
sẵn cóTimeWindow – Thời gian bắt đầu Không bắt buộc Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) khi điểm yêu thích dự kiến sẽ mở/có sẵn. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Thời gian tồn tại của cửa sổ – 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 (tính bằng mili giây) cho đến khi địa điểm yêu thích dự kiến mở/có sẵn. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
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 đề xuất: 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 ý: Huy hiệu bắt buộc phải có văn bản hoặc hình ảnh

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi phụ đề: tối đa 50 ký tự
Đ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 – Số lượng Không bắt buộc

Số điểm xếp hạng của địa điểm yêu thích.

Lưu ý: Hãy cung cấp trường này nếu ứng dụng của bạn kiểm soát cách hiển thị số lượt cho người dùng. Sử dụng chuỗi ngắn gọn. Ví dụ: nếu số lượng là 1.000.000, hãy cân nhắc sử dụng chữ viết tắt như 1 triệu để số lượng 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ị số lượng Không bắt buộc

Số điểm xếp hạng của địa điểm yêu thích.

Lưu ý: Hãy cung cấp trường này nếu bạn không tự xử lý logic hiển thị chữ viết tắt. Nếu cả Số lượng và Giá trị số lượng đều có, thì Số lượng sẽ hiển thị cho người dùng

 Dài
Giá – Giá hiện tại Bắt buộc có điều kiện

Giá hiện tại của vé/vé vào cổng cho điểm tham quan.

Phải cung cấp nếu bạn 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é vào cửa cho địa điểm yêu thích. Văn bản tự do
Chú thích về giá Không bắt buộc Chú thích về giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu 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 trong thực thể.

Danh sách enum đủ điều kiện

  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_MOVIES_AND_TV_SHOWS (Ví dụ: rạp chiếu phim)
  • TYPE_MEDICAL (Ví dụ: bệnh viện)
  • TYPE_EDUCATION (Ví dụ: trường học)
  • TYPE_SPORTS (Ví dụ: sân vận động)

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ổ. 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 tuỳ ý như tên người dùng của trang doanh nghiệp.

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 có nhiều hình ảnh. Tỷ lệ khung hình được đề 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 khoảng cách an toàn là 24 dps ở cả đầ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

Cho biết số lượng người theo dõi hoặc giá trị mức độ phổ biến, ví dụ: "3,7 triệu".

Lưu ý: Nếu bạn cung cấp cả Số lượng và Giá trị số lượng, thì Số lượng sẽ được sử dụng

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ố người theo dõi hoặc giá trị 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ả Số lượng và Giá trị số lượng, thì Số lượng 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 – Số lượng 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. Cung cấp chuỗi ngắn gọn có thể hiển thị cho người dùng. 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 để số lượng 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ị số lượng Không bắt buộc

Tổng số điểm xếp hạng cho thực thể.

Lưu ý: 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 làm việ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ự
Vị trí – Thành phố Không bắt buộc Thành phố nơi người đó sinh sống hoặc làm việ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ự
Vị trí – Địa chỉ hiển thị Không bắt buộc Địa chỉ nơi người đó đang ở 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 đó cư trú hoặc làm việ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ự
Vị trí – Tiểu bang Không bắt buộc Tiểu bang (nếu có) nơi người đó sinh sống hoặc làm việ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ự
Vị trí – Mã bưu chính Không bắt buộc Mã zip (nếu có) nơi người đó sinh sống hoặc làm việ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ự
Vị trí – Khu vực xung quanh Không bắt buộc Khu vực lân cận (nếu có) nơi người đó sinh sống hoặc làm việ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ự
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 đề xuất: 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 ý: Huy hiệu bắt buộc phải có văn bản hoặc hình ảnh

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi 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 trong thực thể.

Danh sách enum đủ điều kiện

  • TYPE_HEALTH_AND_FITENESS (Ví dụ: Huấn luyện viên yoga/thể hình)
  • TYPE_HOME_AND_AUTO (Ví dụ: Thợ sửa ống nước)
  • TYPE_SPORTS (Ví dụ – Người chơi)
  • TYPE_DATING

Hãy xem phần Danh mục nội dung để biết hướng dẫn.

RestaurantReservationEntity

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ổ. 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 đặt trước Bắt buộc Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) khi đặt phòng dự kiến sẽ bắt đầu. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Vị trí – Quốc gia Bắt buộc Quốc gia nơi nhà hàng 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í – Thành phố Bắt buộc Thành phố nơi nhà hàng diễn ra.

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 Địa chỉ của nhà hàng 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ó) của nhà hà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í – Tiểu bang Không bắt buộc Tiểu bang hoặc tỉnh (nếu có) nơi nhà hàng tọa lạ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ự
Vị trí – Mã bưu chính Không bắt buộc Mã zip (nếu có) của nhà hà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í – Khu vực xung quanh Không bắt buộc Khu vực xung quanh (nếu có) của nhà hà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ự
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 có nhiều hình ảnh. Tỷ lệ khung hình được đề xuất là 16:9 Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi phụ đề: tối đa 50 ký tự
Kích thước bàn Không bắt buộc Số người trong nhóm đặt phòng Số nguyên > 0

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ổ. 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 theo chuẩn Unix khi sự kiện dự kiến sẽ bắt đầu.

Lưu ý:Thời gian 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

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 diễn ra.

Lưu ý: Đây là thông tin bắt buộc đối với các sự kiện có loại 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 diễn ra sự kiện.

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à thông tin bắt buộc đối với các sự kiện có loại 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ã zip (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í – Khu vực xung quanh Không bắt buộc Khu vực lân cận (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ự
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 có nhiều hình ảnh. Tỷ lệ khung hình được đề 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 khoảng cách an toàn là 24 dps ở cả đầ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 theo chuẩn Unix khi sự kiện dự kiến sẽ kết thúc.

Lưu ý:Thời gian 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 ý: Nhà cung cấp dịch vụ phải có văn bản hoặc hình ảnh.

Văn bản tuỳ ý. Ví dụ: tên của đơn vị tổ chức sự kiện/chuyến tham quan
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.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi 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 đề xuất: 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 ý: Huy hiệu bắt buộc phải có văn bản hoặc hình ảnh

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mã đặt phòng Không bắt buộc Mã đặt trước cho yêu cầu đặt trước sự kiện. Văn bản tự do
Giá – Giá hiện tại Bắt buộc có đ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 về giá Không bắt buộc Chú thích về giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu 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 – Số lượng Không bắt buộc

Số điểm xếp hạng cho sự kiện.

Lưu ý: Cung cấp trường này nếu ứng dụng của bạn muốn kiểm soát cách hiển thị thông tin này cho người dù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 sử dụng các từ viết tắt như 1 triệu để số lượng không bị cắt bớt trên các kích thước màn hình nhỏ hơn.

 Chuỗi
Điểm xếp hạng – Giá trị số lượng Không bắt buộc

Số điểm xếp hạng cho sự kiện.

Lưu ý: 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ả Count và Count Value, chúng ta sẽ sử dụng Count để 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 trong thực thể.

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ụ: Hòa nhạc)
  • TYPE_TRAVEL_AND_LOCAL (Ví dụ: Chuyến tham quan, lễ hội)
  • TYPE_HEALTH_AND_FITENESS (Ví dụ: Lớp học yoga)
  • TYPE_EDUCATION (Ví dụ – Lớp học)
  • TYPE_SPORTS (Ví dụ: Trò chơi bóng đá)
  • TYPE_DATING (Ví dụ: họp mặt)

Hãy xem phần Danh mục nội dung để biết hướng dẫn.

LodgingReservationEntity

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ổ. 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 tuỳ ý. Ví dụ: "Khách lưu trú từ ngày 12 tháng 12"

Kích thước văn bản nên dùng: Tối đa 50 ký tự
Giờ nhận phòng Bắt buộc Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) biểu thị thời gian nhận phòng cho lượt đặt phòng. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Giờ trả phòng Bắt buộc Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) biểu thị thời gian trả phòng cho lượt đặt phòng. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Vị trí – Quốc gia Bắt buộc Quốc gia nơi lưu trú đó toạ lạ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ự
Vị trí – Thành phố Bắt buộc Thành phố nơi cơ sở lưu trú toạ lạ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ự
Vị trí – Địa chỉ hiển thị Bắt buộc Địa chỉ của nơi lưu trú mà người dùng sẽ nhìn thấy.

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 cơ sở lưu trú.

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 cơ sở lưu trú tọa lạ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ự
Vị trí – Mã bưu chính Không bắt buộc Mã zip (nếu có) của cơ sở lưu trú.

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í – Khu vực xung quanh Không bắt buộc Khu vực lân cận (nếu có) của cơ sở lưu trú.

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 có nhiều hình ảnh. Tỷ lệ khung hình nên dùng là 16:9

Lưu ý: Nếu bạn cung cấp huy hiệu, hãy đảm bảo khoảng an toàn là 24 điểm ảnh/giây ở cả đầ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ô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi phụ đề: tối đa 50 ký tự
Mã đặt phòng Không bắt buộc Mã đặt phòng cho yêu cầu đặt phòng chỗ ở. Văn bản tự do
Đ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 – Số lượng Không bắt buộc

Số lượt xếp hạng cho cơ sở lưu trú.

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. Cung cấp chuỗi ngắn gọn có thể hiển thị cho người dùng. Ví dụ: nếu số lượng là 1.000.000, hãy cân nhắc sử dụng các từ viết tắt như 1 triệu để số lượng không bị cắt bớt trên các kích thước màn hình nhỏ hơn.

 Chuỗi
Điểm xếp hạng – Giá trị số lượng Không bắt buộc

Số lượt xếp hạng cho cơ sở lưu trú.

Lưu ý: 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
Giá – Giá hiện tại Bắt buộc có điều kiện

Giá hiện tại của cơ sở lưu trú.

Phải cung cấp nếu bạn 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 chỗ ở (sẽ bị gạch ngang trong giao diện người dùng). Văn bản tự do
Chú thích về giá Không bắt buộc Chú thích về giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu 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)

TransportationReservationEntity

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ổ. 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. Ví dụ: "SFO to SAN"

Kích thước văn bản nên dùng: Tối đa 50 ký tự
Loại phương tiện Bắt buộc Phương tiện/loại phương tiện đi lại để đặt chỗ. Enum: CHUYẾN BAY, TÀU HOẢ, XE BUÝT hoặc PHÀ
Giờ khởi hành Bắt buộc Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) biểu thị thời gian khởi hành. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Thời gian đến Bắt buộc Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây) biểu thị thời gian đến. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Vị trí khởi hành – Quốc gia Không bắt buộc Quốc gia khởi hành.

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í khởi hành – Thành phố Không bắt buộc Thành phố khởi hành.

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í khởi hành – Địa chỉ hiển thị Không bắt buộc Vị trí khởi hành 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ự
Địa điểm khởi hành – Địa chỉ đường phố Không bắt buộc Địa chỉ đường phố (nếu có) của địa điểm khởi hành.

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í khởi hành – Tiểu bang Không bắt buộc Tiểu bang hoặc tỉnh (nếu có) của địa điểm khởi hành.

Văn bản tự do

Kích thước văn bản nên dùng: tối đa ~20 ký tự
Địa điểm khởi hành – Mã bưu chính Không bắt buộc Mã bưu chính (nếu có) của địa điểm khởi hành.

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í khởi hành – Khu vực lân cận Không bắt buộc Khu vực lân cận (nếu có) của vị trí xuất phát.

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í đến – Quốc gia Không bắt buộc Quốc gia đế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í đến – Thành phố Không bắt buộc Thành phố đế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í đến – Địa chỉ hiển thị Không bắt buộc Vị trí đến 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ự
Địa điểm đến – Địa chỉ đường phố Không bắt buộc Địa chỉ đường phố (nếu có) của địa điểm đế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í đến – Tiểu bang Không bắt buộc Tiểu bang hoặc tỉnh (nếu có) của địa điểm đế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ự
Địa điểm đến – Mã bưu chính Không bắt buộc Mã bưu chính (nếu có) của địa điểm đế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í đến – Khu vực xung quanh Không bắt buộc Khu vực lân cận (nếu có) của vị trí đế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ự
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 ý: Nhà cung cấp dịch vụ phải có văn bản hoặc hình ảnh.

Văn bản tuỳ ý. Ví dụ: Tên hãng hàng không
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 ý: Nhà cung cấp dịch vụ phải có văn bản hoặc hình ảnh.

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
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 có nhiều hình ảnh. Tỷ lệ khung hình nên dùng là 16:9

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi phụ đề: tối đa 50 ký tự
Mã đặt phòng Không bắt buộc Mã đặt trước cho thông tin đặt trước phương tiện đi lại. Văn bản tự do
Giá – Giá hiện tại Bắt buộc có điều kiện

Giá hiện tại của lượt đặt trước.

Phải cung cấp nếu bạn 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 lượt đặt phòng (sẽ bị gạch ngang trong giao diện người dùng). Văn bản tự do
Chú thích về giá Không bắt buộc Chú thích về giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu 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)
Số vận đơn Bắt buộc Số hiệu chuyến bay, số xe buýt, số hiệu tàu hoặc số chuyến phà/tàu du lịch. Văn bản tự do
Giờ lên máy bay Bắt buộc Dấu thời gian theo chuẩn epoch thể hiện thời gian lên máy bay của lượt đặt chỗ (nếu có) Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)

VehicleRentalReservationEntity

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ổ. 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. Ví dụ: "Avis Union Square SF"

Kích thước văn bản nên dùng: Tối đa 50 ký tự
Thời gian đến lấy hàng Bắt buộc Dấu thời gian bắt đầu của hệ thống đại diện cho thời gian lấy hàng của đơn đặt trước. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Thời gian trả lại Không bắt buộc Dấu thời gian bắt đầu của hệ thống thể hiện thời gian trả phòng của lượt đặt phòng. Dấu thời gian bắt đầu của hệ thống (tính bằng mili giây)
Địa chỉ đến lấy hàng – Quốc gia Không bắt buộc Quốc gia của địa điểm đến lấy hà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ự
Địa chỉ đến lấy hàng – Thành phố Không bắt buộc Thành phố của vị trí đến lấy hà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ự
Địa chỉ đến lấy hàng – Địa chỉ hiển thị Không bắt buộc Vị trí đến lấy hàng mà người dùng sẽ nhìn thấy.

Văn bản tự do

Kích thước văn bản nên dùng: tối đa ~20 ký tự
Địa chỉ nhận hàng – Địa chỉ đường phố Không bắt buộc Địa chỉ đường phố (nếu có) của địa điểm đến lấy hà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ự
Địa chỉ đến lấy hàng – Tiểu bang Không bắt buộc Tiểu bang hoặc tỉnh (nếu có) của địa điểm lấy hà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ự
Địa chỉ đến lấy hàng – Mã zip Không bắt buộc Mã zip (nếu có) của địa điểm lấy hà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ự
Địa chỉ đến lấy hàng – Khu vực Không bắt buộc Khu vực xung quanh (nếu có) của địa điểm lấy hà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ự
Địa chỉ trả lại hàng – Quốc gia Không bắt buộc Quốc gia của địa điểm trả lại.

Văn bản tự do

Kích thước văn bản nên dùng: tối đa ~20 ký tự
Địa chỉ trả lại hàng – Thành phố Không bắt buộc Thành phố của địa điểm trả lại.

Văn bản tự do

Kích thước văn bản nên dùng: tối đa ~20 ký tự
Địa chỉ trả lại hàng – Địa chỉ hiển thị Không bắt buộc Vị trí trả 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ự
Địa chỉ trả lại hàng – Địa chỉ đường phố Không bắt buộc Địa chỉ đường phố (nếu có) của địa điểm trả lại hà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ự
Địa chỉ trả lại hàng – Tiểu bang Không bắt buộc Tiểu bang hoặc tỉnh (nếu có) của vị trí trả lại hà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ự
Địa chỉ trả lại hàng – Mã bưu chính Không bắt buộc Mã zip (nếu có) của địa điểm trả lại hà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ự
Địa chỉ trả lại hàng – Khu vực Không bắt buộc Khu vực lân cận (nếu có) của địa điểm trả lại hà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ự
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 ý: Nhà cung cấp dịch vụ phải có văn bản hoặc hình ảnh.

Văn bản tuỳ ý. Ví dụ: "Avis Car Rental"
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 ý: Nhà cung cấp dịch vụ phải có văn bản hoặc hình ảnh.

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
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 nên dùng là 16:9

Hãy xem Thông số kỹ thuật của hình ảnh để biết hướng dẫn.
Mô tả Không bắt buộc

Một đoạn văn bản để mô tả thực thể.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải 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ụ đề là một dòng văn bản.

Lưu ý: Nội dung mô tả hoặc danh sách phụ đề sẽ được hiển thị cho người dùng, chứ không phải cả hai.

Văn bản tự do

Kích thước văn bản nên dùng cho mỗi phụ đề: tối đa 50 ký tự
Mã xác nhận Không bắt buộc Mã xác nhận cho yêu cầu đặt xe. Văn bản tự do
Giá – Giá hiện tại Bắt buộc có điều kiện

Giá hiện tại của lượt đặt trước.

Phải cung cấp nếu bạn 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 lượt đặt phòng (sẽ bị gạch ngang trong giao diện người dùng). Văn bản tự do
Chú thích về giá Không bắt buộc Chú thích về giá để giới thiệu một chương trình khuyến mãi, sự kiện, chiết khấu 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)

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

Dưới đây là 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 ứng dụng phát hành 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, EventReservationEntity, PointOfInterestEntity, chỉ một số ít trong số các danh mục này đủ điều kiện. 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ể Generic và ContentCategory:

    • TYPE_MOVIES_AND_TV_SHOWS – Hãy xem các thực thể trong Hướng dẫn tích hợp Watch 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 – Hãy 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à bạn nên để trống nếu nội dung không thuộc bất kỳ danh mục nào được đề cập trước đó.

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

Bước 2: Cung cấp dữ liệu Cụm

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

publishRecommendationClusters

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

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.

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.

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)
Hình ả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ẻ

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ì lý do nào đó 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).

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 vẫn giữ nguyên.

deleteFeaturedCluster

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

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

deleteContinuationCluster

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

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

deleteUserManagementCluster

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

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.

deleteClusters

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

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 Tên lỗi Lưu ý
1 SERVICE_NOT_FOUND Dịch vụ này không dùng được trên thiết bị đã cho.
2 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).
3 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.
4 SERVICE_CALL_PERMISSION_DENIED Trình gọi không được phép thực hiện cuộc gọi dịch vụ.
5 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).
6 SERVICE_CALL_INTERNAL Đã xảy ra lỗi bên phía dịch vụ.
7 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.

Liên hệ

Hãy liên hệ với engage-developers@google.com 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 engage-developers@google.com 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.