gmv_max_video_get

Advertiser ID.

Whether to query videos that can be used in customized posts for a specific product. If `true`, you must simultaneously provide exactly one product in `spu_id_list`. Supported values: `true`, `false`. Default value: `false`.

List of identities to filter results by. Supported identity types are `TT_USER`, `BC_AUTH_TT`, and `TTS_TT`. Obtain available identities from /gmv_max/identity/get/ and use identities where `product_gmv_max_available` is `true`. Max size: 20. If `need_auth_code_video` is `false` or omitted and `identity_list` is not provided, the API returns an empty post list.

Search keyword to filter posts. You can search by post caption (`text`) using a text string, which supports multilingual and fuzzy matching, or by post ID (`item_id`) using a numeric string of at least 19 characters, which supports exact matching.

Whether to include posts associated with `AUTH_CODE` identities. Supported values: `true`, `false`. Default value: `false`. If `need_auth_code_video` is `false` or omitted and `identity_list` is not provided, the API returns an empty post list.

Current page number. Value range: >= 1. Default value: 1.

Page size. Value range: 1-50. Default value: 10.

Sorting field for videos available for authorized posts. Valid only when `custom_posts_eligible` is `false` or omitted. Enum values: `GMV`, `POST_TIME`, `VIDEO_VIEWS`, `VIDEO_LIKES`, `CLICK_THROUGH_RATE`, `PRODUCT_CLICKS`. Default value: `GMV`.

Sorting order for videos available for authorized posts or customized posts. Enum values: `ASC`, `DESC`. Default value: `DESC`. If `custom_posts_eligible` is `false` or omitted, sort authorized-post videos by specifying both `sort_field` and `sort_type`. If `custom_posts_eligible` is `true`, do not specify `sort_field`; customized-post videos are sorted by post time descending by default, and set `sort_type=ASC` if you want earliest posts first.

List of product SPU IDs used to filter results. If you want to promote all products from the shop using authorized posts, omit both `spu_id_list` and `custom_posts_eligible`. If you want to promote specific products using authorized posts, provide `spu_id_list` and do not provide `custom_posts_eligible`. If you want to promote a specific product using customized posts, provide `spu_id_list` and set `custom_posts_eligible=true`. Max size: 50 when `custom_posts_eligible` is `false` or omitted; 1 when `custom_posts_eligible` is `true`. To obtain valid SPU IDs, use /store/product/get/, set `ad_creation_eligible=GMV_MAX`, and use `item_group_id` values where `status` is `AVAILABLE` and `gmv_max_ads_status` is `UNOCCUPIED`.

ID of the Business Center authorized to access the TikTok Shop specified in `store_id`.

The TikTok Shop ID. Obtain it from /gmv_max/store/list/ and use a shop where `is_gmv_max_available` is `true`.