--- title: "Read an existing Campaign." method: GET path: "/cm/v1/campaigns/{campaign_id}" tags: ["Campaign"] --- # Read an existing Campaign. `GET /cm/v1/campaigns/{campaign_id}` Read an existing Campaign. ## Path parameters - `campaign_id` string, required ## Response `200` A successful response. - MessagesReadCampaignResponse - `campaign` DspCampaign — Campaign represents a single advertising Campaign. - `id` string — Unique identifier of the Campaign. Automatically set by server on creation. - `ad_account_id` string — ID of the AdAccount the Campaign belongs to. - `product_id` string — ID of the Product the Campaign belongs to. - `title` string, required — A descriptive name of the Campaign. - `description` string — 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' | '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. - 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' — 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. - `countries` string[], 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. - `schedule` CommonTimeInterval, required — Interval with start and end timestamps in RFC3339 format. - `start` string, date-time — Start time in RFC3339 format, e.g. "2017-04-01T12:34:56+00:00". - `end` string, date-time — End time in RFC3339 format, e.g. "2017-05-01-T21:09:08+00:00". - `budget_schedule` DspBudgetSchedule — BudgetSchedule represents the AdAccount's plan for budget spending. Any change in this object takes effect immediately. - `daily_schedule` DspDailyBudgetSchedule - `daily_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `weekly_schedule` DspDayOfWeekBudgetSchedule — Budget for each day of the week; all 7-day budgets need be filled for use. - `monday_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `tuesday_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `wednesday_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `thursday_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `friday_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `saturday_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `sunday_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `weekly_flexible_schedule` DspWeeklyFlexibleBudgetSchedule - `weekly_budget` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `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_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` DspCampaignGoal, required — CampaignGoal describes the details of goal of a Campaign. - `type` 'UNKNOWN_TYPE' | 'OPTIMIZE_NONE' | 'FIXED_CPM_FOR_APP_UA' | 'FIXED_CPM_FOR_APP_RE' | 'OPTIMIZE_CPI_FOR_APP_UA' | 'OPTIMIZE_CPA_FOR_APP_UA' | 'OPTIMIZE_CPC_FOR_APP_UA' | 'OPTIMIZE_ROAS_FOR_APP_UA' | 'OPTIMIZE_ROAS_FOR_APP_RE' | 'OPTIMIZE_CPC_FOR_APP_RE' | 'OPTIMIZE_CPC_FOR_WEB_VISIT' | 'OPTIMIZE_APP_INSTALLS' | 'OPTIMIZE_APP_ROAS' | 'OPTIMIZE_CLICKS_TO_WEB' | 'OPTIMIZE_CLICKS_TO_APP' | 'OPTIMIZE_CPA_FOR_APP_RE' | 'OPTIMIZE_RETENTION_FOR_APP_UA' | 'OPTIMIZE_REATTRIBUTION_FOR_APP' | 'OPTIMIZE_CPA_REPEATED_FOR_APP_UA' | 'FIXED_CPM_GENERIC' | 'FIXED_CPM_FOR_CTV' | 'FIXED_CPM_FOR_WEB_VISIT' | 'OPTIMIZE_LANDING_FOR_WEB_UA' | 'OPTIMIZE_CPA_FOR_WEB_UA', required — Type enumerates available Campaign goal types. Corresponding details to the type must be specified. - OPTIMIZE_NONE: Goal type for the Campaigns which do not use any of pricing engines. - FIXED_CPM_FOR_APP_UA: Goal type for the UA Campaigns which do not use any of pricing engines. - FIXED_CPM_FOR_APP_RE: Goal type for the RE Campaigns which do not use any of pricing engines. - OPTIMIZE_CPI_FOR_APP_UA: Aim to drive app installs while satisfying the long-term cost per install. - OPTIMIZE_CPA_FOR_APP_UA: Aim to drive app installs while satisfying long-term cost per (certain) action. - OPTIMIZE_CPC_FOR_APP_UA: Aim to drive app installs while satisfying long-term cost per click. - OPTIMIZE_ROAS_FOR_APP_UA: Aim to drive app installs while satisfying long-term return on advertising spend (ROAS). - OPTIMIZE_ROAS_FOR_APP_RE: Aim to drive the user re-engagements while satisfying long-term return on advertising spend (ROAS). - OPTIMIZE_CPC_FOR_APP_RE: Aim to drive the user re-engagements while satisfying long-term cost per click. - OPTIMIZE_CPC_FOR_WEB_VISIT: Aim to drive the web-site visit while satisfying long-term cost per click. - OPTIMIZE_APP_INSTALLS: Deprecated. Aim to drive app installs while satisfying long-term cost per install. - OPTIMIZE_APP_ROAS: Deprecated. Aim to drive certain in-app actions while satisfying long-term return on advertising spend (ROAS). - OPTIMIZE_CLICKS_TO_WEB: Deprecated. Aim to drive clicks for web-site Product while satisfying long-term cost per click. - OPTIMIZE_CLICKS_TO_APP: Deprecated. Aim to drive clicks for web-site Product while satisfying long-term cost per click. - OPTIMIZE_CPA_FOR_APP_RE: Aim to drive the user re-engagements while satisfying long-term cost per (certain) action. - OPTIMIZE_RETENTION_FOR_APP_UA: Aim to drive the user retention. - OPTIMIZE_REATTRIBUTION_FOR_APP: Aim to drive user's app reattribution. - OPTIMIZE_CPA_REPEATED_FOR_APP_UA: Aim to drive app installs while satisfying long-term cost per (certain) action - repeated count. - FIXED_CPM_GENERIC: Default goal type for generic fixed-cpm. Fixed cpm with budget-pacing option is given. - FIXED_CPM_FOR_CTV: Default goal type for CTV. Fixed cpm with budget-pacing option is given. - FIXED_CPM_FOR_WEB_VISIT: Goal type for the WEB_VISIT Campaigns which do not use any of pricing engines. - OPTIMIZE_LANDING_FOR_WEB_UA: Goal type for optimizing landing event for web user acquisition campaign. - OPTIMIZE_CPA_FOR_WEB_UA: Goal type for optimizing cost per action for web user acquisition campaign. - `optimize_app_installs` CampaignGoalOptimizeAppInstalls - `mode` 'UNKNOWN_MODE' | 'TARGET_CPI_CENTRIC' | 'BUDGET_CENTRIC' | 'MARGIN_CENTRIC' | 'FIXED' — - FIXED: Read-only for AdCloud. - `target_cpi` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `rate` number, double — The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2]. - `margin` number, double — The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0]. - `optimize_cpa_for_app_ua` CampaignGoalOptimizeCpaForAppUa — Detailed configuration of OPTIMIZE_CPA_FOR_APP_UA goal. - `action` string, required — In-app action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' | 'MARGIN_CENTRIC' | 'TARGET_PRIMARY_KPI_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2]. - `margin` number, double — The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0]. - `target_kpi` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `optimize_app_roas` CampaignGoalOptimizeAppRoas - `target_roas` number, double — Target return on advertising spend (ROAS) in percent. For example, a value 312.5 denotes 312.5% ROAS. - `revenue_actions` string[], required — In-app action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. - ROAS computation will rely on the accompanied revenue value to each action. - `target_cpi` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' | 'MARGIN_CENTRIC' | 'TARGET_PRIMARY_KPI_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2]. - `margin` number, double — The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0]. - `optimize_clicks_to_web` CampaignGoalOptimizeClicksToWeb — Detailed configuration of OPTIMIZE_CPC_FOR_WEB_VISIT goal. - `target_cpc` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' | 'TARGET_CPC_CENTRIC' - `rate` number, double — Budget-centric uses one ratio of daily budget for the autopilot to spend. It's only for DCPM. Required when the mode is BUDGET_CENTRIC. Its rate should be in (0, 2]. - `optimize_clicks_to_app` CampaignGoalOptimizeClicksToApp — Detailed configuration of OPTIMIZE_CPC_FOR_APP_UA goal. - `target_cpc` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' | 'TARGET_CPC_CENTRIC' - `rate` number, double — Budget-centric uses one ratio of daily budget for the autopilot to spend. It's only for DCPM. Required when the mode is BUDGET_CENTRIC. Its rate should be in (0, 2]. - `optimize_roas_for_app_re` CampaignGoalOptimizeRoasForAppRe — Detailed configuration of OPTIMIZE_ROAS_FOR_APP_RE goal. - `target_roas` number, double — Target return on advertising spend (ROAS) in percent. For example, a value 312.5 denotes 312.5% ROAS. - `reengagement_action` string — Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action. - `revenue_actions` string[], required — In-app action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. - ROAS computation will rely on the accompanied revenue value to each action. - `rate` number, double — The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2]. - `optimize_cpc_for_app_re` CampaignGoalOptimizeCpcForAppRe — Detailed configuration of OPTIMIZE_CPC_FOR_APP_RE goal. - `target_cpc` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `reengagement_action` string — Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action. - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' | 'TARGET_CPC_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2]. Required when the mode is BUDGET_CENTRIC. - `optimize_fixed_cpm` CampaignGoalOptimizeFixedCpm — Detailed configuration of FIXED_CPM_* goal. - `target_cpm` AdcloudcommonMoney, required — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `optimize_cpa_for_app_re` CampaignGoalOptimizeCpaForAppRe — Detailed configuration of OPTIMIZE_CPA_FOR_APP_RE goal. - `action` string, required — In-app action events the AdAccount wants to optimize. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. - `reengagement_action` string — Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action. - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2]. - `optimize_app_retention` CampaignGoalOptimizeAppRetention — Detailed configuration of OPTIMIZE_RETENTION_FOR_APP_UA goal. - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' | 'MARGIN_CENTRIC' - `target_cpi` AdcloudcommonMoney — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `rate` number, double — The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC and target_cpi is unset. The rate should be in (0, 2]. - `margin` number, double — The ratio of the margin for the autopilot to spend. Required when the mode is MARGIN_CENTRIC. The rate should be in [-1.0, 1.0]. - `optimize_app_reattribution` CampaignGoalOptimizeAppReattribution — Detailed configuration of OPTIMIZE_REATTRIBUTION_FOR_APP goal. - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2]. - `optimize_cpa_repeated_for_app_ua` CampaignGoalOptimizeCpaRepeatedForAppUa — Detailed configuration of OPTIMIZE_CPA_REPEATED_FOR_APP_UA goal. - `action` string, required — In-app action events the AdAccount wants to optimize. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. Required when the mode is BUDGET_CENTRIC. The rate should be in (0, 2]. - `optimize_fixed_cpm_pacing` CampaignGoalOptimizeFixedCpmPacing — General fixed-cpm goal with pacing option. Currently for FIXED_CPM_FOR_CTV and FIXED_CPM_GENERIC. - `target_cpm` AdcloudcommonMoney, required — Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million. Both currency and amount are required. - `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. - `amount_micros` string, int64 - `pacing_mode` 'NONE' | 'BY_FREQUENCY' — Force pacing option. - `rate` number, double — Budget consume rate. The rate should be in (0, 2]. - `optimize_landing_for_web_ua` CampaignGoalOptimizeLandingForWebUa - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2]. - `optimize_cpa_for_web_ua` CampaignGoalOptimizeCpaForWebUa - `action` string, required — Web action events having revenue value the AdAccount wants to achieve. Remarkable notes: - Case-sensitive as specified in the post-back from MMP. Note(jiyeon): Currently, we optimize `install` events regardless of this action. - `mode` 'UNKNOWN_MODE' | 'BUDGET_CENTRIC' - `rate` number, double — The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2]. - `kpi_actions` string[] — List of KPI actions. - `skadn_input` DspSKAdNetworkInput — SKAdNetworkInput represents various configurations w.r.t SKAdNetwork traffic. It's meaningful only for IOS. Use case in MCP: https://help.moloco.com/hc/en-us/articles/1500005837321-SKAdNetwork-Campaign-Settings. - `targeting_state` 'UNKNOWN_TARGETING_STATE' | 'TARGET_DO_NOT_CARE' | 'TARGET_ALL' | 'TARGET_SKADN_ONLY' | 'TARGET_NON_SKADN_ONLY' | 'TARGET_CUSTOM' — Enumeration of all supported targeting state w.r.t SKAdNetwork traffic. TARGET_ALL, TARGET_SKADN_ONLY, TARGET_NON_SKADN_ONLY is a predefined set of traffic. TARGET_CUSTOM is to support DIY configuration of traffic. This value is not part of the specification. - TARGET_DO_NOT_CARE: Do not care whether the Campaign targets SKAdNetwork traffic or not. - TARGET_ALL: Target all traffic including SKAdNetwork and others. It includes SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE. - TARGET_SKADN_ONLY: Target only SKAdNetwork traffic. It includes SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE. - TARGET_NON_SKADN_ONLY: Target only non-SKAdNetwork traffic. It includes SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE. - TARGET_CUSTOM: Target customized configuration traffic. When the targeting_state is set with this value, then custon_options should be also set. - `include_traffic_without_attributions` boolean — It adds SKAN_CUSTOM_OPTION_NON_ATTRIBUTABLE to target traffic. It is only effective when the targeting_state is 'TARGET_ALL' or 'TARGET_SKADN_ONLY'. - `custom_options` SKAdNetworkInputCustomOption[] — custom_options hold all the traffic the Campaign want to target. It is only effective when the targeting_state is 'TARGET_CUSTOM'. - `prefer_mmp_attribution` boolean — 1) targeting_state is TARGET_NON_SKADN_ONLY 2) targeting_state is TARGET_CUSTOM and custom_options is set exclusively to SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE. If true, the Campaign skips SKAN allocation. - `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` '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_deleted` boolean — True for deleted Campaign. - `auto_delete_at` string, 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_at` string, date-time — Created time. - `updated_at` string, date-time — Last updated time. Should not modify on the client side. - `serving_status` CampaignServingStatus — ServingStatus stores current serving status of the campaign, such as whether it is blocked and when it is blocked. - `serving_blocked` boolean — serving_blocked is true when this campaign is blocked in the serving side for some reason. - `serving_blocked_timestamp` string, date-time — The timestamp of the latest serving block. - `launch_notices` CommonLaunchNotice[] — A list of notices that the user must review and acknowledge to enable the campaign. This field represents pending notices requiring user confirmation. The client should store these notices and include them in the subsequent request via the 'launch_notice_confirmations' field to prove that the user has seen them. - `type` 'UNKNOWN' | 'WARNING' | 'DISCLAIMER' — NoticeType defines the severity or category of the notice. - WARNING: Warning: Informational message that does not block the launch but requires attention. - DISCLAIMER: Disclaimer: Explicit agreement or acknowledgement is required from the user. - `message` 'UNKNOWN_MESSAGE' | 'MMP_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED' | 'MMP_VIEW_THROUGH_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED' | 'MMP_ADVANCED_PRIVACY_STATUS_ENABLED' | 'MMP_PROBABILISTIC_ATTRIBUTION_STATUS_UNKNOWN' | 'CAMPAIGN_WILL_PAUSE_IF_ADVANCED_PRIVACY_ENABLED_AFTER_48H' — - UNKNOWN_MESSAGE: Default fallback for unrecognized message types. - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED: MMP Probabilistic Attribution (PA) is disabled. User should enable PA from MMP side. - MMP_VIEW_THROUGH_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED: View-Through Probabilistic Attribution (VT PA) is disabled in MMP settings. - MMP_ADVANCED_PRIVACY_STATUS_ENABLED: Appsflyer Advanced Privacy is currently enabled. - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_UNKNOWN: The current status of Probabilistic Attribution cannot be determined. - CAMPAIGN_WILL_PAUSE_IF_ADVANCED_PRIVACY_ENABLED_AFTER_48H: The campaign is scheduled to pause in 48 hours if Advanced Privacy remains enabled. - `launch_notice_confirmations` CommonLaunchNotice[] — 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. - `type` 'UNKNOWN' | 'WARNING' | 'DISCLAIMER' — NoticeType defines the severity or category of the notice. - WARNING: Warning: Informational message that does not block the launch but requires attention. - DISCLAIMER: Disclaimer: Explicit agreement or acknowledgement is required from the user. - `message` 'UNKNOWN_MESSAGE' | 'MMP_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED' | 'MMP_VIEW_THROUGH_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED' | 'MMP_ADVANCED_PRIVACY_STATUS_ENABLED' | 'MMP_PROBABILISTIC_ATTRIBUTION_STATUS_UNKNOWN' | 'CAMPAIGN_WILL_PAUSE_IF_ADVANCED_PRIVACY_ENABLED_AFTER_48H' — - UNKNOWN_MESSAGE: Default fallback for unrecognized message types. - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED: MMP Probabilistic Attribution (PA) is disabled. User should enable PA from MMP side. - MMP_VIEW_THROUGH_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED: View-Through Probabilistic Attribution (VT PA) is disabled in MMP settings. - MMP_ADVANCED_PRIVACY_STATUS_ENABLED: Appsflyer Advanced Privacy is currently enabled. - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_UNKNOWN: The current status of Probabilistic Attribution cannot be determined. - CAMPAIGN_WILL_PAUSE_IF_ADVANCED_PRIVACY_ENABLED_AFTER_48H: The campaign is scheduled to pause in 48 hours if Advanced Privacy remains enabled. - `postback_integration_status` DspPostbackIntegrationStatus - `device_os` 'UNKNOWN_DEVICE_OS' | 'ANDROID' | 'IOS' | 'VERSATILE' | 'MOBILE_WEB' | 'MACOS' | 'WINDOWS' | 'NEXT_VERSATILE' — 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. - `country` string — Country to which the postback is integrated with. The field should conform to [ISO-3166-1 Alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format e.g. "KOR", "USA". It is used for filtering bid requests by country name. - `complete_percentage` number, double — Integration completion percentage per each country. - `integration_success` boolean — The flag that specifies the integration is completed in any country. ## Other responses - `default` — Error. Detailed cause can be found in the `details` field. --- [API](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api.md) · [All operations](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moloco/moloco-ads-campaign-management-api/revisions/5c85d0910ac0/schema)