Query Banner Information

Last Updated on : 2023-06-20 12:34:14download

Query the information about banners on pages, according to the language, category status, and other parameters.

API address

GET: /v1.0/iot-03/app-contents/banners

Request parameter

Parameter name Type IN Required Description
category_id String query false The ID of a specified category.
lang String query false The language.
banner_state Integer query false The status of the banner. Valid values:
  • 1: unreleased.
  • 2: released.
  • 3: removed.
page_size Integer query true The number of items per page.
page_no Integer query true The page number.
schema String query false App schema

Return parameter

Parameter name Type Description
result PageResult The information about banners.

Description of result

Parameter name Type Description
page_info PageInfo The information on a page.
datas List The information about banners.

Description of datas

Parameter name Type Description
banner_id String The ID of a specified banner.
title String The title.
category_id String The ID of a specified category.
pic_url String The URL of the image.
title_lang_info List The title in multiple languages.
banner_state Integer The status of the banner. Valid values:
  • 1: unreleased.
  • 2: released.
  • 3: removed.
link String The link address.
create_time Long The time when it is created.
update_time Long The time when it is updated.
creator String The person who has created the banner.
modifier String The person who has modified the banner.
publish_time Long The time when it is released.
order Integer The order in which the banners are arranged.
view_count Integer The page views of the banner.
schema String App schema

Description of page_info

Parameter name Type Description
page_count Integer The total number of pages.
page_size Integer The number of items to be returned per page.
total Integer The total number.
page_no Integer The number of the current page.

Description of title_lang_info

Parameter name Type Description
lang String The language.
value String The multilingual value.

Request example

GET: /v1.0/iot-03/app-contents/banners?schema=abc&page_no=1&page_size=10

Return example

{ "result": { "datas": [ { "schema": "123", "creator": "bsh1618231457224vDlX", "create_time": 1630308804188, "banner_id": "1432245049193660471", "title_lang_info": [ { "lang": "zh", "value": "Test" } ], "modifier": "bsh1618231457224vDlX", "link": "https://iot.tuya.com", "update_time": 1630308804188, "category_id": "1430536540064317471", "publish_time": 1630308804188, "pic_url": "suramar/16303087612b996f9251f.png", "banner_state": 2, "view_count": 0, "order": 0 } ], "page_info": { "page_no": 1, "total": 1, "page_count": 1, "page_size": 10 } }, "t": 1630309904211, "success": true }

Error code

For more information, see error code.