--- updatedAt: 2026-06-12T17:46:13.000Z agentTools: projectIndex: https://mcm-docs.moloco.com/llms.txt --- # ListCampaigns List all the campaigns of an ad account. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Management API", "description": "MOLOCO RMP Management API provides functionalities for MOLOCO RMP systems.", "version": "1.0", "contact": { "name": "Moloco Inc.", "url": "https://www.molocoads.com" } }, "paths": { "/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns": { "get": { "summary": "ListCampaigns", "description": "List all the campaigns of an ad account.", "operationId": "RmpManagementApi_ListCampaigns", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicListCampaignsResponse" } } } }, "400": { "description": "Bad request. Detailed cause can be found in the response message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "403": { "description": "Permission denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "404": { "description": "Not found. One or more required resources do not exist.You can see the details in the response message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "500": { "description": "Internal server error. Detailed cause can be found in the response message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } } }, "parameters": [ { "name": "platform_id", "description": "Identifier of the platform who requests management api. It is passed as a path parameter.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ad_account_id", "description": "AdAccount id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "without_catalog_item_ids", "description": "Option to exclude catalog item ids which belonging to the campaign. It is passed as a query parameter.", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "tags": [ "Campaign" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "x-readme": { "explorer-enabled": false }, "servers": [ { "url": "https://-mgmt.mcm-api.moloco.com" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "x-api-key", "in": "header" } }, "schemas": { "AudienceConfigAudienceTargetingCriteria": { "type": "string", "enum": [ "UNKNOWN_CRITERIA", "AD_ACCOUNT", "AD_ACCOUNT_ITEM", "CATEGORY", "BRAND" ], "default": "UNKNOWN_CRITERIA" }, "AudienceConfigAudienceTargetingEventType": { "type": "string", "enum": [ "UNKNOWN_EVENT_TYPE", "PURCHASE", "ITEM_PAGE_VIEW" ], "default": "UNKNOWN_EVENT_TYPE" }, "AudienceSettingEventBasedList": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/AudienceSettingEventBasedListCondition" }, "description": "Event based audience targeting conditions." }, "operator": { "$ref": "#/components/schemas/AudienceSettingEventBasedListOperator" } }, "description": "EventBasedList describes event based audience targeting settings for the campaign", "required": [ "conditions", "operator" ], "additionalProperties": true }, "AudienceSettingEventBasedListCondition": { "type": "object", "properties": { "event_type": { "$ref": "#/components/schemas/AudienceConfigAudienceTargetingEventType" }, "criteria": { "$ref": "#/components/schemas/AudienceConfigAudienceTargetingCriteria" }, "period_hours": { "type": "integer", "format": "int64", "description": "Event period for targeting audience in hours." }, "selections": { "type": "array", "items": { "type": "string" }, "description": "Selections of the target audience. It is required if the criteria is AD_ACCOUNT_ITEM, BRAND, or CATEGORY." } }, "description": "Condition describes event based audience targeting condition for the campaign", "required": [ "event_type", "criteria", "period_hours" ], "additionalProperties": true }, "AudienceSettingEventBasedListOperator": { "type": "string", "enum": [ "UNKNOWN_OPERATOR", "AND", "OR" ], "default": "UNKNOWN_OPERATOR" }, "CampaignCampaignItemSelection": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignCampaignItemSelectionType" }, "smart_selection_setting": { "$ref": "#/components/schemas/CampaignItemSelectionSmartSelectionSetting" } }, "description": "Item selection config of the campaign.", "additionalProperties": true }, "CampaignCampaignItemSelectionType": { "type": "string", "enum": [ "UNKNOWN_TYPE", "MANUAL_SELECTION", "SMART_SELECTION" ], "default": "UNKNOWN_TYPE", "description": "Type of item selection for campaign. Choose MANUAL_SELECTION to select items manually or SMART_SELECTION to let Moloco choose items automatically." }, "CampaignCampaignState": { "type": "string", "enum": [ "PAUSED", "ENDED", "SCHEDULED", "ACTIVE", "INACTIVE", "ERROR", "IN_REVIEW", "REJECTED", "ARCHIVED" ], "default": "PAUSED", "title": "campaign’s state. Please refer to campaign states section in guides for more detailed information. (https://rmp-docs.moloco.com/docs/about-campaign-statuses)" }, "CampaignGoalMaximizeSales": { "type": "object", "description": "Detailed configuration of MAXIMIZE_SALES goal.", "additionalProperties": true }, "CampaignGoalOptimizeFixedCommissionRate": { "type": "object", "properties": { "commission_rate": { "type": "number", "format": "double", "description": "Target commission rate percentage, rounded off to one decimal point." } }, "description": "Detailed configuration of FIXED_COMMISSION_RATE goal.", "required": [ "commission_rate" ], "additionalProperties": true }, "CampaignGoalOptimizeFixedCpm": { "type": "object", "properties": { "target_cpm": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Detailed configuration of FIXED_CPM goal.", "required": [ "target_cpm" ], "additionalProperties": true }, "CampaignItemSelectionSmartSelectionSetting": { "type": "object", "properties": { "include": { "$ref": "#/components/schemas/SmartSelectionSettingInclude" }, "exclude": { "$ref": "#/components/schemas/SmartSelectionSettingExclude" } }, "description": "Configuration for Smart Selection filtering (e.g. brands, categories, on-sale, exclusions list).", "additionalProperties": true }, "CampaignLandingPageCampaignLandingPageType": { "type": "string", "enum": [ "UNKNOWN_LANDING_PAGE_TYPE", "CUSTOM_URL", "PRODUCT_DETAIL", "PRODUCT_LIST", "NONE" ], "default": "UNKNOWN_LANDING_PAGE_TYPE" }, "CampaignLandingPageCustomUrlSetting": { "type": "object", "properties": { "url": { "type": "string", "description": "The url of the landing page." } }, "description": "Detailed configuration of a custom url landing page.", "required": [ "url" ], "additionalProperties": true }, "CampaignLandingPageProductListSetting": { "type": "object", "description": "Detailed configuration of the product list page.", "additionalProperties": true }, "KeywordSettingNegativeKeyword": { "type": "object", "properties": { "value": { "type": "string" } }, "description": "NegativeKeyword describes target negative keyword targeting settings for the campaign", "required": [ "value" ], "additionalProperties": true }, "KeywordSettingPositiveKeyword": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "$ref": "#/components/schemas/commonCampaignKeywordMatchType" }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "PositiveKeyword describes target positive keyword targeting settings for the campaign", "required": [ "value", "match_type" ], "additionalProperties": true }, "PlacementSettingCartSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If set true, the campaign will target Cart Placement." }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting setting of the Cart Placement.", "required": [ "enabled" ], "additionalProperties": true }, "PlacementSettingCheckoutSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If set true, the campaign will target the Checkout Placement." }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting setting of the Checkout Placement.", "required": [ "enabled" ], "additionalProperties": true }, "PlacementSettingHomeSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If set true, the campaign will target the Home Placement." }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting setting of the Home Placement.", "required": [ "enabled" ], "additionalProperties": true }, "PlacementSettingRankingSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If set true, the campaign will target the Ranking Placement." }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting setting of the Ranking Placement.", "required": [ "enabled" ], "additionalProperties": true }, "PlacementSettingSearchSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If set true, the campaign will target the Search Placement." }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" }, "keyword_setting": { "$ref": "#/components/schemas/SearchSettingKeywordSetting" } }, "description": "Targeting setting of the Search Placement.", "required": [ "enabled" ], "additionalProperties": true }, "PlacementSettingTargetInventoryDetail": { "type": "object", "properties": { "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting detail for an inventory.", "additionalProperties": true }, "PlacementSettingTargetPlacementDetail": { "type": "object", "properties": { "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting detail for a placement.", "additionalProperties": true }, "RepresentedErrorDetail": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the metadata." }, "category": { "$ref": "#/components/schemas/commonErrorCategory" }, "metadata": { "type": "object", "description": "The metadata of the responded error.", "additionalProperties": true } }, "required": [ "type", "category" ], "additionalProperties": true }, "SearchSettingKeywordSetting": { "type": "object", "properties": { "keyword_type": { "$ref": "#/components/schemas/commonKeywordType" }, "negative_keywords": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordSettingNegativeKeyword" }, "description": "Negative keyword settings." }, "positive_keywords": { "type": "array", "items": { "$ref": "#/components/schemas/KeywordSettingPositiveKeyword" }, "description": "Positive keyword settings." } }, "description": "KeywordSetting describes target keyword targeting settings for the campaign", "required": [ "keyword_type" ], "additionalProperties": true }, "SmartSelectionSettingExclude": { "type": "object", "properties": { "item_ids": { "type": "array", "items": { "type": "string" }, "description": "Canonical catalog item IDs to exclude from the selection." } }, "description": "Exclusion filters for Smart Selection.", "additionalProperties": true }, "SmartSelectionSettingInclude": { "type": "object", "properties": { "brands": { "type": "array", "items": { "type": "string" }, "description": "Brands to include." }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/SmartSelectionSettingIncludeCategoryPath" }, "description": "Category paths to include. Each path is a hierarchical list of levels." }, "on_sale_only": { "type": "boolean", "description": "When true, only on-sale items are included." } }, "description": "Inclusion filters for Smart Selection.", "additionalProperties": true }, "SmartSelectionSettingIncludeCategoryPath": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "string" }, "description": "Ordered category levels, e.g. [\"Electronics\", \"Phones\", \"Smartphones\"]." } }, "description": "Hierarchical category path represented as ordered levels.", "additionalProperties": true }, "TargetingAudienceSetting": { "type": "object", "properties": { "label": { "type": "string", "description": "Label of the audience settings. This can be set only if the event_based_include_list or event_based_exclude_list is set. This label will be used to identify the custom audience settings in the campaign." }, "event_based_include_list": { "$ref": "#/components/schemas/AudienceSettingEventBasedList" }, "event_based_exclude_list": { "$ref": "#/components/schemas/AudienceSettingEventBasedList" }, "included_predefined_audience_list": { "$ref": "#/components/schemas/TargetingAudienceSettingPredefinedAudienceList" } }, "description": "AudienceSetting describes audience targeting settings for the campaign", "additionalProperties": true }, "TargetingAudienceSettingPredefinedAudience": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the predefined audience." } }, "description": "PredefinedAudience describes predefined audience used for the campaign.", "required": [ "id" ], "additionalProperties": true }, "TargetingAudienceSettingPredefinedAudienceList": { "type": "object", "properties": { "audiences": { "type": "array", "items": { "$ref": "#/components/schemas/TargetingAudienceSettingPredefinedAudience" }, "description": "Predefined audiences." }, "operator": { "$ref": "#/components/schemas/TargetingAudienceSettingPredefinedAudienceListOperator" } }, "description": "PredefinedAudienceList describes predefined audiences used for the campaign.", "required": [ "audiences", "operator" ], "additionalProperties": true }, "TargetingAudienceSettingPredefinedAudienceListOperator": { "type": "string", "enum": [ "UNKNOWN_OPERATOR", "AND", "OR" ], "default": "UNKNOWN_OPERATOR" }, "TargetingCustomSetting": { "type": "object", "properties": { "custom_targets": { "type": "array", "items": { "$ref": "#/components/schemas/TargetingCustomSettingCustomTarget" }, "description": "Custom targets." } }, "description": "CustomSetting describes target custom targeting settings for the campaign", "required": [ "custom_targets" ], "additionalProperties": true }, "TargetingCustomSettingCustomTarget": { "type": "object", "properties": { "key_id": { "type": "string", "description": "The id of the custom target key." }, "value_ids": { "type": "array", "items": { "type": "string" }, "description": "The ids of the custom target values." } }, "description": "CustomTarget describes target custom targeting for the campaign", "required": [ "key_id", "value_ids" ], "additionalProperties": true }, "TargetingPlacementSetting": { "type": "object", "properties": { "home_setting": { "$ref": "#/components/schemas/PlacementSettingHomeSetting" }, "category_setting": { "$ref": "#/components/schemas/TargetingPlacementSettingCategorySetting" }, "search_setting": { "$ref": "#/components/schemas/PlacementSettingSearchSetting" }, "product_detail_setting": { "$ref": "#/components/schemas/TargetingPlacementSettingProductDetailSetting" }, "cart_setting": { "$ref": "#/components/schemas/PlacementSettingCartSetting" }, "checkout_setting": { "$ref": "#/components/schemas/PlacementSettingCheckoutSetting" }, "ranking_setting": { "$ref": "#/components/schemas/PlacementSettingRankingSetting" }, "placements": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlacementSettingTargetPlacementDetail" }, "description": "Targeted placements keyed by placement_id. Configurable only for the Sponsored Product ad type. Support for the Sponsored Brand and Sponsored Display ad types is coming soon." }, "inventories": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlacementSettingTargetInventoryDetail" }, "description": "Targeted inventories keyed by inventory_id. Configurable only for the Sponsored Product ad type. Support for the Sponsored Brand and Sponsored Display ad types is coming soon." } }, "description": "PlacementSetting describes target placement targeting settings for the campaign", "additionalProperties": true }, "TargetingPlacementSettingCategorySetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If set true, the campaign will target the Category Placement." }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting setting of the Category Placement.", "required": [ "enabled" ], "additionalProperties": true }, "TargetingPlacementSettingProductDetailSetting": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If set true, the campaign will target the Product Detail Placement." }, "cost_price": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Targeting setting of the Product Detail Placement.", "required": [ "enabled" ], "additionalProperties": true }, "campaignAdOperationType": { "type": "string", "enum": [ "AD_OPERATION_TYPE_DEFAULT", "AD_OPERATION_TYPE_SELF_SERVED", "AD_OPERATION_TYPE_MANAGED" ], "default": "AD_OPERATION_TYPE_DEFAULT" }, "commonAsset": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the asset. Must be left unset for the new asset. Must be set for the other requests." }, "banner": { "$ref": "#/components/schemas/commonAssetBanner" }, "logo": { "$ref": "#/components/schemas/commonAssetLogo" }, "headline": { "$ref": "#/components/schemas/commonAssetHeadline" }, "custom_text": { "$ref": "#/components/schemas/commonAssetCustomText" }, "cta": { "$ref": "#/components/schemas/commonAssetCallToAction" }, "metadata": { "$ref": "#/components/schemas/commonAssetMetadata" }, "review_information": { "$ref": "#/components/schemas/commonReviewInformation" }, "created_at": { "type": "string", "format": "date-time", "description": "Created timestamp. API user should not touch this field; it is set internally.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "This field represents the last time the asset was modified. The system sets this value internally for you when you create or update a asset, so make sure this value matches the latest updated_at you received from the Read API." } }, "description": "Detailed settings for the asset.", "additionalProperties": true }, "commonAssetBanner": { "type": "object", "properties": { "creative_id": { "type": "string", "description": "ImageAsset ID referred to set the banner image" }, "target_inventory_dimension": { "$ref": "#/components/schemas/rmpcommonDimension" }, "image_url": { "type": "string", "description": "The banner image URL.", "readOnly": true }, "width": { "type": "integer", "format": "int64", "description": "The banner width (pixel).", "readOnly": true }, "height": { "type": "integer", "format": "int64", "description": "The banner height (pixel).", "readOnly": true }, "media_type": { "$ref": "#/components/schemas/rmpcommonMediaType" }, "alt_text": { "type": "string", "description": "Alt-text for the banner image for accessibility." } }, "additionalProperties": true }, "commonAssetCallToAction": { "type": "object", "properties": { "text": { "type": "string", "description": "Call-To-Action text" } }, "additionalProperties": true }, "commonAssetCustomText": { "type": "object", "properties": { "text": { "type": "string", "description": "Custom text content." }, "color": { "type": "string", "description": "Hex color for custom text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`)." }, "background_color": { "type": "string", "description": "Hex background color for custom text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`)." } }, "description": "Custom text for the asset.", "additionalProperties": true }, "commonAssetHeadline": { "type": "object", "properties": { "text": { "type": "string", "description": "Headline text" }, "color": { "type": "string", "description": "Hex color for headline text. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`)." }, "background_color": { "type": "string", "description": "Hex background color for the headline. Use a leading `#` plus 6 hex digits for RGB (e.g. `#FFFFFF`) or 8 hex digits for RGBA (e.g. `#FFFFFF00`)." } }, "additionalProperties": true }, "commonAssetLogo": { "type": "object", "properties": { "creative_id": { "type": "string", "description": "ImageAsset ID referred to set the logo image." }, "image_url": { "type": "string", "description": "The logo image URL." } }, "additionalProperties": true }, "commonAssetMetadata": { "type": "object", "properties": { "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value metadata attributes." } }, "additionalProperties": true }, "commonCampaignEnablingState": { "type": "string", "enum": [ "UNKNOWN_STATE", "ENABLED", "DISABLED" ], "default": "UNKNOWN_STATE", "description": "campaign’s enabling state that the advertiser can enable/disable. It will affect the campaign’s state." }, "commonCampaignKeywordMatchType": { "type": "string", "enum": [ "PHRASE", "EXACT", "BROAD" ], "default": "PHRASE", "description": "CampaignKeywordMatchType enumerates available match types for positive keyword targeting." }, "commonCampaignLandingPage": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignLandingPageCampaignLandingPageType" }, "custom_url_setting": { "$ref": "#/components/schemas/CampaignLandingPageCustomUrlSetting" }, "product_detail_setting": { "$ref": "#/components/schemas/commonCampaignLandingPageProductDetailSetting" }, "product_list_setting": { "$ref": "#/components/schemas/CampaignLandingPageProductListSetting" }, "id": { "type": "string", "description": "The id of the landing page. Must be left unset for the new landing page. Must be set for the other requests." }, "review_information": { "$ref": "#/components/schemas/commonReviewInformation" }, "created_at": { "type": "string", "format": "date-time", "description": "Created timestamp. API user should not touch this field; it is set internally.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "This field represents the last time the landing page was modified. The system sets this value internally for you when you create or update a landing page, so make sure this value matches the latest updated_at you received from the Read API." } }, "description": "Detailed settings for the landing page.", "required": [ "type" ], "additionalProperties": true }, "commonCampaignLandingPageProductDetailSetting": { "type": "object", "properties": { "item_id": { "type": "string" } }, "description": "Detailed configuration of the product detail page.", "required": [ "item_id" ], "additionalProperties": true }, "commonErrorCategory": { "type": "string", "enum": [ "DEFAULT_ERROR_CATEGORY", "INPUT_VALIDATION", "CHARACTER_LIMIT_EXCEEDED", "TIMESTAMP_MISMATCH", "FEATURE_NOT_ALLOWED", "REINVITE_NOT_ALLOWED", "LAST_OWNER_REVOKE_NOT_ALLOWED", "LAST_OWNER_DELETE_NOT_ALLOWED", "SSO_USER_JOIN_REQUEST_NOT_ALLOWED", "MFA_VERIFICATION_FAILED", "INSUFFICIENT_SPENDING_LIMIT", "AD_ACCOUNT_ALREADY_OWNED", "INSUFFICIENT_WALLET_BALANCE", "INSUFFICIENT_SPEND_CAP_BUDGET", "MAX_SPEND_CAP_COUNT_REACHED", "MAX_CAMPAIGNS_COUNT_PER_SPEND_CAP_REACHED", "MAX_CAMPAIGN_COUNT_REACHED", "MODIFY_ARCHIVED_CAMPAIGN_NOT_ALLOWED", "INVALID_CAMPAIGN_STATUS_FOR_ARCHIVE", "INVALID_MANAGED_CPT_CAMPAIGN_SCHEDULE", "INACTIVE_AD_ACCOUNT", "DUPLICATE_AUDIENCE", "INVALID_RESERVED_TIME_LINE_ITEM_SCHEDULE", "EXCEED_MAX_IMAGE_SIZE", "MAX_LABEL_COUNT_REACHED", "MAX_LABEL_VALUE_COUNT_REACHED", "MAX_LABEL_VALUE_RELATIONSHIP_COUNT_REACHED", "PLATFORM_INSIGHT_UNAVAILABLE", "MAX_CUSTOM_TARGETING_KEY_COUNT_REACHED", "INVALID_CUSTOM_TARGETING" ], "default": "DEFAULT_ERROR_CATEGORY", "title": "- INPUT_VALIDATION: INPUT_VALIDATION: reserved for 1 ~ 99\n - TIMESTAMP_MISMATCH: TIMESTAMP_MISSMATCH: reserved for 100 ~ 199\n - FEATURE_NOT_ALLOWED: General policy: 1000 ~ 1999\n - REINVITE_NOT_ALLOWED: User policy: 2000 ~ 2999\n - INSUFFICIENT_SPENDING_LIMIT: Account policy: 3000 ~ 3999\nThis policy includes ad manager account, ad account, and wallet related policies\n - MAX_CAMPAIGN_COUNT_REACHED: Campaign policy: 4000 ~ 4999\n - INVALID_RESERVED_TIME_LINE_ITEM_SCHEDULE: Returned when a RESERVED_TIME line item's schedule overlaps an existing enabled RD booking on the same inventory.\n - EXCEED_MAX_IMAGE_SIZE: Asset policy: 5000 ~ 5999\n - MAX_LABEL_COUNT_REACHED: Labeling policy: 6000 ~ 6999\n - PLATFORM_INSIGHT_UNAVAILABLE: Insight metric policy: 7000 ~ 7999\n - MAX_CUSTOM_TARGETING_KEY_COUNT_REACHED: Custom Targeting policy: 8000 ~ 8999" }, "commonKeywordType": { "type": "string", "enum": [ "ALL", "TARGET" ], "default": "ALL", "description": "KeywordType enumerates available keyword types for keyword targeting." }, "commonReviewInformation": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/commonReviewStatus" }, "rejection_reason": { "type": "string", "description": "Review rejection reason" }, "updated_at": { "type": "string", "format": "date-time", "description": "This field represents the last time the review was modified. The system sets this value internally for you when you create or update a review information, so make sure this value matches the latest updated_at you received from the Read API." } }, "additionalProperties": true }, "commonReviewStatus": { "type": "string", "enum": [ "UNKNOWN_REVIEW_STATUS", "IN_REVIEW", "APPROVED", "REJECTED" ], "default": "UNKNOWN_REVIEW_STATUS" }, "managementv1CampaignGoal": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/rmpcommonCampaignGoalType" }, "optimize_fixed_cpc": { "$ref": "#/components/schemas/managementv1CampaignGoalOptimizeFixedCpc" }, "optimize_roas": { "$ref": "#/components/schemas/managementv1CampaignGoalOptimizeRoas" }, "optimize_fixed_commission_rate": { "$ref": "#/components/schemas/CampaignGoalOptimizeFixedCommissionRate" }, "optimize_fixed_cpm": { "$ref": "#/components/schemas/CampaignGoalOptimizeFixedCpm" }, "maximize_sales": { "$ref": "#/components/schemas/CampaignGoalMaximizeSales" } }, "description": "CampaignGoal describes which cost-metric goal a campaign aims for.", "required": [ "type" ], "additionalProperties": true }, "managementv1CampaignGoalOptimizeFixedCpc": { "type": "object", "properties": { "target_cpc": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Detailed configuration of FIXED_CPC goal.", "required": [ "target_cpc" ], "additionalProperties": true }, "managementv1CampaignGoalOptimizeRoas": { "type": "object", "properties": { "target_roas": { "type": "integer", "format": "int64", "description": "Target ROAS in percent." } }, "description": "Detailed configuration of OPTIMIZE_ROAS goal.", "required": [ "target_roas" ], "additionalProperties": true }, "publicListCampaignsResponse": { "type": "object", "properties": { "campaigns": { "type": "array", "items": { "$ref": "#/components/schemas/v1Campaign" }, "description": "List of campaign infos." }, "without_catalog_item_ids": { "type": "boolean", "description": "Flag field that indicates whether campaigns are responded without catalog item ids or not." } }, "description": "ListCampaigns response.", "required": [ "campaigns" ], "additionalProperties": true }, "publicRepresentedError": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.(https://developers.google.com/actions-center/reference/grpc-api/status_codes)" }, "message": { "type": "string", "description": "The detailed message of responded error." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/RepresentedErrorDetail" }, "description": "The detailed information of responded error. Please refer to the error category section in guides for more detailed information.(https://rmp-docs.moloco.com/docs/management-api-error-categories)" } }, "title": "Overridden from grpc status(https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto)", "required": [ "code", "message", "details" ], "additionalProperties": true }, "rmpcommonAdType": { "type": "string", "enum": [ "UNKNOWN_AD_TYPE", "ITEM", "BRAND", "DISPLAY", "RESERVED_DISPLAY" ], "default": "UNKNOWN_AD_TYPE" }, "rmpcommonBudget": { "type": "object", "properties": { "period": { "$ref": "#/components/schemas/rmpcommonBudgetPeriod" }, "amount": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" } }, "description": "Budget describes the amount of budget to be consumed during the designated period.", "required": [ "period", "amount" ], "additionalProperties": true }, "rmpcommonBudgetPeriod": { "type": "string", "enum": [ "UNKNOWN_PERIOD", "DAILY", "WEEKLY" ], "default": "UNKNOWN_PERIOD" }, "rmpcommonCampaignGoalType": { "type": "string", "enum": [ "UNKNOWN_TYPE", "FIXED_CPC", "OPTIMIZE_ROAS", "FIXED_COMMISSION_RATE", "FIXED_CPM", "MAXIMIZE_SALES" ], "default": "UNKNOWN_TYPE", "description": "CampaignGoalType enumerates available goal types of campaign, which is Immutable.\n\n - FIXED_CPC: Goal type for the campaigns should be set to OptimizeFixedCpc message as setting value.\n - OPTIMIZE_ROAS: Goal type for the campaigns should be set to OptimizeRoas message as setting value.\n - FIXED_COMMISSION_RATE: Goal type for the campaigns should be set to OptimizeFixedCommissionRate message as setting value.\n - FIXED_CPM: Goal type for the campaigns should be set to OptimizeFixedCpm message as setting value.\n - MAXIMIZE_SALES: Goal type for the campaigns should have MaximizeSales message as setting value." }, "rmpcommonCurrency": { "type": "string", "enum": [ "UNKNOWN_CURRENCY", "USD", "KRW", "JPY", "EUR", "GBP", "SEK", "INR", "THB", "IDR", "CNY", "CAD", "RUB", "BRL", "SGD", "HKD", "AUD", "PLN", "DKK", "VND", "MYR", "PHP", "TRY", "VES", "AED", "CHF" ], "default": "UNKNOWN_CURRENCY", "description": "Currency enumerates available currencies.\n\n - UNKNOWN_CURRENCY: Unknown currency.\n - USD: US Dollar.\n - KRW: Korean Won.\n - JPY: Japanese Yen.\n - EUR: EU Euro.\n - GBP: British Pound.\n - SEK: Swedish Krona.\n - INR: India Rupee.\n - THB: Thailand Baht.\n - IDR: Indonesia Rupiah.\n - CNY: China Yuan.\n - CAD: Canada Dollar.\n - RUB: Russia Ruble.\n - BRL: Brazil Real.\n - SGD: Singapore Dollar.\n - HKD: Hong Kong Dollar.\n - AUD: Autrailia Dollar.\n - PLN: Poland Zloty.\n - DKK: Denmark Krone.\n - VND: Viet Nam Dong.\n - MYR: Malaysia Ringgit.\n - PHP: Philippines Peso.\n - TRY: Turkey Lira.\n - VES: Venezuela Bolívar Soberano.\n - AED: United Arab Emirates Dirham.\n - CHF: Swiss Franc." }, "rmpcommonDimension": { "type": "object", "properties": { "width": { "type": "integer", "format": "int64", "description": "The width of the dimension. Required." }, "height": { "type": "integer", "format": "int64", "description": "The height of the dimension. Required." } }, "required": [ "width", "height" ], "additionalProperties": true }, "rmpcommonMediaType": { "type": "string", "enum": [ "UNKNOWN_MEDIA_TYPE", "IMAGE", "VIDEO" ], "default": "UNKNOWN_MEDIA_TYPE" }, "rmpcommonMoneyMicro": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/rmpcommonCurrency" }, "amount_micro": { "type": "string", "format": "int64", "description": "Amount in micro unit. (e.g., 1234 means 0.001234)" } }, "description": "A monetary amount in a specific currency; the unit is micro at fixed point value for accurate accumulation operation.\nFor example, `{\"currency\": \"USD\", \"amount_micro\": \"1234\"}` means $0.001234.", "required": [ "currency", "amount_micro" ], "additionalProperties": true }, "rmpcommonTimeInterval": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "description": "Start time in RFC3339 format, e.g. \"2017-04-01T12:34:56+00:00\"" }, "end": { "type": "string", "format": "date-time", "description": "End time in RFC3339 format, e.g. \"2017-05-01-T21:09:08+00:00\"" } }, "description": "Campaign's interval with start and end timestamps in RFC3339 format.\nThe Campaign will conceptually run during [schedule_start, schedule_end] inclusively.\nIt is highly recommended that schedule.start is set to UTC corresponding to the beginning of the day (00:00:00), and schedule.end is set to UTC corresponding to the end of the day (23:59:59) both in the ad account's timezone.\nIf you want to set no end date, make sure your platform supports no end date setting and just leave schedule_end blank.", "required": [ "start" ], "additionalProperties": true }, "v1Campaign": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the campaign. Must be left unset for the campaign creation request. Must be set for the other requests." }, "title": { "type": "string", "description": "A descriptive name of the campaign." }, "ad_account_id": { "type": "string", "description": "The id of the ad account that owns this campaign. It is platform-specific ad_account_id. Value and format can vary according to each Platform." }, "hidden": { "type": "boolean", "description": "if this value is true, it means that a campaign is no longer visible and has been archived. Only disabled or ended campaigns could be hidden. Optional(Default: False)." }, "ad_type": { "$ref": "#/components/schemas/rmpcommonAdType" }, "schedule": { "$ref": "#/components/schemas/rmpcommonTimeInterval" }, "daily_budget": { "$ref": "#/components/schemas/rmpcommonMoneyMicro" }, "budget": { "$ref": "#/components/schemas/rmpcommonBudget" }, "targeting": { "$ref": "#/components/schemas/v1Targeting" }, "goal": { "$ref": "#/components/schemas/managementv1CampaignGoal" }, "catalog_item_ids": { "type": "array", "items": { "type": "string" }, "description": "List of catalog items belonging to the campaign. A catalog item id can be a product id or deal id in the catalogs. Note that an item can belong to multiple campaigns." }, "enabling_state": { "$ref": "#/components/schemas/commonCampaignEnablingState" }, "state": { "$ref": "#/components/schemas/CampaignCampaignState" }, "created_at": { "type": "string", "format": "date-time", "description": "Created timestamp. API user should not touch this field; it is set internally.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "This field represents the last time the campaign was modified. The system sets this value internally for you when you create or update a campaign, so make sure this value matches the latest updated_at you received from the ReadCampaign API." }, "item_selection": { "$ref": "#/components/schemas/CampaignCampaignItemSelection" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/commonAsset" }, "description": "Assets for the campaign. It contains all assets that would be used in the campaign. For the ad serving, only latest approved asset for each dimension would be used." }, "landing_pages": { "type": "array", "items": { "$ref": "#/components/schemas/commonCampaignLandingPage" }, "description": "Landing pages for the campaign. It contains all landing pages that would be used in the campaign. For the ad serving, only latest approved landing page would be used." }, "spend_cap_id": { "type": "string", "description": "The id of the spend cap that applies to this campaign. Available for SELF_SERVED performance-based sponsored ads campaigns on platforms with Spend Cap enabled. Once set, it cannot be changed." }, "ad_operation_type": { "$ref": "#/components/schemas/campaignAdOperationType" }, "alias": { "type": "string", "description": "The alias is the platform-defined identifier for the campaign." } }, "description": "Definition of a campaign.", "required": [ "ad_account_id", "schedule", "ad_type", "goal", "catalog_item_ids", "enabling_state", "created_at" ], "additionalProperties": true }, "v1Targeting": { "type": "object", "properties": { "placement_setting": { "$ref": "#/components/schemas/TargetingPlacementSetting" }, "audience_setting": { "$ref": "#/components/schemas/TargetingAudienceSetting" }, "custom_setting": { "$ref": "#/components/schemas/TargetingCustomSetting" }, "keyword_setting": { "$ref": "#/components/schemas/SearchSettingKeywordSetting" } }, "description": "Targeting describes the detailed targeting spec for the campaign.", "additionalProperties": true } } } } ```