@congminh1254/shopee-sdk 0.4.0 → 0.5.0

package/lib/managers/ads.manager.d.ts

@@ -1,6 +1,6 @@
 import { ShopeeConfig } from "../sdk.js";
 import { BaseManager } from "./base.manager.js";
-import { GetTotalBalanceResponse, GetShopToggleInfoResponse, GetRecommendedKeywordListParams, GetRecommendedKeywordListResponse } from "../schemas/ads.js";
+import { GetTotalBalanceResponse, GetShopToggleInfoResponse, GetRecommendedKeywordListParams, GetRecommendedKeywordListResponse, GetRecommendedItemListResponse, GetAllCpcAdsHourlyPerformanceParams, GetAllCpcAdsHourlyPerformanceResponse, GetAllCpcAdsDailyPerformanceParams, GetAllCpcAdsDailyPerformanceResponse, GetProductCampaignDailyPerformanceParams, GetProductCampaignDailyPerformanceResponse, GetProductCampaignHourlyPerformanceParams, GetProductCampaignHourlyPerformanceResponse, GetProductLevelCampaignIdListParams, GetProductLevelCampaignIdListResponse, GetProductLevelCampaignSettingInfoParams, GetProductLevelCampaignSettingInfoResponse, GetProductRecommendedRoiTargetParams, GetProductRecommendedRoiTargetResponse } from "../schemas/ads.js";
 export declare class AdsManager extends BaseManager {
     constructor(config: ShopeeConfig);
     /**
@@ -50,4 +50,224 @@ export declare class AdsManager extends BaseManager {
      * Use this API to get keyword suggestions to improve item discoverability in search results.
      */
     getRecommendedKeywordList(params: GetRecommendedKeywordListParams): Promise<GetRecommendedKeywordListResponse>;
+    /**
+     * Get the list of recommended SKUs (Shop level) with the corresponding tag
+     * @returns {Promise<GetRecommendedItemListResponse>} Response containing recommended items
+     *
+     * This API is used to get the list of recommended SKU (Shop level) with the corresponding tag,
+     * i.e top search/best selling/best ROI tag.
+     *
+     * The response includes an array of items with the following details for each item:
+     * - item_id: Recommended SKU's item id
+     * - item_status_list: Status of items (indicates whether an item is eligible for ads or not)
+     * - sku_tag_list: Tags such as "best selling", "best ROI", "top search"
+     * - ongoing_ad_type_list: Current status of ads on this item (e.g., search ads, discovery ads)
+     *
+     * Use this API to identify high-potential items for advertising campaigns.
+     */
+    getRecommendedItemList(): Promise<GetRecommendedItemListResponse>;
+    /**
+     * Get shop level CPC ads single-date hourly performance data
+     * @param {GetAllCpcAdsHourlyPerformanceParams} params Request parameters
+     * @param {string} params.performance_date Single date for hourly performance data in DD-MM-YYYY format
+     * @returns {Promise<GetAllCpcAdsHourlyPerformanceResponse>} Response containing hourly performance metrics
+     *
+     * This API is used to get Shop level CPC ads single-date hourly performance.
+     * The date must be today or earlier than today (up to 6 months ago).
+     *
+     * The response includes an array of hourly performance metrics with the following details for each hour:
+     * - hour: The hour the performance record belongs to
+     * - date: The date the performance record belongs to
+     * - impression: Number of times buyers see ads
+     * - clicks: Total number of clicks on the ad
+     * - ctr: Click-through rate (Clicks / Impressions)
+     * - direct_order: Orders placed within 7 days after clicking on the clicked ad
+     * - broad_order: Orders placed within 7 days after clicking on any ad from the same shop
+     * - direct_conversions: Direct conversion rate (clicked ad orders / total clicks)
+     * - broad_conversions: Broad conversion rate (any shop orders / total clicks)
+     * - direct_item_sold: Items sold from the clicked ad
+     * - broad_item_sold: Items sold from the shop after any ad click
+     * - direct_gmv: Total sales from the clicked ad
+     * - broad_gmv: Total sales from the shop after any ad click
+     * - expense: Ad expenditure
+     * - cost_per_conversion: Average cost per sales conversion
+     * - direct_roas: Direct return on ad spend (direct GMV / expense)
+     * - broad_roas: Broad return on ad spend (broad GMV / expense)
+     *
+     * Use this API to analyze hourly ad performance patterns for optimization.
+     */
+    getAllCpcAdsHourlyPerformance(params: GetAllCpcAdsHourlyPerformanceParams): Promise<GetAllCpcAdsHourlyPerformanceResponse>;
+    /**
+     * Get shop level CPC ads daily performance data for a date range
+     * @param {GetAllCpcAdsDailyPerformanceParams} params Request parameters
+     * @param {string} params.start_date Start date of the performance data range in DD-MM-YYYY format
+     * @param {string} params.end_date End date of the performance data range in DD-MM-YYYY format
+     * @returns {Promise<GetAllCpcAdsDailyPerformanceResponse>} Response containing daily performance metrics
+     *
+     * This API is used to get Shop level CPC ads multiple-days daily performance.
+     * The date range must be today or earlier than today (up to 6 months ago), and cannot exceed 1 month.
+     * Start date must be earlier than end date and cannot be equal to end date.
+     *
+     * The response includes an array of daily performance metrics with the following details for each day:
+     * - date: The date the performance record belongs to
+     * - impression: Number of times buyers see ads
+     * - clicks: Total number of clicks on the ad
+     * - ctr: Click-through rate (Clicks / Impressions)
+     * - direct_order: Orders placed within 7 days after clicking on the clicked ad
+     * - broad_order: Orders placed within 7 days after clicking on any ad from the same shop
+     * - direct_conversions: Direct conversion rate (clicked ad orders / total clicks)
+     * - broad_conversions: Broad conversion rate (any shop orders / total clicks)
+     * - direct_item_sold: Items sold from the clicked ad
+     * - broad_item_sold: Items sold from the shop after any ad click
+     * - direct_gmv: Total sales from the clicked ad
+     * - broad_gmv: Total sales from the shop after any ad click
+     * - expense: Ad expenditure
+     * - cost_per_conversion: Average cost per sales conversion
+     * - direct_roas: Direct return on ad spend (direct GMV / expense)
+     * - broad_roas: Broad return on ad spend (broad GMV / expense)
+     *
+     * Use this API to analyze daily ad performance trends over a time period.
+     */
+    getAllCpcAdsDailyPerformance(params: GetAllCpcAdsDailyPerformanceParams): Promise<GetAllCpcAdsDailyPerformanceResponse>;
+    /**
+     * Get product-level campaign performance data for a date range
+     * @param {GetProductCampaignDailyPerformanceParams} params Request parameters
+     * @param {string} params.start_date Start date of the performance data range in DD-MM-YYYY format
+     * @param {string} params.end_date End date of the performance data range in DD-MM-YYYY format
+     * @param {string} params.campaign_id_list Comma-separated list of campaign IDs to fetch performance for (max 100)
+     * @returns {Promise<GetProductCampaignDailyPerformanceResponse>} Response containing detailed campaign performance metrics
+     *
+     * This API is used to get product-level ads performance data across multiple days.
+     * The date range must be today or earlier than today (up to 6 months ago), and cannot exceed 1 month.
+     * Start date must be earlier than end date and cannot be equal to end date.
+     *
+     * The response is structured hierarchically with:
+     * - shop_id and region information
+     * - Detailed campaign list with campaign_id, ad_type, campaign_placement, and ad_name
+     * - Comprehensive daily metrics for each campaign including:
+     *   - Impressions, clicks, and CTR
+     *   - Expense (ad spend)
+     *   - Direct and broad performance metrics (orders, GMV, ROI)
+     *   - Conversion rates and cost efficiency metrics
+     *
+     * Direct metrics refer to performance of the advertised product specifically, while
+     * broad metrics account for any purchases from the shop after an ad click.
+     *
+     * Use this API to analyze campaign effectiveness at the product level and optimize
+     * your advertising strategy based on detailed performance data.
+     */
+    getProductCampaignDailyPerformance(params: GetProductCampaignDailyPerformanceParams): Promise<GetProductCampaignDailyPerformanceResponse>;
+    /**
+     * Get product-level campaign hourly performance data for a single day
+     * @param {GetProductCampaignHourlyPerformanceParams} params Request parameters
+     * @param {string} params.performance_date Single date for the hourly performance data in DD-MM-YYYY format
+     * @param {string} params.campaign_id_list Comma-separated list of campaign IDs to fetch performance for (max 100)
+     * @returns {Promise<GetProductCampaignHourlyPerformanceResponse>} Response containing detailed hourly campaign performance metrics
+     *
+     * This API is used to get product-level ads hourly performance data for a single day.
+     * The date must be today or earlier than today (up to 6 months ago).
+     *
+     * The response is structured hierarchically with:
+     * - shop_id and region information
+     * - Detailed campaign list with campaign_id, ad_type, campaign_placement, and ad_name
+     * - Comprehensive hourly metrics for each campaign including:
+     *   - Hour the performance record belongs to
+     *   - Impressions, clicks, and CTR
+     *   - Expense (ad spend)
+     *   - Direct and broad performance metrics (orders, GMV, ROI)
+     *   - Conversion rates and cost efficiency metrics
+     *
+     * Direct metrics refer to performance of the advertised product specifically, while
+     * broad metrics account for any purchases from the shop after an ad click.
+     *
+     * Use this API to analyze hourly campaign patterns and performance fluctuations
+     * throughout the day to optimize timing of ad campaigns and budget allocation.
+     */
+    getProductCampaignHourlyPerformance(params: GetProductCampaignHourlyPerformanceParams): Promise<GetProductCampaignHourlyPerformanceResponse>;
+    /**
+     * Get a list of all product-level campaign IDs for a shop
+     * @param {GetProductLevelCampaignIdListParams} [params] Optional request parameters
+     * @param {string} [params.ad_type] Filter campaigns by ad type (can be "", "all", "auto", or "manual")
+     * @param {number} [params.offset] Pagination offset for fetching subsequent pages
+     * @param {number} [params.limit] Page size limit (number of results to return)
+     * @returns {Promise<GetProductLevelCampaignIdListResponse>} Response containing campaign IDs and pagination info
+     *
+     * This API is used to fetch all product campaign IDs displayed on the advertiser platform
+     * for a specific shop. The results can be filtered by ad type and paginated using
+     * offset and limit parameters.
+     *
+     * The response contains:
+     * - shop_id: The unique identifier for the shop
+     * - region: The region where the shop is located
+     * - has_next_page: Indicates if there are more campaigns on the next page
+     * - campaign_list: List of campaigns with ad_type and campaign_id
+     *
+     * Use this API to retrieve campaign IDs that can then be used with other APIs
+     * like getProductCampaignDailyPerformance or getProductCampaignHourlyPerformance
+     * to fetch detailed performance metrics.
+     */
+    getProductLevelCampaignIdList(params?: GetProductLevelCampaignIdListParams): Promise<GetProductLevelCampaignIdListResponse>;
+    /**
+     * Get detailed settings information for product-level campaigns
+     * @param {GetProductLevelCampaignSettingInfoParams} params Request parameters
+     * @param {string} params.info_type_list Comma-separated list of info types to retrieve (1: Common Info, 2: Manual Bidding Info, 3: Auto Bidding Info, 4: Auto Product Ads Info)
+     * @param {string} params.campaign_id_list Comma-separated list of campaign IDs to fetch settings for (max 100)
+     * @returns {Promise<GetProductLevelCampaignSettingInfoResponse>} Response containing detailed campaign settings
+     *
+     * This API is used to retrieve detailed configuration settings for product-level ad campaigns.
+     * Depending on the info_type_list parameter, different types of information will be returned:
+     *
+     * Info type 1 (Common Info) includes:
+     * - Ad type (auto or manual)
+     * - Ad name and status
+     * - Bidding method and placement
+     * - Campaign budget and duration
+     * - List of item IDs in the campaign
+     *
+     * Info type 2 (Manual Bidding Info) includes:
+     * - Enhanced CPC setting
+     * - Selected keywords with match types and bid prices
+     * - Discovery ads placement settings
+     *
+     * Info type 3 (Auto Bidding Info) includes:
+     * - ROAS (Return on Ad Spend) target
+     *
+     * Info type 4 (Auto Product Ads Info) includes:
+     * - Product name and status
+     * - Item IDs
+     *
+     * Use this API to analyze and understand the detailed settings of your ad campaigns,
+     * which can help with optimization and decision-making for future campaign management.
+     */
+    getProductLevelCampaignSettingInfo(params: GetProductLevelCampaignSettingInfoParams): Promise<GetProductLevelCampaignSettingInfoResponse>;
+    /**
+     * Get recommended ROI target values for a product's ad campaign
+     * @param {GetProductRecommendedRoiTargetParams} params Request parameters
+     * @param {string} params.reference_id A random string used to prevent duplicate ads
+     * @param {number} params.item_id Unique identifier for a product
+     * @returns {Promise<GetProductRecommendedRoiTargetResponse>} Response containing recommended ROI targets
+     *
+     * This API is used to get recommended Return on Investment (ROI) target values for
+     * a product's ad campaign. These recommendations help sellers set competitive ROI
+     * targets for their advertising campaigns.
+     *
+     * The response includes three recommendation levels:
+     *
+     * - Lower bound: A more competitive target (e.g., value=3.5, percentile=80) that makes
+     *   the ad more competitive than 80% of similar ads.
+     *
+     * - Exact (mid-level): A balanced target (e.g., value=5.9, percentile=50) that makes
+     *   the ad more competitive than 50% of similar ads.
+     *
+     * - Upper bound: A less competitive target (e.g., value=10.8, percentile=20) that makes
+     *   the ad more competitive than 20% of similar ads.
+     *
+     * Each recommendation includes:
+     * - value: The recommended ROI target value
+     * - percentile: Indicates how competitive this target is compared to similar ads
+     *
+     * Use this API to help determine optimal ROI targets for your advertising strategy
+     * based on competitive marketplace data.
+     */
+    getProductRecommendedRoiTarget(params: GetProductRecommendedRoiTargetParams): Promise<GetProductRecommendedRoiTargetResponse>;
 }

