Campaign

List up Campaigns.

Changed on

List up all Campaigns of the AdAccount or the Product.

get/cm/v1/campaigns

Request

Query parameters

ad_account_idstring required

The AdAccount ID to which the Campaigns belong to.

product_idstring

The Product ID to which the Campaigns belong to.

statesstring[]

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'UNKNOWN_FETCH_OPTION' | 'FETCH_ALL' | 'FETCH_ONLY_DELETED'

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_ACQUISITION enum value to the // response property for the response status

    • warning

      added the new LEARNING enum value to the // response property for the response status

    • info

      added the enum value LEARNING to the property items/ of the query request parameter states

    • info

      the response optional property // became not read-only for the status

    • info

      the response optional property // became not read-only for the status