v2.ads.check_create_gms_product_campaign_eligibility
GET /api/v2/ads/check_create_gms_product_campaign_eligibility
Check the seller's eligibility in creating a GMS campaign
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/check_create_gms_product_campaign_eligibility
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
No Request Parameters Set.
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Indicate warning details if hit warning. Empty if no warning happened. | |
| request_id | string | 6f235f4a343e4feb8a9ed74c439f6663 | The identifier for an API request for error tracking. |
| response | object | ||
| is_eligible | boolean | false | Indicates if the seller is eligible to create a GMS Campaign |
| reason | string | exclusive_with_other_campaign | The following are the list of reasons for not being able to create a GMS Campaign: 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 |