MOLOCO Campaign API

openapi: 3.2.0
info:
  title: Moloco Campaign API
  version: '1.0'
  description: 'Operations tagged Campaign across 4 of this provider''s published API definitions: mcm-management-api.json, moloco-ads-campaign-management-api.json, moloco-ads-campaign-management-openapi.yml, moloco-commerce-media-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://<platform>-mgmt.mcm-api.moloco.com
- url: https://api.moloco.cloud
tags:
- name: Campaign
paths:
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews:
    get:
      summary: ListCampaignReviews
      description: List campaign reviews.
      operationId: RmpManagementApi_ListCampaignReviews
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicListCampaignReviewsResponse'
        '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: The id of the ad account that owns this campaign review.
        in: path
        required: true
        schema:
          type: string
      - name: campaign_id
        description: The id of the campaign that owns this campaign review.
        in: query
        required: false
        schema:
          type: string
      - name: brand_entity_type
        description: Brand entity type to be listed. Default is ALL type.
        in: query
        required: false
        schema:
          type: string
          enum:
          - ALL
          - ASSET
          - LANDING_PAGE
          default: ALL
      - name: brand_entity_ids
        description: Lists campaign reviews for given entity ids.
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    post:
      summary: CreateCampaignReview
      description: Create a campaign component's review. It generates the review for the given campaign's resources such as assets or landing page
      operationId: RmpManagementApi_CreateCampaignReview
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicCreateCampaignReviewResponse'
        '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: The id of the ad account that owns this campaign review.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                campaign_id:
                  type: string
                  description: The id of the campaign that owns this campaign review.
                brand_entity_type:
                  $ref: '#/components/schemas/commonBrandEntityType'
                brand_entity_id:
                  type: string
                  description: Brand entity id of the review. It must be asset id or landing page id.
                review_status:
                  $ref: '#/components/schemas/commonReviewStatus'
                rejection_reason:
                  type: string
                  description: If the review status is rejected, this field must contain the reason for rejection.
              description: CreateCampaignReview request.
              required:
              - campaign_id
              - brand_entity_type
              - brand_entity_id
              - review_status
              additionalProperties: true
        required: true
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews-bulk:
    put:
      summary: UpdateCampaignReviewsBulk
      description: Update campaign components' reviews in bulk.
      operationId: RmpManagementApi_UpdateCampaignReviewsBulk
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicUpdateCampaignReviewsBulkResponse'
        '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: The id of the ad account that owns this campaign review.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                campaign_id:
                  type: string
                  description: The id of the campaign that owns this campaign review.
                campaign_reviews:
                  type: array
                  items:
                    $ref: '#/components/schemas/v1CampaignReview'
                  description: Campaign reviews bulk update information.
              description: UpdateCampaignReviewsBulk request.
              required:
              - campaign_id
              - campaign_reviews
              additionalProperties: true
        required: true
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews/{brand_entity_id}:
    put:
      summary: UpdateCampaignReview
      description: Update a campaign component's review. It updates the review status of the given campaign's resources such as assets or landing page
      operationId: RmpManagementApi_UpdateCampaignReview
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicUpdateCampaignReviewResponse'
        '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: The id of the ad account that owns this campaign review.
        in: path
        required: true
        schema:
          type: string
      - name: brand_entity_id
        description: Brand entity id of the review. It must be asset id or landing page id.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                campaign_id:
                  type: string
                  description: The id of the campaign that owns this campaign review.
                campaign_review:
                  $ref: '#/components/schemas/v1CampaignReview'
              description: UpdateCampaignReview request.
              required:
              - campaign_id
              - campaign_review
              additionalProperties: true
        required: true
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /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: []
    post:
      summary: CreateCampaign
      description: Create a campaign of an ad account. The daily_budget field is deprecated. Please use the budget field as an alternative.
      operationId: RmpManagementApi_CreateCampaign
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicCreateCampaignResponse'
        '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
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                campaign:
                  $ref: '#/components/schemas/publicCreateCampaignRequestCampaignParams'
                option:
                  $ref: '#/components/schemas/v1CampaignUpsertOption'
              description: CreateCampaign request.
              required:
              - campaign
              additionalProperties: true
        required: true
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}:
    get:
      summary: ReadCampaign
      description: Read a campaign of an ad account.
      operationId: RmpManagementApi_ReadCampaign
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicReadCampaignResponse'
        '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: campaign_id
        description: Campaign id.
        in: path
        required: true
        schema:
          type: string
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    put:
      summary: UpdateCampaign
      description: Update a campaign of an ad account.
      operationId: RmpManagementApi_UpdateCampaign
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicUpdateCampaignResponse'
        '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: campaign_id
        description: Campaign id.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                campaign:
                  $ref: '#/components/schemas/publicUpdateCampaignRequestCampaignParams'
                option:
                  $ref: '#/components/schemas/v1CampaignUpsertOption'
              description: UpdateCampaign request.
              required:
              - campaign
              additionalProperties: true
        required: true
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}/items:
    post:
      summary: QueryItemsCampaign
      description: Query catalog items associated with the campaign
      operationId: RmpManagementApi_QueryItemsCampaign
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicItemSearchResponse'
        '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: campaign_id
        description: Campaign id.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page_index:
                  type: integer
                  format: int32
                  description: Index of the page to be returned. If empty, the default page_index will be 1.
                page_size:
                  type: integer
                  format: int32
                  description: Number of items to be returned on this page index. The maximum number is 5000.
                search_keyword:
                  type: array
                  items:
                    type: string
                  description: Search keyword. Specific string in the product id/title/category to search for.
                order_by:
                  type: array
                  items:
                    $ref: '#/components/schemas/publicItemSearchRequestOrderBy'
                  description: Sort options for the result. If empty, the default value will be PRICE DESC.
                filter:
                  type: array
                  items:
                    $ref: '#/components/schemas/commonfilterQueryFilter'
                  description: Query Filter.
                item_ids:
                  type: array
                  items:
                    type: string
                  description: List of item ids.
              description: ItemSearch request.
              required:
              - page_index
              - page_size
              additionalProperties: true
        required: true
      tags:
      - Campaign
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /cm/v1/campaign-overviews:
    get:
      summary: Query given Campaigns' setting overview
      description: Retrieve not only Campaign itself but all the entities related to the Campaign
      operationId: DspApi_QueryCampaignOverviews
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesQueryCampaignOverviewsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: ad_account_id
        description: The AdAccount ID which the Campaigns belong to.
        in: query
        required: true
        schema:
          type: string
      - name: product_id
        description: The Product ID which the Campaigns belongs to.
        in: query
        required: true
        schema:
          type: string
      - name: campaign_ids
        description: The list of Campaign IDs to query for the overview data.
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - Campaign
      security:
      - Bearer: []
    servers:
    - url: https://api.moloco.cloud
  /cm/v1/campaigns:
    get:
      summary: List up Campaigns.
      description: List up all Campaigns of the AdAccount or the Product.
      operationId: DspApi_ListCampaigns
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesListCampaignsResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesListCampaignsError'
      parameters:
      - name: ad_account_id
        description: The AdAccount ID to which the Campaigns belong to.
        in: query
        required: true
        schema:
          type: string
      - name: product_id
        description: The Product ID to which the Campaigns belong to.
        in: query
        required: false
        schema:
          type: string
      - name: states
        description: "The states of the Campaigns to be listed.\nDeleted Campaigns can not be listed with this parameter.\n\n - SUBMITTED: All the required data are entered and passed all the validation. It's eligible\nto be reviewed by Moloco for activation.\n - READY: Campaign is before schedule and internally ready but disabled.\nWill transit to PAUSED when it becomes on schdule.\n - UPCOMING: Campaign is before schedule and internally ready and disabled.\nWill transit to ACTIVE when it becomes on schdule.\n - ACTIVE: Campaign is on schedule and spending the budget.\n - PAUSED: Campaign is paused and not spending the budget.\n - SUSPENDED: Campaign activation is suspended by the system for the following reasons:\n- App has been found to be in violation of Moloco's creative policy.\n - COMPLETED: Campaign is completed but may still get attributions for some time."
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - UNKNOWN_CAMPAIGN_STATE
            - SUBMITTED
            - READY
            - UPCOMING
            - ACTIVE
            - PAUSED
            - SUSPENDED
            - COMPLETED
      - name: fetch_option
        description: "Fetch option to query Campaigns only deleted or all(deleted & not deleted).\nIf fetch_option is not specified, it will fetch only alive Campaigns.\n\n - FETCH_ALL: Fetch all Campaigns including deleted and not deleted.\n - FETCH_ONLY_DELETED: Fetch only deleted Campaigns."
        in: query
        required: false
        schema:
          type: string
          enum:
          - UNKNOWN_FETCH_OPTION
          - FETCH_ALL
          - FETCH_ONLY_DELETED
          default: UNKNOWN_FETCH_OPTION
      tags:
      - Campaign
      security:
      - Bearer: []
    post:
      summary: Create a new Campaign.
      description: Create a new Campaign.
      operationId: DspApi_CreateCampaign
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesCreateCampaignResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesCreateCampaignError'
      parameters:
      - name: ad_account_id
        description: The AdAccount ID which the Campaign belongs to.
        in: query
        required: true
        schema:
          type: string
      - name: product_id
        description: The Product ID which the Campaign belongs to.
        in: query
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/messagesCampaignInput'
        description: The Campaign to create and its initial PayoutItem and AdGroup information.
        required: true
      tags:
      - Campaign
      security:
      - Bearer: []
    servers:
    - url: https://api.moloco.cloud
  /cm/v1/campaigns/{campaign_id}:
    get:
      summary: Read an existing Campaign.
      description: Read an existing Campaign.
      operationId: DspApi_ReadCampaign
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadCampaignResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadCampaignError'
      parameters:
      - name: campaign_id
        description: The ID of the Campaign to be retrieved.
        in: path
        r

# --- truncated at 32 KB (290 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/moloco/refs/heads/main/openapi/moloco-campaign-api-openapi.yml