package/lib/managers/ads.manager.js

@@ -70,5 +70,280 @@ export class AdsManager extends BaseManager {
         });
         return response;
     }
+    /**
+     * Get the list of recommended SKUs (Shop level) with the corresponding tag
+     * @returns {Promise<GetRecommendedItemListResponse>} Response containing recommended items
+     *
+     * This API is used to get the list of recommended SKU (Shop level) with the corresponding tag,
+     * i.e top search/best selling/best ROI tag.
+     *
+     * The response includes an array of items with the following details for each item:
+     * - item_id: Recommended SKU's item id
+     * - item_status_list: Status of items (indicates whether an item is eligible for ads or not)
+     * - sku_tag_list: Tags such as "best selling", "best ROI", "top search"
+     * - ongoing_ad_type_list: Current status of ads on this item (e.g., search ads, discovery ads)
+     *
+     * Use this API to identify high-potential items for advertising campaigns.
+     */
+    async getRecommendedItemList() {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_recommended_item_list', {
+            method: 'GET',
+            auth: true,
+        });
+        return response;
+    }
+    /**
+     * Get shop level CPC ads single-date hourly performance data
+     * @param {GetAllCpcAdsHourlyPerformanceParams} params Request parameters
+     * @param {string} params.performance_date Single date for hourly performance data in DD-MM-YYYY format
+     * @returns {Promise<GetAllCpcAdsHourlyPerformanceResponse>} Response containing hourly performance metrics
+     *
+     * This API is used to get Shop level CPC ads single-date hourly performance.
+     * The date must be today or earlier than today (up to 6 months ago).
+     *
+     * The response includes an array of hourly performance metrics with the following details for each hour:
+     * - hour: The hour the performance record belongs to
+     * - date: The date the performance record belongs to
+     * - impression: Number of times buyers see ads
+     * - clicks: Total number of clicks on the ad
+     * - ctr: Click-through rate (Clicks / Impressions)
+     * - direct_order: Orders placed within 7 days after clicking on the clicked ad
+     * - broad_order: Orders placed within 7 days after clicking on any ad from the same shop
+     * - direct_conversions: Direct conversion rate (clicked ad orders / total clicks)
+     * - broad_conversions: Broad conversion rate (any shop orders / total clicks)
+     * - direct_item_sold: Items sold from the clicked ad
+     * - broad_item_sold: Items sold from the shop after any ad click
+     * - direct_gmv: Total sales from the clicked ad
+     * - broad_gmv: Total sales from the shop after any ad click
+     * - expense: Ad expenditure
+     * - cost_per_conversion: Average cost per sales conversion
+     * - direct_roas: Direct return on ad spend (direct GMV / expense)
+     * - broad_roas: Broad return on ad spend (broad GMV / expense)
+     *
+     * Use this API to analyze hourly ad performance patterns for optimization.
+     */
+    async getAllCpcAdsHourlyPerformance(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_all_cpc_ads_hourly_performance', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get shop level CPC ads daily performance data for a date range
+     * @param {GetAllCpcAdsDailyPerformanceParams} params Request parameters
+     * @param {string} params.start_date Start date of the performance data range in DD-MM-YYYY format
+     * @param {string} params.end_date End date of the performance data range in DD-MM-YYYY format
+     * @returns {Promise<GetAllCpcAdsDailyPerformanceResponse>} Response containing daily performance metrics
+     *
+     * This API is used to get Shop level CPC ads multiple-days daily performance.
+     * The date range must be today or earlier than today (up to 6 months ago), and cannot exceed 1 month.
+     * Start date must be earlier than end date and cannot be equal to end date.
+     *
+     * The response includes an array of daily performance metrics with the following details for each day:
+     * - date: The date the performance record belongs to
+     * - impression: Number of times buyers see ads
+     * - clicks: Total number of clicks on the ad
+     * - ctr: Click-through rate (Clicks / Impressions)
+     * - direct_order: Orders placed within 7 days after clicking on the clicked ad
+     * - broad_order: Orders placed within 7 days after clicking on any ad from the same shop
+     * - direct_conversions: Direct conversion rate (clicked ad orders / total clicks)
+     * - broad_conversions: Broad conversion rate (any shop orders / total clicks)
+     * - direct_item_sold: Items sold from the clicked ad
+     * - broad_item_sold: Items sold from the shop after any ad click
+     * - direct_gmv: Total sales from the clicked ad
+     * - broad_gmv: Total sales from the shop after any ad click
+     * - expense: Ad expenditure
+     * - cost_per_conversion: Average cost per sales conversion
+     * - direct_roas: Direct return on ad spend (direct GMV / expense)
+     * - broad_roas: Broad return on ad spend (broad GMV / expense)
+     *
+     * Use this API to analyze daily ad performance trends over a time period.
+     */
+    async getAllCpcAdsDailyPerformance(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_all_cpc_ads_daily_performance', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get product-level campaign performance data for a date range
+     * @param {GetProductCampaignDailyPerformanceParams} params Request parameters
+     * @param {string} params.start_date Start date of the performance data range in DD-MM-YYYY format
+     * @param {string} params.end_date End date of the performance data range in DD-MM-YYYY format
+     * @param {string} params.campaign_id_list Comma-separated list of campaign IDs to fetch performance for (max 100)
+     * @returns {Promise<GetProductCampaignDailyPerformanceResponse>} Response containing detailed campaign performance metrics
+     *
+     * This API is used to get product-level ads performance data across multiple days.
+     * The date range must be today or earlier than today (up to 6 months ago), and cannot exceed 1 month.
+     * Start date must be earlier than end date and cannot be equal to end date.
+     *
+     * The response is structured hierarchically with:
+     * - shop_id and region information
+     * - Detailed campaign list with campaign_id, ad_type, campaign_placement, and ad_name
+     * - Comprehensive daily metrics for each campaign including:
+     *   - Impressions, clicks, and CTR
+     *   - Expense (ad spend)
+     *   - Direct and broad performance metrics (orders, GMV, ROI)
+     *   - Conversion rates and cost efficiency metrics
+     *
+     * Direct metrics refer to performance of the advertised product specifically, while
+     * broad metrics account for any purchases from the shop after an ad click.
+     *
+     * Use this API to analyze campaign effectiveness at the product level and optimize
+     * your advertising strategy based on detailed performance data.
+     */
+    async getProductCampaignDailyPerformance(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_product_campaign_daily_performance', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get product-level campaign hourly performance data for a single day
+     * @param {GetProductCampaignHourlyPerformanceParams} params Request parameters
+     * @param {string} params.performance_date Single date for the hourly performance data in DD-MM-YYYY format
+     * @param {string} params.campaign_id_list Comma-separated list of campaign IDs to fetch performance for (max 100)
+     * @returns {Promise<GetProductCampaignHourlyPerformanceResponse>} Response containing detailed hourly campaign performance metrics
+     *
+     * This API is used to get product-level ads hourly performance data for a single day.
+     * The date must be today or earlier than today (up to 6 months ago).
+     *
+     * The response is structured hierarchically with:
+     * - shop_id and region information
+     * - Detailed campaign list with campaign_id, ad_type, campaign_placement, and ad_name
+     * - Comprehensive hourly metrics for each campaign including:
+     *   - Hour the performance record belongs to
+     *   - Impressions, clicks, and CTR
+     *   - Expense (ad spend)
+     *   - Direct and broad performance metrics (orders, GMV, ROI)
+     *   - Conversion rates and cost efficiency metrics
+     *
+     * Direct metrics refer to performance of the advertised product specifically, while
+     * broad metrics account for any purchases from the shop after an ad click.
+     *
+     * Use this API to analyze hourly campaign patterns and performance fluctuations
+     * throughout the day to optimize timing of ad campaigns and budget allocation.
+     */
+    async getProductCampaignHourlyPerformance(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_product_campaign_hourly_performance', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get a list of all product-level campaign IDs for a shop
+     * @param {GetProductLevelCampaignIdListParams} [params] Optional request parameters
+     * @param {string} [params.ad_type] Filter campaigns by ad type (can be "", "all", "auto", or "manual")
+     * @param {number} [params.offset] Pagination offset for fetching subsequent pages
+     * @param {number} [params.limit] Page size limit (number of results to return)
+     * @returns {Promise<GetProductLevelCampaignIdListResponse>} Response containing campaign IDs and pagination info
+     *
+     * This API is used to fetch all product campaign IDs displayed on the advertiser platform
+     * for a specific shop. The results can be filtered by ad type and paginated using
+     * offset and limit parameters.
+     *
+     * The response contains:
+     * - shop_id: The unique identifier for the shop
+     * - region: The region where the shop is located
+     * - has_next_page: Indicates if there are more campaigns on the next page
+     * - campaign_list: List of campaigns with ad_type and campaign_id
+     *
+     * Use this API to retrieve campaign IDs that can then be used with other APIs
+     * like getProductCampaignDailyPerformance or getProductCampaignHourlyPerformance
+     * to fetch detailed performance metrics.
+     */
+    async getProductLevelCampaignIdList(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_product_level_campaign_id_list', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get detailed settings information for product-level campaigns
+     * @param {GetProductLevelCampaignSettingInfoParams} params Request parameters
+     * @param {string} params.info_type_list Comma-separated list of info types to retrieve (1: Common Info, 2: Manual Bidding Info, 3: Auto Bidding Info, 4: Auto Product Ads Info)
+     * @param {string} params.campaign_id_list Comma-separated list of campaign IDs to fetch settings for (max 100)
+     * @returns {Promise<GetProductLevelCampaignSettingInfoResponse>} Response containing detailed campaign settings
+     *
+     * This API is used to retrieve detailed configuration settings for product-level ad campaigns.
+     * Depending on the info_type_list parameter, different types of information will be returned:
+     *
+     * Info type 1 (Common Info) includes:
+     * - Ad type (auto or manual)
+     * - Ad name and status
+     * - Bidding method and placement
+     * - Campaign budget and duration
+     * - List of item IDs in the campaign
+     *
+     * Info type 2 (Manual Bidding Info) includes:
+     * - Enhanced CPC setting
+     * - Selected keywords with match types and bid prices
+     * - Discovery ads placement settings
+     *
+     * Info type 3 (Auto Bidding Info) includes:
+     * - ROAS (Return on Ad Spend) target
+     *
+     * Info type 4 (Auto Product Ads Info) includes:
+     * - Product name and status
+     * - Item IDs
+     *
+     * Use this API to analyze and understand the detailed settings of your ad campaigns,
+     * which can help with optimization and decision-making for future campaign management.
+     */
+    async getProductLevelCampaignSettingInfo(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_product_level_campaign_setting_info', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
+    /**
+     * Get recommended ROI target values for a product's ad campaign
+     * @param {GetProductRecommendedRoiTargetParams} params Request parameters
+     * @param {string} params.reference_id A random string used to prevent duplicate ads
+     * @param {number} params.item_id Unique identifier for a product
+     * @returns {Promise<GetProductRecommendedRoiTargetResponse>} Response containing recommended ROI targets
+     *
+     * This API is used to get recommended Return on Investment (ROI) target values for
+     * a product's ad campaign. These recommendations help sellers set competitive ROI
+     * targets for their advertising campaigns.
+     *
+     * The response includes three recommendation levels:
+     *
+     * - Lower bound: A more competitive target (e.g., value=3.5, percentile=80) that makes
+     *   the ad more competitive than 80% of similar ads.
+     *
+     * - Exact (mid-level): A balanced target (e.g., value=5.9, percentile=50) that makes
+     *   the ad more competitive than 50% of similar ads.
+     *
+     * - Upper bound: A less competitive target (e.g., value=10.8, percentile=20) that makes
+     *   the ad more competitive than 20% of similar ads.
+     *
+     * Each recommendation includes:
+     * - value: The recommended ROI target value
+     * - percentile: Indicates how competitive this target is compared to similar ads
+     *
+     * Use this API to help determine optimal ROI targets for your advertising strategy
+     * based on competitive marketplace data.
+     */
+    async getProductRecommendedRoiTarget(params) {
+        const response = await ShopeeFetch.fetch(this.config, '/ads/get_product_recommended_roi_target', {
+            method: 'GET',
+            auth: true,
+            params,
+        });
+        return response;
+    }
 }
 //# sourceMappingURL=ads.manager.js.map

package/lib/managers/ads.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"ads.manager.js","sourceRoot":"","sources":["../../src/managers/ads.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,UAAW,SAAQ,WAAW;IACvC,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,2BAA2B,EAC3B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,yBAAyB,CAAC,MAAuC;QACrE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,mCAAmC,EACnC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACJ"}
+{"version":3,"file":"ads.manager.js","sourceRoot":"","sources":["../../src/managers/ads.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,UAAW,SAAQ,WAAW;IACvC,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,2BAA2B,EAC3B;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,yBAAyB,CAAC,MAAuC;QACrE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,mCAAmC,EACnC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,sBAAsB;QAC1B,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,gCAAgC,EAChC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,6BAA6B,CAAC,MAA2C;QAC7E,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yCAAyC,EACzC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,4BAA4B,CAAC,MAA0C;QAC3E,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,wCAAwC,EACxC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,kCAAkC,CAAC,MAAgD;QACvF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,6CAA6C,EAC7C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,mCAAmC,CAAC,MAAiD;QACzF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8CAA8C,EAC9C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,6BAA6B,CAAC,MAA4C;QAC9E,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yCAAyC,EACzC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,kCAAkC,CAAC,MAAgD;QACvF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,8CAA8C,EAC9C;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,8BAA8B,CAAC,MAA4C;QAC/E,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,yCAAyC,EACzC;YACE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM;SACP,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACJ"}

package/lib/schemas/ads.d.ts

@@ -60,3 +60,459 @@ export interface GetRecommendedKeywordListResponse extends BaseResponse {
     /** Optional warning message if some data cannot be responded normally */
     warning?: string;
 }
+/**
+ * Response for the get recommended item list API
+ */
+export interface GetRecommendedItemListResponse extends BaseResponse {
+    response: Array<{
+        /** Recommended SKU's item id */
+        item_id: number;
+        /** This is param to indicate the status of items, so sellers can know whether an item is eligible for ads or not */
+        item_status_list: string[];
+        /** The corresponding tag (or tags) that belong to item_id, sequences follow as best selling>best ROI>top search */
+        sku_tag_list: string[];
+        /** Current status of the ad on this item. For example- no ongoing promotion, search ads, discovery ads, boost ads */
+        ongoing_ad_type_list: string[];
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get all CPC ads hourly performance API
+ */
+export type GetAllCpcAdsHourlyPerformanceParams = {
+    /** Single date on which to check the hourly performance (DD-MM-YYYY format) */
+    performance_date: string;
+};
+/**
+ * Response for the get all CPC ads hourly performance API
+ */
+export interface GetAllCpcAdsHourlyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** Hour the performance record belongs to */
+        hour: number;
+        /** Date the performance record belongs to (DD-MM-YYYY format) */
+        date: string;
+        /** Number of times buyers see ads */
+        impression: number;
+        /** Total number of clicks on the Ad */
+        clicks: number;
+        /** Click-through rate (Clicks / Impressions) */
+        ctr: number;
+        /** Direct conversions - buyer placed an order within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_order: number;
+        /** Broad conversions - buyer placed an order within 7 days after clicking on the ads (any item from the same shop) */
+        broad_order: number;
+        /** Direct conversion rate (Ad orders / total clicks) - item gets purchased from the clicked ads */
+        direct_conversions: number;
+        /** Broad conversion rate (Ad orders / total clicks) - any item from the same shop gets purchased */
+        broad_conversions: number;
+        /** Items sold within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_item_sold: number;
+        /** Items sold within 7 days after clicking on the ads (any item from the same shop) */
+        broad_item_sold: number;
+        /** Total direct sales generated from ads over a 7-day window (item gets purchased from the clicked ads) */
+        direct_gmv: number;
+        /** Total broad sales generated from ads over a 7-day window (any item from the same shop) */
+        broad_gmv: number;
+        /** Ad expenditure */
+        expense: number;
+        /** Cost per conversion - ad's average cost per sales conversion */
+        cost_per_conversion: number;
+        /** Direct ROAS - Ad GMV/Ad Expenditure (item gets purchased from the clicked ads) */
+        direct_roas: number;
+        /** Broad ROAS - Ad GMV/Ad Expenditure (any item from the same shop gets purchased) */
+        broad_roas: number;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get all CPC ads daily performance API
+ */
+export type GetAllCpcAdsDailyPerformanceParams = {
+    /** Start date of the performance data range (DD-MM-YYYY format) */
+    start_date: string;
+    /** End date of the performance data range (DD-MM-YYYY format) */
+    end_date: string;
+};
+/**
+ * Response for the get all CPC ads daily performance API
+ */
+export interface GetAllCpcAdsDailyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** Date the performance record belongs to (DD-MM-YYYY format) */
+        date: string;
+        /** Number of times buyers see ads */
+        impression: number;
+        /** Total number of clicks on the Ad */
+        clicks: number;
+        /** Click-through rate (Clicks / Impressions) */
+        ctr: number;
+        /** Direct conversions - buyer placed an order within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_order: number;
+        /** Broad conversions - buyer placed an order within 7 days after clicking on the ads (any item from the same shop) */
+        broad_order: number;
+        /** Direct conversion rate (Ad orders / total clicks) - item gets purchased from the clicked ads */
+        direct_conversions: number;
+        /** Broad conversion rate (Ad orders / total clicks) - any item from the same shop gets purchased */
+        broad_conversions: number;
+        /** Items sold within 7 days after clicking on the ads (item gets purchased from the clicked ads) */
+        direct_item_sold: number;
+        /** Items sold within 7 days after clicking on the ads (any item from the same shop) */
+        broad_item_sold: number;
+        /** Total direct sales generated from ads over a 7-day window (item gets purchased from the clicked ads) */
+        direct_gmv: number;
+        /** Total broad sales generated from ads over a 7-day window (any item from the same shop) */
+        broad_gmv: number;
+        /** Ad expenditure */
+        expense: number;
+        /** Cost per conversion - ad's average cost per sales conversion */
+        cost_per_conversion: number;
+        /** Direct ROAS - Ad GMV/Ad Expenditure (item gets purchased from the clicked ads) */
+        direct_roas: number;
+        /** Broad ROAS - Ad GMV/Ad Expenditure (any item from the same shop gets purchased) */
+        broad_roas: number;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product campaign daily performance API
+ */
+export type GetProductCampaignDailyPerformanceParams = {
+    /** Start date of the performance data range (DD-MM-YYYY format) */
+    start_date: string;
+    /** End date of the performance data range (DD-MM-YYYY format) */
+    end_date: string;
+    /** Comma-separated list of campaign IDs to fetch performance for (max 100) */
+    campaign_id_list: string;
+};
+/**
+ * Response for the get product campaign daily performance API
+ */
+export interface GetProductCampaignDailyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** List of campaigns and their performance data */
+        campaign_list: Array<{
+            /** The unique ID for the campaign */
+            campaign_id: number;
+            /** The ad type (auto or manual) */
+            ad_type: string;
+            /** The campaign placement (search, discovery, or all) */
+            campaign_placement: string;
+            /** The name of the ad */
+            ad_name: string;
+            /** List of daily performance metrics for the campaign */
+            metrics_list: Array<{
+                /** Date of the performance record (DD-MM-YYYY format) */
+                date: string;
+                /** Number of times shoppers see the ad */
+                impression: number;
+                /** Number of times shoppers click on the ad */
+                clicks: number;
+                /** Click-through rate (clicks ÷ impressions × 100%) */
+                ctr: number;
+                /** Amount spent on the ad */
+                expense: number;
+                /** Sales revenue generated from any product purchase within 7 days of ad click */
+                broad_gmv: number;
+                /** Number of orders placed within 7 days of ad click */
+                broad_order: number;
+                /** Total quantity of products purchased within 7 days of ad click */
+                broad_order_amount: number;
+                /** Broad return on ad spend (broad_gmv ÷ expense) */
+                broad_roi: number;
+                /** Broad advertising cost of sales (expense ÷ broad_gmv × 100%) */
+                broad_cir: number;
+                /** Conversion rate (conversions ÷ clicks × 100%) */
+                cr: number;
+                /** Cost per conversion (expense ÷ conversions) */
+                cpc: number;
+                /** Number of orders for the advertised product within 7 days of ad click */
+                direct_order: number;
+                /** Total quantity of the advertised product purchased within 7 days of ad click */
+                direct_order_amount: number;
+                /** Sales revenue generated from the advertised product within 7 days of ad click */
+                direct_gmv: number;
+                /** Direct return on ad spend (direct_gmv ÷ expense) */
+                direct_roi: number;
+                /** Direct advertising cost of sales (expense ÷ direct_gmv × 100%) */
+                direct_cir: number;
+                /** Direct conversion rate (direct conversions ÷ clicks × 100%) */
+                direct_cr: number;
+                /** Cost per direct conversion (expense ÷ direct conversions) */
+                cpdc: number;
+            }>;
+        }>;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product campaign hourly performance API
+ */
+export type GetProductCampaignHourlyPerformanceParams = {
+    /** Single date for the hourly performance data (DD-MM-YYYY format) */
+    performance_date: string;
+    /** Comma-separated list of campaign IDs to fetch performance for (max 100) */
+    campaign_id_list: string;
+};
+/**
+ * Response for the get product campaign hourly performance API
+ */
+export interface GetProductCampaignHourlyPerformanceResponse extends BaseResponse {
+    response: Array<{
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** List of campaigns and their performance data */
+        campaign_list: Array<{
+            /** The unique ID for the campaign */
+            campaign_id: number;
+            /** The ad type (auto or manual) */
+            ad_type: string;
+            /** The campaign placement (search, discovery, or all) */
+            campaign_placement: string;
+            /** The name of the ad */
+            ad_name: string;
+            /** List of hourly performance metrics for the campaign */
+            metrics_list: Array<{
+                /** Hour the performance record belongs to */
+                hour: number;
+                /** Date of the performance record (DD-MM-YYYY format) */
+                date: string;
+                /** Number of times shoppers see the ad */
+                impression: number;
+                /** Number of times shoppers click on the ad */
+                clicks: number;
+                /** Click-through rate (clicks ÷ impressions × 100%) */
+                ctr: number;
+                /** Amount spent on the ad */
+                expense: number;
+                /** Sales revenue generated from any product purchase within 7 days of ad click */
+                broad_gmv: number;
+                /** Number of orders placed within 7 days of ad click */
+                broad_order: number;
+                /** Total quantity of products purchased within 7 days of ad click */
+                broad_order_amount: number;
+                /** Broad return on ad spend (broad_gmv ÷ expense) */
+                broad_roi: number;
+                /** Broad advertising cost of sales (expense ÷ broad_gmv × 100%) */
+                broad_cir: number;
+                /** Conversion rate (conversions ÷ clicks × 100%) */
+                cr: number;
+                /** Cost per conversion (expense ÷ conversions) */
+                cpc: number;
+                /** Number of orders for the advertised product within 7 days of ad click */
+                direct_order: number;
+                /** Total quantity of the advertised product purchased within 7 days of ad click */
+                direct_order_amount: number;
+                /** Sales revenue generated from the advertised product within 7 days of ad click */
+                direct_gmv: number;
+                /** Direct return on ad spend (direct_gmv ÷ expense) */
+                direct_roi: number;
+                /** Direct advertising cost of sales (expense ÷ direct_gmv × 100%) */
+                direct_cir: number;
+                /** Direct conversion rate (direct conversions ÷ clicks × 100%) */
+                direct_cr: number;
+                /** Cost per direct conversion (expense ÷ direct conversions) */
+                cpdc: number;
+            }>;
+        }>;
+    }>;
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product level campaign ID list API
+ */
+export type GetProductLevelCampaignIdListParams = {
+    /**
+     * Filter campaigns by ad type
+     * Can be any of ["", "all", "auto", "manual"]
+     */
+    ad_type?: string;
+    /** Pagination offset */
+    offset?: number;
+    /** Page size limit (number of results to return) */
+    limit?: number;
+};
+/**
+ * Response for the get product level campaign ID list API
+ */
+export interface GetProductLevelCampaignIdListResponse extends BaseResponse {
+    response: {
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** Indicates if there are more campaigns on the next page */
+        has_next_page: boolean;
+        /** List of campaigns */
+        campaign_list: Array<{
+            /** The ad type (auto or manual) */
+            ad_type: string;
+            /** The unique ID for the campaign */
+            campaign_id: number;
+        }>;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product level campaign setting info API
+ */
+export type GetProductLevelCampaignSettingInfoParams = {
+    /**
+     * Info types to retrieve, comma-separated
+     * 1: Common Info
+     * 2: Manual Bidding Info
+     * 3: Auto Bidding Info
+     * 4: Auto Product Ads Info
+     */
+    info_type_list: string;
+    /** Comma-separated list of campaign IDs to fetch settings for (max 100) */
+    campaign_id_list: string;
+};
+/**
+ * Response for the get product level campaign setting info API
+ */
+export interface GetProductLevelCampaignSettingInfoResponse extends BaseResponse {
+    response: {
+        /** The unique ID for the shop */
+        shop_id: number;
+        /** The region where the shop is located */
+        region: string;
+        /** List of campaigns with their settings */
+        campaign_list: Array<{
+            /** The unique ID for the campaign */
+            campaign_id: number;
+            /** Common campaign information (returned if info_type_list includes 1) */
+            common_info?: {
+                /** The ad type (auto or manual) */
+                ad_type: string;
+                /** The name of the ad */
+                ad_name: string;
+                /** Campaign status (ongoing, scheduled, ended, paused, deleted, closed) */
+                campaign_status: string;
+                /** Bidding method (auto or manual) */
+                bidding_method: string;
+                /** Campaign placement (search, discovery, or all) */
+                campaign_placement: string;
+                /** The budget per campaign (0 means unlimited budget) */
+                campaign_budget: number;
+                /** Campaign duration */
+                campaign_duration: {
+                    /** Campaign start time (Unix timestamp) */
+                    start_time: number;
+                    /** Campaign end time (Unix timestamp, 0 means no end date) */
+                    end_time: number;
+                };
+                /** List of item IDs in the campaign */
+                item_id_list: number[];
+            };
+            /** Manual bidding information (returned if info_type_list includes 2) */
+            manual_bidding_info?: {
+                /** Whether Enhanced CPC functionality is enabled */
+                enhanced_cpc: boolean;
+                /** Selected keywords for search campaigns */
+                selected_keywords: Array<{
+                    /** Bid keyword */
+                    keyword: string;
+                    /** Keyword status (deleted, normal, reserved, blacklist) */
+                    status: string;
+                    /** Match type (exact or broad) */
+                    match_type: string;
+                    /** Bid price per click */
+                    bid_price_per_click: number;
+                }>;
+                /** Discovery ads placement settings */
+                discovery_ads_locations: Array<{
+                    /** Location (daily_discover, you_may_also_like) */
+                    location: string;
+                    /** Status (active or inactive) */
+                    status: string;
+                    /** Bid price */
+                    bid_price: number;
+                }>;
+            };
+            /** Auto bidding information (returned if info_type_list includes 3) */
+            auto_bidding_info?: {
+                /** ROAS target for campaigns with auto bidding */
+                roas_target: number;
+            };
+            /** Auto product ads information (returned if info_type_list includes 4) */
+            auto_product_ads_info?: Array<{
+                /** Product name */
+                product_name: string;
+                /** Product status (learning, ongoing, paused, ended, unavailable) */
+                status: string;
+                /** Unique identifier for the product */
+                item_id: number;
+            }>;
+        }>;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get product recommended ROI target API
+ */
+export type GetProductRecommendedRoiTargetParams = {
+    /**
+     * A random string used to prevent duplicate ads.
+     * If an ads is created successfully, subsequent requests using the same reference id will fail.
+     * Use the same string for calling suggestion/recommendation API before the actual request to create an ads.
+     */
+    reference_id: string;
+    /** Unique identifier for a product */
+    item_id: number;
+};
+/**
+ * Response for the get product recommended ROI target API
+ */
+export interface GetProductRecommendedRoiTargetResponse extends BaseResponse {
+    response: {
+        /**
+         * Lower bound recommendation.
+         * e.g., value=3.5 and percentile=80 mean that setting an ROI target of 3.5
+         * makes the ads more competitive than 80% of similar ads.
+         */
+        lower_bound: {
+            /** The ROI target value */
+            value: number;
+            /** Competitiveness over similar ads */
+            percentile: number;
+        };
+        /**
+         * Mid-level recommendation.
+         * e.g., value=5.9 and percentile=50 mean that setting an ROI target of 5.9
+         * makes the ads more competitive than 50% of similar ads.
+         */
+        exact: {
+            /** The ROI target value */
+            value: number;
+            /** Competitiveness over similar ads */
+            percentile: number;
+        };
+        /**
+         * Higher bound recommendation.
+         * e.g., value=10.8 and percentile=20 mean that setting an ROI target of 10.8
+         * makes the ads more competitive than 20% of similar ads.
+         */
+        upper_bound: {
+            /** The ROI target value */
+            value: number;
+            /** Competitiveness over similar ads */
+            percentile: number;
+        };
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}

package/lib/schemas/index.d.ts

@@ -9,3 +9,4 @@ export * from './product.js';
 export * from './public.js';
 export * from './push.js';
 export * from './region.js';
+export * from './ads.js';

package/lib/schemas/index.js

@@ -9,4 +9,5 @@ export * from './product.js';
 export * from './public.js';
 export * from './push.js';
 export * from './region.js';
+export * from './ads.js';
 //# sourceMappingURL=index.js.map

package/lib/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@congminh1254/shopee-sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Shopee SDK maintaining by community",
   "type": "module",
   "main": "./lib/sdk.js",