MOmoloco
Campaign

Update an existing Campaign.

Changed on

Update an existing Campaign.

put/cm/v1/campaigns/{campaign_id}

Request

Path parameters

campaign_idstring required

The ID of the Campaign to be updated.

Request body

idstring

Unique identifier of the Campaign. Automatically set by server on creation.

ad_account_idstring

ID of the AdAccount the Campaign belongs to. Required in the request body for UpdateCampaign. For CreateCampaign, provide the ad_account_id query parameter instead.

product_idstring

ID of the Product the Campaign belongs to. Required in the request body for UpdateCampaign. For CreateCampaign, provide the product_id query parameter instead.

titlestring required

A descriptive name of the Campaign.

descriptionstring

An optional description of the Campaign.

enabling_state'UNSPECIFIED' | 'ENABLED' | 'DISABLED'

Enumeration of the enabling states with a default UNSPECIFIED state.

type'UNKNOWN_CAMPAIGN_TYPE' | 'GENERIC' | 'APP_USER_ACQUISITION' | 'APP_REENGAGEMENT' | 'WEBSITE_VISIT' | 'CTV_GENERIC' | 'CTV_APP_USER_ACQUISITION' | 'WEB_USER_ACQUISITION' | 'CTV_WEBSITE_VISIT' | 'CTV_WEB_USER_ACQUISITION' | 'WEB_RETARGETING' required

CampaignType represents the type of a Campaign. It captures the goal of the Campaign at a high level.

This value is not part of the specification.

  • GENERIC: Campaign is for generic purpose (only for legacy Campaigns).
  • APP_USER_ACQUISITION: The goal of the Campaign is to drive app user acquisitions.
  • APP_REENGAGEMENT: The goal of the Campaign is to drive app reengagement.
  • WEBSITE_VISIT: The goal of the Campaign is to drive website visits.
  • CTV_GENERIC: Campaign is for the general CTV ad.
  • CTV_APP_USER_ACQUISITION: Campaign is for the mobile app install CTV ad.
  • WEB_USER_ACQUISITION: The goal of the Campaign is to drive web user acquisitions. Originally, this was used for APP to WEB user acquisition. However, it is now also used for WEB to WEB user acquisition.
  • CTV_WEBSITE_VISIT: Campaign is for the website visit CTV ad.
  • CTV_WEB_USER_ACQUISITION: Campaign is for the web user acquisition CTV ad.
  • WEB_RETARGETING: The goal of the Campaign is to drive web retargeting. Currently, this is used for WEB to WEB retargeting.
device_os'UNKNOWN_DEVICE_OS' | 'ANDROID' | 'IOS' | 'VERSATILE' | 'MOBILE_WEB' | 'MACOS' | 'WINDOWS' | 'NEXT_VERSATILE' required

Enumeration of device OS types supported by Moloco Ads.

This value is not part of the specification.

  • ANDROID: Android device OS.
  • IOS: iOS device OS.
  • VERSATILE: Product with multiple OSes. Specifically for CTV.
  • MOBILE_WEB: OS for mobile web traffic.
  • MACOS: OS for MacOS traffic.
  • WINDOWS: OS for Windows traffic.
  • NEXT_VERSATILE: OS for Next web product.
state'UNKNOWN_CAMPAIGN_STATE' | 'SUBMITTED' | 'READY' | 'UPCOMING' | 'ACTIVE' | 'PAUSED' | 'SUSPENDED' | 'COMPLETED' | 'LEARNING'

CampaignState represents various states of a Campaign.

This value is not part of the specification.

  • 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.
countriesstring[] required

Countries in which this Campaign runs. The value format is ISO-3166-1 Alpha-3 using uppercase letters only, such as "KOR" or "USA". Note that the values for this field will be used to filter bid requests by country name.

currency'UNKNOWN_CURRENCY' | 'USD' | 'KRW' | 'JPY' | 'EUR' | 'GBP'

Enumeration of currencies supported by Moloco Ads.

This value is not part of the specification.

  • USD: US Dollar.
  • KRW: Korean Won.
  • JPY: Japanese Yen.
  • EUR: EU Euro.
  • GBP: British Pound.
tracking_company'UNKNOWN_TRACKING_COMPANY' | 'KOCHAVA' | 'ADJUST' | 'MAT' | 'MOLOCO_PIXEL' | 'APPSFLYER' | 'ADBRIX' | 'WEB' | 'GENERIC' | 'TRACKFNT' | 'AIRBRIDGE' | 'MOLOCO_E2E' | 'APSALAR' | 'BRANCH' | 'TENJIN' | 'SINGULAR' | 'ADBRIX_V2' | 'TRAFFICGUARD' | 'GAMELOFT' | 'SKADNETWORK' | 'MYTRACKER' | 'MOLOCO_RMP' | 'MOLOCO_PIXEL_V2' | 'JUSTTRACK' | 'SHOPEE' | 'KOCHAVA_FOR_PUBLISHER' | 'GAMESIGHT' | 'CAULY' | 'HASOFFER' | 'ADACTION' | 'CURATE'

Enumeration for tracking companies supported by Moloco Ads.

  • WEB: Unnamed trackers
  • AIRBRIDGE: Moloco's e2e tracker (test purpose only)
  • KOCHAVA_FOR_PUBLISHER: Kochava's CTV to web event dedicated tracking company.
tracking_link_idstring

MMP specific impression and click TrackingLinks defined specifically for this Campaign. Campaign can be either WEB type or APP type. Required for APP type campaign, not allowed for WEB type Campaign.

landing_urlstring

The URL of the website that a Campaign wants to show to the audience. Required for web type Campaign.

custom_key_valuesobject

Custom key/values managed by the Moloco Ads client platform. It's up to the client ads platform to define the schema for the values and their optionality.

The keys are recommended, but not required, to be prefixed with the reversed internet domain of the AdCloud client platform company. For example, keys defined by the client ads platform company "example.com" should have "com.example." as the prefix.

For complex values, JSON payload is recommended.

Moloco doesn't interpret these data in any way for ads serving. Upon serving, the custom key/values in the AdAccount, Campaign, and Creative models will be combined into the serving Creative proto in the order of precedence, with Creative's value having the highest precedence on the same key.

ad_tracking_allowance'UNKNOWN_AD_TRACKING_ALLOWANCE' | 'NON_LAT_ONLY' | 'LAT_ONLY' | 'DO_NOT_CARE'

AdTrackingAllowance represents targeting conditions regarding personalized ad tracking.

This value is not part of the specification.

  • NON_LAT_ONLY: Campaign will bid only to the traffic with IDFA as usual Campaigns.
  • LAT_ONLY: Campaign will bid only to the traffic without IDFA. Limited Ad Tracking only.
  • DO_NOT_CARE: Campaign will not care whether it has an IDFA or not. Default as of now.
is_deletedboolean

True for deleted Campaign.

auto_delete_atstring date-time

Campaign in Paused or Finished state for specific time will be removed automatically. It represents when this will be deleted in UTC.

created_atstring date-time

Created time.

updated_atstring date-time

Last updated time. Should not modify on the client side.

Response

A successful response.

Changes

  • fa372006b0f6Revision 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

      the request optional property became not read-only

    • info

      the request optional property became not read-only

    • info

      added the new CTV_WEB_USER_ACQUISITION enum value to the request property

    • info

      added the new LEARNING enum value to the request property

    • info

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

    • info

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