List up Campaigns.
Changed onList up all Campaigns of the AdAccount or the Product.
Request
- Base URLhttps://api.moloco.cloud
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The AdAccount ID to which the Campaigns belong to.
The Product ID to which the Campaigns belong to.
The states of the Campaigns to be listed. Deleted Campaigns can not be listed with this parameter.
- SUBMITTED: All the required data are entered and passed all the validation. It's eligible to be reviewed by Moloco for activation.
- READY: Campaign is before schedule and internally ready but disabled. Will transit to PAUSED when it becomes on schdule.
- UPCOMING: Campaign is before schedule and internally ready and disabled. Will transit to ACTIVE when it becomes on schdule.
- ACTIVE: Campaign is on schedule and spending the budget.
- PAUSED: Campaign is paused and not spending the budget.
- SUSPENDED: Campaign activation is suspended by the system for the following reasons:
- App has been found to be in violation of Moloco's creative policy.
- COMPLETED: Campaign is completed but may still get attributions for some time.
- LEARNING: Campaign is active and spending while the system learns its target KPI.
Fetch option to query Campaigns only deleted or all(deleted & not deleted). If fetch_option is not specified, it will fetch only alive Campaigns.
- FETCH_ALL: Fetch all Campaigns including deleted and not deleted.
- FETCH_ONLY_DELETED: Fetch only deleted Campaigns.
Response
A successful response.
Changes
- warning
added the new
CTV_WEB_USER_ACQUISITIONenum value to the//response property for the response status - warning
added the new
LEARNINGenum value to the//response property for the response status - info
added the enum value
LEARNINGto the propertyitems/of thequeryrequest parameterstates - info
the response optional property
//became not read-only for the status - info
the response optional property
//became not read-only for the status
- warning