@congminh1254/shopee-sdk 0.10.0 → 1.0.0

package/lib/schemas/ads.d.ts

@@ -516,3 +516,440 @@ export interface GetProductRecommendedRoiTargetResponse extends BaseResponse {
     /** Optional warning message if some data cannot be responded normally */
     warning?: string;
 }
+/**
+ * Response for the check create GMS product campaign eligibility API
+ */
+export interface CheckCreateGmsProductCampaignEligibilityResponse extends BaseResponse {
+    response: {
+        /** Indicates if the seller is eligible to create a GMS Campaign */
+        is_eligible: boolean;
+        /**
+         * The reason for not being able to create a GMS Campaign. Possible values:
+         * - active_campaign: There is already an existing GMS Campaign that is active
+         * - not_whitelisted: The seller is not whitelisted to sz_shop_gmv_max_feature
+         * - not_have_enough_sku: The seller does not have enough valid items in the shop
+         * - exclusive_with_other_campaign: Seller is whitelisted to sz_ads_auto_boost
+         */
+        reason?: string;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the create auto product ads API
+ */
+export type CreateAutoProductAdsParams = {
+    /** A random string used to prevent duplicate ads */
+    reference_id: string;
+    /** The budget set for the Auto Product Ads */
+    budget: number;
+    /** Start date of the campaign (DD-MM-YYYY format) */
+    start_date: string;
+    /** End date of the campaign (DD-MM-YYYY format). Leave empty for unlimited duration */
+    end_date?: string;
+};
+/**
+ * Response for the create auto product ads API
+ */
+export interface CreateAutoProductAdsResponse extends BaseResponse {
+    response: {
+        /** The unique identifier for the created campaign */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the create GMS product campaign API
+ */
+export type CreateGmsProductCampaignParams = {
+    /** Start date of Campaign (DD-MM-YYYY format). Cannot be earlier than today. */
+    start_date: string;
+    /** End date of Campaign (DD-MM-YYYY format). Do not fill if no end date. */
+    end_date?: string;
+    /** Daily budget for Campaign */
+    daily_budget: number;
+    /** A random string used to prevent duplicate ads */
+    reference_id?: string;
+    /**
+     * ROAS target for the campaign:
+     * - No input or 0: GMV Max Auto Bidding (Shop)
+     * - Greater than 0: GMV Max Custom ROAS (Shop)
+     */
+    roas_target?: number;
+};
+/**
+ * Response for the create GMS product campaign API
+ */
+export interface CreateGmsProductCampaignResponse extends BaseResponse {
+    response: {
+        /** GMS Campaign ID */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the create manual product ads API
+ */
+export type CreateManualProductAdsParams = {
+    /** A random string used to prevent duplicate ads */
+    reference_id: string;
+    /** The budget set for the Manual Product Ads */
+    budget: number;
+    /** Start date of the campaign (DD-MM-YYYY format) */
+    start_date: string;
+    /** End date of the campaign (DD-MM-YYYY format). Leave empty for unlimited duration */
+    end_date?: string;
+    /** Bidding method: "auto" or "manual" */
+    bidding_method: string;
+    /** Product ID */
+    item_id: number;
+    /** ROAS target for campaigns with auto bidding. If 0, GMV Max / ROI feature is not enabled */
+    roas_target?: number;
+    /** Selected keywords, required for manual bidding mode */
+    selected_keywords?: Array<{
+        /** Keyword text */
+        keyword: string;
+        /** Match type: "exact" or "broad" */
+        match_type: string;
+        /** Bid price per click */
+        bid_price_per_click: number;
+    }>;
+    /** Location settings for manual bidding method */
+    discovery_ads_locations?: Array<{
+        /** Location: "daily_discover" or "you_may_also_like" */
+        location: string;
+        /** Bid price */
+        bid_price: number;
+    }>;
+    /** Enhanced CPC functionality toggle */
+    enhanced_cpc?: boolean;
+    /** Smart Creative setting: "", "default", "on", or "off" */
+    smart_creative_setting?: string;
+};
+/**
+ * Response for the create manual product ads API
+ */
+export interface CreateManualProductAdsResponse extends BaseResponse {
+    response: {
+        /** The unique identifier for the created campaign */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the edit auto product ads API
+ */
+export type EditAutoProductAdsParams = {
+    /** A random string used to prevent duplicate ads */
+    reference_id: string;
+    /** The unique identifier for the campaign */
+    campaign_id: number;
+    /** The update action: "status", "budget", or "duration" */
+    edit_action: string;
+    /** The budget set for the Auto Product Ads */
+    budget?: number;
+    /** Start date of the campaign (DD-MM-YYYY format) */
+    start_date?: string;
+    /** End date of the campaign (DD-MM-YYYY format) */
+    end_date?: string;
+};
+/**
+ * Response for the edit auto product ads API
+ */
+export interface EditAutoProductAdsResponse extends BaseResponse {
+    response: {
+        /** The unique identifier for the campaign */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the edit GMS item product campaign API
+ */
+export type EditGmsItemProductCampaignParams = {
+    /** The GMS Campaign ID */
+    campaign_id?: number;
+    /** The action to perform: "add" or "remove" */
+    edit_action: string;
+    /** Item IDs to add/remove (minimum 1, maximum 30) */
+    item_id_list: number[];
+};
+/**
+ * Response for the edit GMS item product campaign API
+ */
+export interface EditGmsItemProductCampaignResponse extends BaseResponse {
+    response: {
+        /** GMS Campaign ID */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the edit GMS product campaign API
+ */
+export type EditGmsProductCampaignParams = {
+    /** The GMS Campaign ID */
+    campaign_id: number;
+    /** The action to perform */
+    edit_action: string;
+    /** Daily budget for Campaign */
+    daily_budget?: number;
+    /** Start date of Campaign (DD-MM-YYYY format) */
+    start_date?: string;
+    /** End date of Campaign (DD-MM-YYYY format) */
+    end_date?: string;
+    /** ROAS target for the campaign */
+    roas_target?: number;
+};
+/**
+ * Response for the edit GMS product campaign API
+ */
+export interface EditGmsProductCampaignResponse extends BaseResponse {
+    response: {
+        /** GMS Campaign ID */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the edit manual product ad keywords API
+ */
+export type EditManualProductAdKeywordsParams = {
+    /** A random string used to prevent duplicate ads */
+    reference_id: string;
+    /** The unique identifier for the campaign */
+    campaign_id: number;
+    /** The action to perform: "add", "edit", or "delete" */
+    edit_action: string;
+    /** Selected keywords to add, edit, or delete */
+    selected_keywords?: Array<{
+        /** Keyword text */
+        keyword: string;
+        /** Match type: "exact" or "broad" */
+        match_type: string;
+        /** Bid price per click */
+        bid_price_per_click: number;
+    }>;
+};
+/**
+ * Response for the edit manual product ad keywords API
+ */
+export interface EditManualProductAdKeywordsResponse extends BaseResponse {
+    response: {
+        /** The unique identifier for the campaign */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the edit manual product ads API
+ */
+export type EditManualProductAdsParams = {
+    /** A random string used to prevent duplicate ads */
+    reference_id: string;
+    /** The unique identifier for the campaign */
+    campaign_id: number;
+    /** The update action */
+    edit_action: string;
+    /** The budget set for the Manual Product Ads */
+    budget?: number;
+    /** Start date of the campaign (DD-MM-YYYY format) */
+    start_date?: string;
+    /** End date of the campaign (DD-MM-YYYY format) */
+    end_date?: string;
+    /** ROAS target for campaigns with auto bidding */
+    roas_target?: number;
+    /** Location settings for manual bidding method */
+    discovery_ads_locations?: Array<{
+        /** Location: "daily_discover" or "you_may_also_like" */
+        location: string;
+        /** Bid price */
+        bid_price: number;
+    }>;
+    /** Enhanced CPC functionality toggle */
+    enhanced_cpc?: boolean;
+    /** Smart Creative setting: "", "default", "on", or "off" */
+    smart_creative_setting?: string;
+};
+/**
+ * Response for the edit manual product ads API
+ */
+export interface EditManualProductAdsResponse extends BaseResponse {
+    response: {
+        /** The unique identifier for the campaign */
+        campaign_id: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Response for the get ads facil shop rate API
+ */
+export interface GetAdsFacilShopRateResponse extends BaseResponse {
+    response: {
+        /** Shop rate for Ads Facil Program */
+        shop_rate?: number;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get create product ad budget suggestion API
+ */
+export type GetCreateProductAdBudgetSuggestionParams = {
+    /** A random string used to prevent duplicate ads */
+    reference_id: string;
+    /** Product selection: "auto" or "manual" */
+    product_selection: string;
+    /** Campaign placement: "search", "discovery", or "all" */
+    campaign_placement: string;
+    /** Bidding method: "auto" or "manual" */
+    bidding_method: string;
+    /** Enhanced CPC toggle: "true" or "false" */
+    enhanced_cpc?: string;
+    /** Comma-separated location values: "daily_discover", "you_may_also_like" */
+    discovery_ads_location_names?: string;
+    /** ROAS target for campaigns with auto bidding */
+    roas_target?: number;
+    /** Product ID (mandatory for manual product selection) */
+    item_id?: number;
+};
+/**
+ * Response for the get create product ad budget suggestion API
+ */
+export interface GetCreateProductAdBudgetSuggestionResponse extends BaseResponse {
+    response: {
+        /** Budget suggestion data */
+        budget: {
+            /** Minimum budget suggestion */
+            min_budget?: number;
+            /** Maximum budget suggestion */
+            max_budget?: number;
+            /** Recommended budget suggestion */
+            recommended_budget?: number;
+        };
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get GMS campaign performance API
+ */
+export type GetGmsCampaignPerformanceParams = {
+    /** The GMS Campaign ID */
+    campaign_id?: number;
+    /** Start date (DD-MM-YYYY format). Maximum 3 months duration, earliest 6 months ago */
+    start_date: string;
+    /** End date (DD-MM-YYYY format). Maximum 3 months duration */
+    end_date: string;
+};
+/**
+ * Response for the get GMS campaign performance API
+ */
+export interface GetGmsCampaignPerformanceResponse extends BaseResponse {
+    response: {
+        /** GMS Campaign ID */
+        campaign_id: number;
+        /** Performance report data */
+        report: {
+            /** Total impressions */
+            impression?: number;
+            /** Total clicks */
+            clicks?: number;
+            /** Click-through rate */
+            ctr?: number;
+            /** Total expense */
+            expense?: number;
+            /** Gross merchandise value */
+            gmv?: number;
+            /** Return on ad spend */
+            roas?: number;
+            /** Number of orders */
+            orders?: number;
+        };
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the get GMS item performance API
+ */
+export type GetGmsItemPerformanceParams = {
+    /** The GMS Campaign ID */
+    campaign_id?: number;
+    /** Start date (DD-MM-YYYY format). Maximum 3 months duration, earliest 6 months ago */
+    start_date: string;
+    /** End date (DD-MM-YYYY format). Maximum 3 months duration */
+    end_date: string;
+    /** Pagination offset (default: 0) */
+    offset?: number;
+    /** Maximum number of records to show (default: 50, max: 100) */
+    limit?: number;
+};
+/**
+ * Response for the get GMS item performance API
+ */
+export interface GetGmsItemPerformanceResponse extends BaseResponse {
+    response: {
+        /** GMS Campaign ID */
+        campaign_id: number;
+        /** List of item performance reports */
+        result_list: Array<{
+            /** Item ID */
+            item_id: number;
+            /** Total impressions */
+            impression?: number;
+            /** Total clicks */
+            clicks?: number;
+            /** Click-through rate */
+            ctr?: number;
+            /** Total expense */
+            expense?: number;
+            /** Gross merchandise value */
+            gmv?: number;
+            /** Return on ad spend */
+            roas?: number;
+            /** Number of orders */
+            orders?: number;
+        }>;
+        /** Total number of item ID reports */
+        total: number;
+        /** Indicates if there are more item ID reports */
+        has_next_page: boolean;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}
+/**
+ * Parameters for the list GMS user deleted item API
+ */
+export type ListGmsUserDeletedItemParams = {
+    /** Pagination offset (default: 0) */
+    offset?: number;
+    /** Maximum number of records to show (default: 50, max: 100) */
+    limit?: number;
+};
+/**
+ * Response for the list GMS user deleted item API
+ */
+export interface ListGmsUserDeletedItemResponse extends BaseResponse {
+    response: {
+        /** GMS Campaign ID */
+        campaign_id: number;
+        /** List of deleted item IDs */
+        item_id_list: number[];
+        /** Total number of deleted item IDs */
+        total: number;
+        /** Indicates if there are more item IDs */
+        has_next_page: boolean;
+    };
+    /** Optional warning message if some data cannot be responded normally */
+    warning?: string;
+}