Update an existing Campaign.

put

https://api.moloco.cloud/cm/v1/campaigns/{campaign_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaign_id

string

required

The ID of the Campaign to be updated.

Body Params

The Campaign to update.

Campaign represents a single advertising Campaign.

string

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

title

string

required

A descriptive name of the Campaign.

description

string

An optional description of the Campaign.

enabling_state

string

enum

Defaults to UNSPECIFIED

Whether this campaign is enabled by the AdAccount. Only enabled Campaigns will be activated for serving once their eligibility is determined by Moloco.

If the value of this field is unset or set to UNSPECIFIED in a Campaign creation request, it will be set to ENABLED automatically by the server.

If the value is DISABLED when the Campaign is being reviewed and approved, the Campaign state will become PAUSED after approval.

An active Campaign can be paused manually at any time by setting this field to DISABLED.

Allowed:

type

string

enum

required

Defaults to UNKNOWN_CAMPAIGN_TYPE

Type of the Campaign.

device_os

string

enum

required

Defaults to UNKNOWN_DEVICE_OS

Device OS type for this Campaign.

countries

array of strings

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.

countries*

schedule

object

required

Absolute time range to allow this Campaign to be served. Start is required and End is optional.

budget_schedule

object

Campaign-wide budget schedule specified by the AdAccount.

tracking_company

string

enum

Defaults to UNKNOWN_TRACKING_COMPANY

Tracking company (e.g., Appsflyer, MAT, and so on).

tracking_link_id

string

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_url

string

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

goal

object

required

Goal of the Campaign.

skadn_input

object

Explicit input for SKAdNetwork traffic. It's meaningful only for IOS App Campaign toward SKAdNetwork traffic.

custom_key_values

object

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

string

enum

Defaults to UNKNOWN_AD_TRACKING_ALLOWANCE

AdTrackingAllowance controls target audience in terms of personalized ad tracking settings.

Allowed:

updated_at

date-time

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

launch_notice_confirmations

array of objects

The list of launch notice that the user has explicitly reviewed and confirmed. The client must echo back the notices received in 'launch_notices' when enabling the campaign. The server validates these against the current system state to ensure all required acknowledgments are present.

Starting from v1.10.0, any campaign enable request that does not include all 'DISCLAIMER' type notices received in 'launch_notices' will be rejected.

launch_notice_confirmations

Responses

200A successful response.

defaultError. Detailed cause can be found in the details field.