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://-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://-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://-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://-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://-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://-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://-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 required: true schema: type: string tags: - Campaign security: - Bearer: [] delete: summary: Delete an existing Campaign. description: Delete an existing Campaign. Only Campaigns that have never been activated can be deleted. operationId: DspApi_DeleteCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCampaignResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesDeleteCampaignError' parameters: - name: campaign_id description: The ID of the Campaign to be deleted. in: path required: true schema: type: string tags: - Campaign security: - Bearer: [] put: summary: Update an existing Campaign. description: Update an existing Campaign. operationId: DspApi_UpdateCampaign responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCampaignResponse' default: description: Error. Detailed cause can be found in the `details` field. content: application/json: schema: $ref: '#/components/schemas/messagesUpdateCampaignError' parameters: - name: campaign_id description: The ID of the Campaign to be updated. in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/dspCampaign' description: The Campaign to update. required: true tags: - Campaign security: - Bearer: [] servers: - url: https://api.moloco.cloud components: schemas: 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 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 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. campaignAdOperationType: type: string enum: - AD_OPERATION_TYPE_DEFAULT - AD_OPERATION_TYPE_SELF_SERVED - AD_OPERATION_TYPE_MANAGED default: AD_OPERATION_TYPE_DEFAULT rmpcommonBudgetPeriod: type: string enum: - UNKNOWN_PERIOD - DAILY - WEEKLY default: UNKNOWN_PERIOD TargetingPlacementSetting: type: object properties: home_setting: $ref: '#/components/schemas/PlacementSettingHomeSetting' category_setting: $ref: '#/components/schemas/PlacementSettingCategorySetting' 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' description: PlacementSetting describes target placement targeting settings for the campaign additionalProperties: true publicUpdateCampaignRequestCampaignParamsCampaignLandingPageParams: 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 set. created_at: type: string format: date-time description: Make sure this value matches the created_at you received from the ReadCampaign API. updated_at: type: string format: date-time description: Make sure this value matches the latest updated_at you received from the ReadCampaign API. description: Detailed settings for the landing page. required: - type additionalProperties: true CampaignLandingPageProductListSetting: type: object description: Detailed configuration of the product list page. additionalProperties: true 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 commonCampaignKeywordMatchType: type: string enum: - PHRASE - EXACT - BROAD default: PHRASE description: CampaignKeywordMatchType enumerates available match types for positive keyword targeting. v1ItemSearchResultRow: type: object properties: id: type: string description: Id of Item. title: type: string description: Title of Item. price: $ref: '#/components/schemas/rmpcommonMoney' sale_price: $ref: '#/components/schemas/rmpcommonMoney' link: type: string description: Link of Item. image_link: type: string description: Image link of Item. category: type: string description: 'DEPRECATED: Use categories field instead. Category of Item in old format with dedicated delimiters.' review_count: type: string format: int64 description: Review count of Item. rating_score: type: number format: float description: Rating of Item. is_active: type: boolean description: Activeness of Item. is_new: type: boolean description: Whether an Item is new. created_timestamp: type: string format: date-time description: Created timestamp of Item. gtin: type: string description: GTIN categories: type: array items: $ref: '#/components/schemas/v1ItemSearchResultRowCategoryPath' description: Structured category paths for the item. Supports multiple category assignments. brand: type: string description: Brand name of the item. brand_id: type: string description: Brand ID of the item. price_seller: $ref: '#/components/schemas/rmpcommonMoney' sale_price_seller: $ref: '#/components/schemas/rmpcommonMoney' description: ItemSearchResultRow represents a row of item search results. 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 KeywordSettingNegativeKeyword: type: object properties: value: type: string description: NegativeKeyword describes target negative keyword targeting settings for the campaign required: - value additionalProperties: true publicUpdateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' description: UpdateCampaign response. required: - campaign additionalProperties: true commonfilterFilterOperator: type: string enum: - UNKNOWN_FILTER_OPERATOR - EQ - GT - GE - LT - LE - CONTAINS - IN default: UNKNOWN_FILTER_OPERATOR v1CampaignReview: type: object properties: ad_account_id: type: string description: The id of the ad account that owns this campaign review. It is platform-specific ad account id. Value and format can vary according to each Platform. 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. created_at: type: string format: date-time description: Created timestamp. This field is automatically set during the creation process and should not be modified by the API user. readOnly: true updated_at: type: string format: date-time description: This field represents the last time the campaign review was modified. The system sets this value internally for you when you create or update a campaign review, so make sure this value matches the latest updated_at you received the campaign review. description: Definition of a campaign review. required: - ad_account_id - campaign_id - brand_entity_type - brand_entity_id additionalProperties: true PlacementSettingCategorySetting: 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 publicItemSearchResponse: type: object properties: rows: type: array items: $ref: '#/components/schemas/v1ItemSearchResultRow' description: Rows of items search result. num_counts: type: integer format: int32 description: Number of counts description: ItemSearch response required: - rows - num_counts 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 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 v1CampaignUpsertOption: type: object properties: include_all: type: boolean description: If set to true, add all items of the AdAccount to the campaign. In this case, catalog item ids in request will be ignored. Supported only for SELF_SERVED campaigns excluded_item_ids: type: array items: type: string description: List of item ids which will be excluded when creating or updating the campaign. Note that this option will be applied only if `include_all` field is set to true. The maximum number of excluded item ids is 5000. description: CampaignUpsertOption describes the option when campaign is created or updated. 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 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 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 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 commonReviewStatus: type: string enum: - UNKNOWN_REVIEW_STATUS - IN_REVIEW - APPROVED - REJECTED default: UNKNOWN_REVIEW_STATUS 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 publicCreateCampaignReviewResponse: type: object properties: campaign_review: $ref: '#/components/schemas/v1CampaignReview' description: CreateCampaignReview response. required: - campaign_review additionalProperties: true CampaignGoalMaximizeSales: type: object description: Detailed configuration of MAXIMIZE_SALES goal. additionalProperties: true v1ItemSearchResultRowCategoryPath: type: object properties: levels: type: array items: type: string description: Hierarchical category levels, e.g., ["Esport", "Ciclisme", "Shoes"] additionalProperties: true AudienceConfigAudienceTargetingEventType: type: string enum: - UNKNOWN_EVENT_TYPE - PURCHASE - ITEM_PAGE_VIEW default: UNKNOWN_EVENT_TYPE 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 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 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 publicUpdateCampaignRequestCampaignParams: type: object properties: title: type: string description: A descriptive name of the campaign. 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).' schedule: $ref: '#/components/schemas/rmpcommonTimeInterval' daily_budget: $ref: '#/components/schemas/rmpcommonMoneyMicro' updated_at: type: string format: date-time description: This field represents the last time the campaign was modified. Make sure this value matches the latest updated_at you received from the ReadCampaign API. 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. Required when the campaign is MANUAL_SELECTION item selection type. 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' item_selection: $ref: '#/components/schemas/CampaignCampaignItemSelection' assets: type: array items: $ref: '#/components/schemas/publicUpdateCampaignRequestCampaignParamsAssetParams' description: Asset information for the brand campaign. landing_pages: type: array items: $ref: '#/components/schemas/publicUpdateCampaignRequestCampaignParamsCampaignLandingPageParams' description: Landing page information for the brand campaign. ad_operation_type: $ref: '#/components/schemas/campaignAdOperationType' alias: type: string description: The alias is the platform-defined identifier for the campaign. description: List of params required to update a campaign. required: - schedule - goal - enabling_state - updated_at additionalProperties: true 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 TargetingAudienceSettingPredefinedAudienceListOperator: type: string enum: - UNKNOWN_OPERATOR - AND - OR default: UNKNOWN_OPERATOR 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 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 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 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 commonBrandEntityType: type: string enum: - UNKNOWN_BRAND_ENTITY_TYPE - ASSET - LANDING_PAGE default: UNKNOWN_BRAND_ENTITY_TYPE commonfilterQueryFilter: type: object properties: column: $ref: '#/components/schemas/commonfilterFilterColumn' filter_operator: $ref: '#/components/schemas/commonfilterFilterOperator' value: type: string description: 'Single value for filtering. Used with EQ, GE, LE operators. Examples: ''true''/''false'' for boolean, RFC3339 timestamp for CREATED_TIMESTAMP (e.g. ''2000-01-01T02:03:04.567890Z.)' values: type: array items: type: string description: Multiple values for filtering. To be used with IN operator. IN operator is only supported for Filter column. additionalProperties: true commonOrderByDirection: type: string enum: - UNKNOWN_ORDER_BY_DIRECTION - ASC - DESC default: UNKNOWN_ORDER_BY_DIRECTION CampaignLandingPageCampaignLandingPageType: type: string enum: - UNKNOWN_LANDING_PAGE_TYPE - CUSTOM_URL - PRODUCT_DETAIL - PRODUCT_LIST - NONE default: UNKNOWN_LANDING_PAGE_TYPE publicCreateCampaignRequestCampaignParamsAssetParams: type: object properties: 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' description: Detailed settings for the campaign asset. additionalProperties: true rmpcommonOrderByColumn: type: string enum: - UNKNOWN_ORDER_BY - ID - TITLE - PRICE - SALE_PRICE - CATEGORY - REVIEW_COUNT - RATING_SCORE - ACTIVE default: UNKNOWN_ORDER_BY CampaignGoalOptimizeFixedCpm: type: object properties: target_cpm: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Detailed configuration of FIXED_CPM goal. required: - target_cpm 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 publicListCampaignReviewsResponse: type: object properties: campaign_reviews: type: array items: $ref: '#/components/schemas/v1CampaignReview' description: Campaign reviews information. description: ListCampaignReviews response. required: - campaign_reviews additionalProperties: true 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) v1Targeting: type: object properties: placement_setting: $ref: '#/components/schemas/TargetingPlacementSetting' audience_setting: $ref: '#/components/schemas/TargetingAudienceSetting' custom_setting: $ref: '#/components/schemas/TargetingCustomSetting' description: Targeting describes the detailed targeting spec for the campaign. additionalProperties: true commonAssetCallToAction: type: object properties: text: type: string description: Call-To-Action text 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 AudienceSettingEventBasedListOperator: type: string enum: - UNKNOWN_OPERATOR - AND - OR default: UNKNOWN_OPERATOR publicCreateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' description: CreateCampaign response. required: - campaign additionalProperties: true publicUpdateCampaignReviewResponse: type: object properties: campaign_review: $ref: '#/components/schemas/v1CampaignReview' description: UpdateCampaignReview response. required: - campaign_review 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 publicReadCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/v1Campaign' description: ReadCampaign response. required: - campaign 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 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." 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 publicUpdateCampaignReviewsBulkResponse: type: object properties: campaign_reviews: type: array items: $ref: '#/components/schemas/v1CampaignReview' description: Campaign reviews information. description: UpdateCampaignReviewsBulk response. required: - campaign_reviews 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 commonKeywordType: type: string enum: - ALL - TARGET default: ALL description: KeywordType enumerates available keyword types for keyword targeting. 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. 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 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." publicCreateCampaignRequestCampaignParamsCampaignLandingPageParams: 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' description: Detailed settings for the landing page. required: - type 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 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. For example, `{"currency": "USD", "amount_micro": "1234"}` means $0.001234.' required: - currency - amount_micro additionalProperties: true 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 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 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 publicItemSearchRequestOrderBy: type: object properties: column: $ref: '#/components/schemas/rmpcommonOrderByColumn' direction: $ref: '#/components/schemas/commonOrderByDirection' additionalProperties: true 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 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" AudienceConfigAudienceTargetingCriteria: type: string enum: - UNKNOWN_CRITERIA - AD_ACCOUNT - AD_ACCOUNT_ITEM - CATEGORY - BRAND default: UNKNOWN_CRITERIA commonfilterFilterColumn: type: string enum: - UNKNOWN_FILTER_FIELD - IS_ACTIVE - CREATED_TIMESTAMP - CUSTOM_LABEL_0 - GTIN default: UNKNOWN_FILTER_FIELD rmpcommonAdType: type: string enum: - UNKNOWN_AD_TYPE - ITEM - BRAND - DISPLAY - RESERVED_DISPLAY default: UNKNOWN_AD_TYPE 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 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. The Campaign will conceptually run during [schedule_start, schedule_end] inclusively. It 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. If 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 commonAssetMetadata: type: object properties: attributes: type: object additionalProperties: type: string description: Key-value metadata attributes. 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 publicUpdateCampaignRequestCampaignParamsAssetParams: type: object properties: id: type: string description: The id of the asset. Must be set. 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' created_at: type: string format: date-time description: Make sure this value matches the created_at you received from the ReadCampaign API. updated_at: type: string format: date-time description: Make sure this value matches the latest updated_at you received from the ReadCampaign API. description: Detailed settings for the campaign asset. additionalProperties: true managementv1CampaignGoalOptimizeFixedCpc: type: object properties: target_cpc: $ref: '#/components/schemas/rmpcommonMoneyMicro' description: Detailed configuration of FIXED_CPC goal. required: - target_cpc additionalProperties: true 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 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 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 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 commonCampaignLandingPageProductDetailSetting: type: object properties: item_id: type: string description: Detailed configuration of the product detail page. required: - item_id additionalProperties: true rmpcommonMediaType: type: string enum: - UNKNOWN_MEDIA_TYPE - IMAGE - VIDEO default: UNKNOWN_MEDIA_TYPE rmpcommonMoney: type: object properties: currency: $ref: '#/components/schemas/rmpcommonCurrency' amount: type: number format: double description: Amount of money. (e.g., 12.34) description: "A monetary amount in a specific currency.\nFor example, `{currency: \"USD\", amount: 12.34}` means $12.34. \nPrice of the single item." required: - currency - amount additionalProperties: true publicCreateCampaignRequestCampaignParams: type: object properties: title: type: string description: A descriptive name of the campaign. 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. Required when the campaign is MANUAL_SELECTION item selection type. 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' item_selection: $ref: '#/components/schemas/CampaignCampaignItemSelection' assets: type: array items: $ref: '#/components/schemas/publicCreateCampaignRequestCampaignParamsAssetParams' description: Assets information for the brand campaign. landing_pages: type: array items: $ref: '#/components/schemas/publicCreateCampaignRequestCampaignParamsCampaignLandingPageParams' description: Landing pages information for the brand campaign. spend_cap_id: type: string description: The id of the spend cap. If set, the campaign will be associated with the spend cap. ad_operation_type: $ref: '#/components/schemas/campaignAdOperationType' alias: type: string description: The alias is the platform-defined identifier for the campaign. description: List of params required to create a campaign. required: - schedule - ad_type - goal - enabling_state additionalProperties: true MmpIntegrationMmpContext: type: object properties: adjust: $ref: '#/components/schemas/MmpContextAdjustContext' description: 1 is deprecated. Do not reuse it. adcloudcommonEventType: type: string enum: - UNKNOWN_EVENT_TYPE - BID_MADE - BID_WON - IMPRESSION - IMPRESSION_EXTRA - CLICK - INSTALL - CUSTOM default: UNKNOWN_EVENT_TYPE description: "Enumeration of event types supported by Moloco Ads.\n\nThis value is not part of the specification.\n\n - BID_MADE: A bid has been made for a bid request.\n - BID_WON: The bid has won the auction.\n - IMPRESSION: The ad impression has been served to the user.\n - IMPRESSION_EXTRA: Extra ad impression tracking info, e.g. 50% of a video ad has been shown.\n - CLICK: The ad has been clicked by the user.\n - INSTALL: The ad impression or click has been attributed with an app install.\n - CUSTOM: Custom actions that happen after install." adcloudcommonInterval: type: object properties: start: type: integer format: int32 end: type: integer format: int32 description: Interval represents a contiguous integer range [start, end). messagesListCampaignsError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesListCampaignsErrorAPIErrorInfo' CampaignGoalOptimizeClicksToApp: type: object properties: target_cpc: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per click in AdAccount-wide currency. Required when the mode is TARGET_CPC_CENTRIC.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToAppMode' description: Optimization mode. rate: type: number format: double description: '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].' description: Detailed configuration of OPTIMIZE_CPC_FOR_APP_UA goal. dspPostbackIntegration: type: object properties: mmp: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: MMP (e.g., Appsflyer, MAT, and so on). bundle_id: type: string description: "bundle_id to be used in the MMP integration. This corresponds to app_bundle in postback table.\nWe've relied on the identifier sent by the tracker to keep track of events in our internal database.\nWhen we want to target to the audience of a Campaign, we need to exactly specify the identifier in the\ntarget description. Unfortunately, it depends on tracker's policy especially for iOS app as follows:\n - Appsflyer: \"id\" + NUMBER, where NUMBER is app bundle.\n - Tune: independent string to NUMBER.\n e.g., memebox is denoted as \"com.memebox.ios.memebox\" while app bundle is 896990789\n - Adjust: same with the app_bundle\n - trackfnt: same with the app_bundle\nNote that 'bundle' field will be used as tracking bundle if 'tracking_bundle' is not given. In many\ncase, this field can be filled after we receive the very first event from tracker for an app." description: PostbackIntegration represents the postback integration information. commonEnablingState: type: string enum: - UNSPECIFIED - ENABLED - DISABLED default: UNSPECIFIED description: Enumeration of the enabling states with a default UNSPECIFIED state. CvConfigurationForSkanV4EventsPostback: type: object properties: postback_sequence_index: type: integer format: int32 measurement_window: type: integer format: int32 coarse_grained_values: type: object additionalProperties: $ref: '#/components/schemas/CvConfigurationForCustomEventsEventList' description: 'Information on relationships between coarse-grained conversion value and its detailed events. The possible keys of the map are low, medium or high.' fine_grained_values: type: object additionalProperties: $ref: '#/components/schemas/CvConfigurationForCustomEventsEventList' description: 'Information on relationships between fine-grained conversion value and its detailed events. The key of this map is the registered conversion value between 1 to 63.' messagesUpdateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The updated Campaign data. postback_integration_status: $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. AppPropertiesIosSecondaryMeasurement: type: string enum: - IOS_SECONDARY_MEASUREMENT_UNKNOWN - IOS_SECONDARY_MEASUREMENT_NONE - IOS_SECONDARY_MEASUREMENT_NA - IOS_SECONDARY_MEASUREMENT_SKAN - IOS_SECONDARY_MEASUREMENT_MMP - IOS_SECONDARY_MEASUREMENT_OTHER_MMP - IOS_SECONDARY_MEASUREMENT_OTHER_3P - IOS_SECONDARY_MEASUREMENT_INCREMENTALITY - IOS_SECONDARY_MEASUREMENT_CUSTOM default: IOS_SECONDARY_MEASUREMENT_UNKNOWN description: "Secondary measurement used for iOS apps.\n\n - IOS_SECONDARY_MEASUREMENT_UNKNOWN: Zero value. Every non-iOS app must have this value.\n - IOS_SECONDARY_MEASUREMENT_NONE: Unset value for iOS app. It means the secondary measurement is not decided yet.\n - IOS_SECONDARY_MEASUREMENT_NA: Not applicable. It means the iOS app does not use any secondary measurement.\n - IOS_SECONDARY_MEASUREMENT_SKAN: SKAdNetwork (SKAN). SKAN cannot be configured as both the primary and secondary measurement. If a secondary measurement is not required, use 'NA'.\n - IOS_SECONDARY_MEASUREMENT_MMP: MMP Probabilistic Attribution. MMP cannot be configured as both the primary and secondary measurement. If a secondary measurement is not required, use 'NA'.\n - IOS_SECONDARY_MEASUREMENT_OTHER_MMP: Other MMP measurements (e.g., unified iOS reporting, AppsFlyer SSOT, etc.)\n - IOS_SECONDARY_MEASUREMENT_OTHER_3P: Other 3P measurement tool (e.g., some customers are using other BI tools)\n - IOS_SECONDARY_MEASUREMENT_INCREMENTALITY: Incrementality measurement\n - IOS_SECONDARY_MEASUREMENT_CUSTOM: Custom measurement" dspAdAccount: type: object properties: id: type: string description: Unique identifier of the AdAccount. Automatically set by server on creation. title: type: string description: A descriptive name of the AdAccount. description: type: string description: An optional description of the AdAccount. timezone: type: string description: '[IANA timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) name. e.g. America/Los_Angeles.' currency: $ref: '#/components/schemas/adcloudcommonCurrency' custom_key_values: type: object additionalProperties: type: string description: '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.' billing_account_id: type: string description: BillingAccount to be applied by default. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. targets_future_preferences: type: object additionalProperties: $ref: '#/components/schemas/AdAccountTargetFuturePreferenceInfo' description: targets_future_preferences maps each target_id to corresponding TargetFuturePreferenceInfo. description: 'AdAccount represents a person or organization who owns Products and aims to promote the Products with advertising Campaigns.' required: - title CustomerActivityActivityCondition: type: object properties: product_id: type: string description: The ID of the Product of which PostbackIntegration info is used. event: type: string description: A case-sensitive string name of an event. (e.g. install, purchase). sliding_window_duration: $ref: '#/components/schemas/commonTimeDuration' description: The duration of time for which this condition is effective before now. CampaignGoalOptimizeAppInstallsMode: type: string enum: - UNKNOWN_MODE - TARGET_CPI_CENTRIC - BUDGET_CENTRIC - MARGIN_CENTRIC - FIXED default: UNKNOWN_MODE description: ' - FIXED: Read-only for AdCloud.' commonCircle: type: object properties: center: $ref: '#/components/schemas/commonLatLng' radius: type: number format: double description: Circle defines a circle with a center geo location and radius in km. CampaignGoalOptimizeCpaForWebUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE messagesListCampaignsResponse: type: object properties: campaigns: type: array items: type: object $ref: '#/components/schemas/dspCampaign' description: The list of Campaigns. messagesCreateCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The created Campaign data. ad_groups: type: array items: type: object $ref: '#/components/schemas/dspAdGroup' description: The AdGroup data which has been created along with the Campaign. postback_integration_status: $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. dspCreativeDynamicHtmlSrcPolicy: type: object properties: function: $ref: '#/components/schemas/PolicyPolicyFunction' description: 'Algorithm for selecting CatalogItems or CreativeElements for a game. PolicyFunction can be thought of as a function: PolicyFunctionConfig -> Policy -> CatalogItem list. In case a PolicyFunction does not need PolicyFunctionConfig, it can be thought of as Policy -> CatalogItem/CreativeElement list.' function_config: $ref: '#/components/schemas/PolicyPolicyFunctionConfig' num_items: type: integer format: int32 description: Number of items to be selected. catalog: type: string description: Catalog ID. To know the types of catalogs supported, contact customer support. item_capper: $ref: '#/components/schemas/PolicyItemCapper' description: Policy defines how to select CatalogItems. dspCampaign: type: object properties: id: type: string description: Unique identifier of the Campaign. Automatically set by server on creation. ad_account_id: type: string description: ID of the AdAccount the Campaign belongs to. readOnly: true product_id: type: string description: ID of the Product the Campaign belongs to. readOnly: true title: type: string description: A descriptive name of the Campaign. description: type: string description: An optional description of the Campaign. enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this campaign is enabled by the AdAccount. Only enabled Campaigns will be activated for serving once their eligibility is determined by Moloco. If the value of this field is unset or set to UNSPECIFIED in a Campaign creation request, it will be set to ENABLED automatically by the server. If the value is DISABLED when the Campaign is being reviewed and approved, the Campaign state will become PAUSED after approval. An active Campaign can be paused manually at any time by setting this field to DISABLED.' type: $ref: '#/components/schemas/dspCampaignType' description: Type of the Campaign. device_os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS type for this Campaign. state: $ref: '#/components/schemas/dspCampaignState' description: State of the Campaign. This state will be fully managed by the server. readOnly: true countries: type: array items: type: string description: '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: $ref: '#/components/schemas/adcloudcommonCurrency' description: 'Currency used for the Campaign. Set by the ad account''s currency setting.' readOnly: true schedule: $ref: '#/components/schemas/commonTimeInterval' description: 'Absolute time range to allow this Campaign to be served. Start is required and End is optional.' budget_schedule: $ref: '#/components/schemas/dspBudgetSchedule' description: Campaign-wide budget schedule specified by the AdAccount. tracking_company: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: Tracking company (e.g., Appsflyer, MAT, and so on). tracking_link_id: type: string description: '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: type: string description: 'The URL of the website that a Campaign wants to show to the audience. Required for web type Campaign.' goal: $ref: '#/components/schemas/dspCampaignGoal' description: Goal of the Campaign. skadn_input: $ref: '#/components/schemas/dspSKAdNetworkInput' description: 'Explicit input for SKAdNetwork traffic. It''s meaningful only for IOS App Campaign toward SKAdNetwork traffic.' custom_key_values: type: object additionalProperties: type: string description: '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: $ref: '#/components/schemas/dspAdTrackingAllowance' description: AdTrackingAllowance controls target audience in terms of personalized ad tracking settings. is_deleted: type: boolean description: True for deleted Campaign. readOnly: true auto_delete_at: type: string format: date-time description: 'Campaign in Paused or Finished state for specific time will be removed automatically. It represents when this will be deleted in UTC.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. serving_status: $ref: '#/components/schemas/CampaignServingStatus' readOnly: true launch_notices: type: array items: type: object $ref: '#/components/schemas/commonLaunchNotice' description: '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.' readOnly: true launch_notice_confirmations: type: array items: type: object $ref: '#/components/schemas/commonLaunchNotice' description: '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.' description: Campaign represents a single advertising Campaign. required: - type - device_os - schedule - goal - title - countries dspCreativeDynamicHtmlSrc: type: object properties: template_id: type: string description: ID of the template used to render this Creative. template_env: type: object additionalProperties: type: string description: Environment used to render this Creative. rendered_entry_html: type: string description: The entry HTML of the rendered Creative. html_requirement_attributes: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributes' description: 'Requirements of this Creative. Based on this field and inventory''s excludable Creative attributes, Moloco can filter out this Creative at serving time.' html_size_attributes: $ref: '#/components/schemas/dspCreativeHtmlSizeAttributes' description: Size-related attributes of this Creative. policy: $ref: '#/components/schemas/dspCreativeDynamicHtmlSrcPolicy' description: Policy defines how to select CatalogItems. description: '(Will be supported soon) Dynamic Creative. An instance of this would be used for Creatives to be rendered when the Creative is shown to user, i.e. an impression takes place, unlike bid-time rendering for static images.' required: - template_id - rendered_entry_html dspCreativeGroupAction: type: object properties: id: type: string description: Unique identifier of the Action. Automatically set by server on creation. user_id: type: string description: ID of the user who initiated this action if it's applicable. user_display_name: type: string description: Display name of the user by whom the action was taken. action_type: $ref: '#/components/schemas/CreativeGroupActionType' description: The type of an action. comment: type: string description: Comment for the action. created_at: type: string format: date-time description: Created time. readOnly: true description: The details of an action taken on the CreativeGroup. dspAdvertiserInfo: type: object properties: id: type: string description: Unique ID of the advertiser. title: type: string description: A descriptive name of the advertiser. description: type: string description: A description of the advertiser. description: 'AdvertiserInfo contains some basic information about an advertiser. It may be returned to Creative reviewers or other users with other non-advertiser roles to perform their duty without leaking any private advertiser information.' CampaignGoalOptimizeAppRoas: type: object properties: target_roas: type: number format: double description: 'Target return on advertising spend (ROAS) in percent. For example, a value 312.5 denotes 312.5% ROAS.' revenue_actions: type: array items: type: string description: '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: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per install in AdAccount-wide currency. Remarkable notes: - As of June 2019, this value is meaningful only for Campaigns of APP_USER_ACQUISITION type.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppRoasMode' description: Optimization mode. rate: type: number format: double description: '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: type: number format: double description: '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].' required: - revenue_actions CampaignGoalOptimizeAppRetention: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppRetentionMode' description: Optimization mode. target_cpi: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per install in AdAccount-wide currency. Required when the mode is BUDGET_CENTRIC and rate is unset.' rate: type: number format: double description: '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: type: number format: double description: '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].' description: Detailed configuration of OPTIMIZE_RETENTION_FOR_APP_UA goal. dspCreativeVastVideoSrc: type: object properties: vast_tag: type: string description: 'VAST tag to be used in VAST wrapper. E.g. [Example here](https://github.com/InteractiveAdvertisingBureau/VAST_Samples/blob/master/VAST%201-2.0%20Samples/Tremor-Video-Samples/vast_wrapper_linear_1.xml).' width: type: integer format: int64 description: Width of the Creative. readOnly: true height: type: integer format: int64 description: Height of the Creative. readOnly: true length_seconds: type: integer format: int64 description: Vast video length in seconds. description: Source of VAST (Video Ad Serving Template) video Creative. required: - vast_tag messagesDeleteCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesDeleteCampaignErrorAPIErrorInfo' PolicyFunctionConfigGameConfig: type: object properties: game_id: type: string description: Game id. it should correspond to GameID of dcr/api.proto. dspCampaignGoal: type: object properties: type: $ref: '#/components/schemas/dspCampaignGoalType' description: Type of the goal. optimize_app_installs: $ref: '#/components/schemas/CampaignGoalOptimizeAppInstalls' optimize_cpa_for_app_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppUa' optimize_app_roas: $ref: '#/components/schemas/CampaignGoalOptimizeAppRoas' optimize_clicks_to_web: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToWeb' optimize_clicks_to_app: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToApp' optimize_roas_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeRoasForAppRe' optimize_cpc_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeCpcForAppRe' optimize_fixed_cpm: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpm_2' optimize_cpa_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppRe' optimize_app_retention: $ref: '#/components/schemas/CampaignGoalOptimizeAppRetention' optimize_app_reattribution: $ref: '#/components/schemas/CampaignGoalOptimizeAppReattribution' optimize_cpa_repeated_for_app_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaRepeatedForAppUa' optimize_fixed_cpm_pacing: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpmPacing' optimize_landing_for_web_ua: $ref: '#/components/schemas/CampaignGoalOptimizeLandingForWebUa' optimize_cpa_for_web_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForWebUa' kpi_actions: type: array items: type: string description: List of KPI actions. description: CampaignGoal describes the details of goal of a Campaign. required: - type messagesListCampaignsErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN commonLaunchNotice: type: object properties: type: $ref: '#/components/schemas/LaunchNoticeNoticeType' description: The type of the notice. message: $ref: '#/components/schemas/LaunchNoticeNoticeMessage' description: The message for the notice. description: LaunchNotice contains notice information to be confirmed when launching a campaign. commonTagsThrottleCondition: type: object properties: tags: type: array items: type: string throttle_rate: type: number format: float description: 'Tags Thrrottle Condition. It specifies a throttle rate for a list of tags. All the tags in a list will have same throttle rate.' googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/protobufAny' AudienceTargetingConditionCoppaAcceptance: type: string enum: - UNKNOWN_COPPA - ACCEPT_COPPA_ONLY - DENY_COPPA default: UNKNOWN_COPPA description: "Indicates whether to bid according to the COPPA(Children's Online Privacy Protection Act)\nvalue of BidRequest.\n\n - UNKNOWN_COPPA: Doesn't filter BidRequest according to the coppa value.\n - ACCEPT_COPPA_ONLY: Bids to BidRequest with coppa=1.\n - DENY_COPPA: Bids to BidRequest with coppa=0 or empty coppa field." dspAdGroupAudienceExtension: type: object properties: paired_ad_group_id: type: string description: Audience extension paired ad group id. is_secondary: type: boolean description: True for the secondary ad_group, otherwise false. description: AdGroupAudienceExtension holds the ad_group settings for PAS audience extension. readOnly: true CreativeFeatureDynamicCreative: type: object properties: app_icon_url: type: string description: An app icon URL used by MRAID template. brand_logo_url: type: string description: A brand image URL used by MRAID template. business_title: type: string description: A business title used by template. cta_text: type: string description: Call-To-Action text. cta_color: type: string description: CTA button(background) color, do not confuse with cta_text_color. image_border_color: type: string description: Border color around image from catalog. title_preamble: type: string description: preamble for title. main_text: type: string description: A custom text for some templates. main_text_color: type: string description: Main text color. cta_text_color: type: string description: CTA text color, do not confuse with cta_color. background_color: type: string description: background color of dynamic creative. price_locale: type: string description: Locale for creatives. It is used to render prices. disclaimer_text: type: string description: Disclaimer text. disclaimer_text_color: type: string description: Disclaimer text color. sponsored_by: type: string description: Brand name of the sponsor/advertiser. description: Detailed configuration of DYNAMIC_CREATIVE feature. dspCreativeRichCustomHtmlSrc: type: object properties: entry_html: type: string description: 'The entry HTML code of the Creative. This field is read only. For write purposes, use playable_ad_source instead.' readOnly: true html_requirement_attributes: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributes' description: 'Requirements of this Creative. Based on this field and inventory''s excludable Creative attributes, Moloco can filter out this Creative.' html_size_attributes: $ref: '#/components/schemas/dspCreativeHtmlSizeAttributes' description: Size-related attributes of this Creative. max_video_duration_seconds: type: integer format: int64 description: 'Max duration of video sources, in seconds. It will be set to 0 if no video source is found in this Creative.' playable_ad_source: $ref: '#/components/schemas/CreativeRichCustomHtmlSrcPlayableADSourceData' description: 'PlayableAD source which is created by the third party like Facbook or Tresensa. For non-playableAD rich_custom_html, it can be left as blank but entryHTML should be filled. This field is available for only creation.' filename: type: string description: The filename of HTML file. description: 'Creative source based on arbitrary HTML. An instance of this is typically used for a playable Creative from AdAccounts. You can create RichCustomHtmlSrc by one of two methods: 1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL) 2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG).' required: - html_requirement_attributes PolicyPolicyFunctionConfig: type: object properties: trend: $ref: '#/components/schemas/PolicyFunctionConfigTrendConfig' description: TREND PolicyFunction's config. model: $ref: '#/components/schemas/PolicyFunctionConfigModelConfig' game: $ref: '#/components/schemas/PolicyFunctionConfigGameConfig' mcm_item_recommendation: $ref: '#/components/schemas/PolicyFunctionConfigMcmItemRecommendationConfig' next_item_selection: $ref: '#/components/schemas/PolicyFunctionConfigNextItemSelectionConfig' description: 'Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy -> CatalogItem/CreativeElement list.' adcloudcommonFloatingPointRange: type: object properties: start: type: number format: double end: type: number format: double PolicyFunctionConfigModelConfig: type: object properties: sourcer_type: $ref: '#/components/schemas/PolicySourcerType' evaluator_type: $ref: '#/components/schemas/PolicyEvaluatorType' evaluator_suffix: type: string user_signal_window_hours: type: integer format: int32 dspCreativeCustomHtmlSrc: type: object properties: html: type: string description: HTML for the custom HTML ad. width: type: integer format: int64 description: Width of the Creative. height: type: integer format: int64 description: Height of the Creative. image_url: type: string description: URL of the image. description: (Will be supported soon) Creative source based on custom html. required: - html - width - height - image_url commonGender: type: string enum: - UNKNOWN_GENDER - FEMALE - MALE default: UNKNOWN_GENDER description: 'Enumeration of gender types. This value is not part of the specification.' commonTimeInterval: 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: Interval with start and end timestamps in RFC3339 format. CustomerSetStatusDetailErrorId: type: string enum: - UNKNOWN_ERROR_ID - TAGGING_ERROR - REQUEST_ERROR - PREPROCESSING_ERROR - GENERIC_ERROR default: UNKNOWN_ERROR_ID description: Error id is an indicator of the error type. messagesCreateCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED - CAMPAIGN_TYPE_LANDING_URL_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED - CAMPAIGN_GOAL_CANNOT_CREATE - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES - CAMPAIGN_NO_VALID_TRACKING_COMPANY - CAMPAIGN_SKAN_INVALID_GOAL_ACTION - CAMPAIGN_NO_REVENUE_FOR_EVENT - CAMPAIGN_TYPE_MISMATCH_WITH_GOAL - CAMPAIGN_PAYOUT_ITEM_NUMBER_MISMATCH - CAMPAIGN_BUDGET_CURRENCY_MISMATCH - CAMPAIGN_OS_MISMATCH_WITH_TRACKING_LINK_OS - CAMPAIGN_PRODUCT_INCOMPATIBLE - CAMPAIGN_GOAL_TYPE_NOT_AVAILABLE - CAMPAIGN_SKAN_REACHED_MAX - CAMPAIGN_SKAN_PROHIBIT_WITHOUT_OWNERSHIP - CAMPAIGN_CREATIVE_GROUPS_NOT_FOUND - CAMPAIGN_BUDGET_REQUIRED - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES default: ERROR_REASON_UNKNOWN description: " - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN: Cannot specify skadn_input for non IOS campaign.\n - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN: Must specify skadn_input for IOS campaign.\n - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED: custom_options must be set for skadn_input.\n - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED: tracking_link_id is required for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED: landing_url is not allowed for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_REQUIRED: landing_url is required for WEB type campaign.\n - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED: campaign.tracking_link_id is not allowed for WEB type campaign.\n - CAMPAIGN_GOAL_CANNOT_CREATE: Cannot create a campaign with specified goal type.\n - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT: Specified campaign type cannot have non APP type product.\n - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES: Specified campaign type should have APP properties under the Product.\n - CAMPAIGN_NO_VALID_TRACKING_COMPANY: Creating campaign has invalid tracking company information.\nInput tracking link id should be set or target Product should have postback integration.\n - CAMPAIGN_SKAN_INVALID_GOAL_ACTION: The specified goal action is not valid event for SKAdNetwork.\n - CAMPAIGN_NO_REVENUE_FOR_EVENT: The specified goal action does not have revenue range.\n - CAMPAIGN_TYPE_MISMATCH_WITH_GOAL: The campaign cannot have specified type for the specified goal.\n - CAMPAIGN_PAYOUT_ITEM_NUMBER_MISMATCH: The number of PayoutItem should be matched with the length of Campaigns or 0.\n - CAMPAIGN_BUDGET_CURRENCY_MISMATCH: The budget currency should match the currency of the Campaign.\n - CAMPAIGN_OS_MISMATCH_WITH_TRACKING_LINK_OS: Target OS of campaign does not match with target OS of TrackingLink.\n - CAMPAIGN_PRODUCT_INCOMPATIBLE: The campaign type is incompatible with target product.\n - CAMPAIGN_GOAL_TYPE_NOT_AVAILABLE: The goal type is not available.\n - CAMPAIGN_SKAN_REACHED_MAX: Maximum number of campaigns per App targeting SKAdNetwork compatible traffic has already reached.\n - CAMPAIGN_SKAN_PROHIBIT_WITHOUT_OWNERSHIP: Creating SKAdNetwork targeting campaigns is not allowed without the ownership for the iOS app.\n - CAMPAIGN_CREATIVE_GROUPS_NOT_FOUND: Cannot find matching CreativeGroups for specified creative_group_ids.\n - CAMPAIGN_BUDGET_REQUIRED: Campaign budget is required.\n - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED: Campaign should be disabled if budget_ratio_percent of audience extension is 0% or 100%.\n - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM: Campaign has duplicated targeting ad platform.\n - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS: Campaign's targeting ad platforms should be superset of AdGroups'.\n - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES: Given campaign type cannot target multiple OSes." dspCustomerSetStatus: type: string enum: - UNKNOWN_STATUS - PREPARING - READY - FAILED default: UNKNOWN_STATUS description: "Unknown status.\n\n - PREPARING: Premature status.\n - READY: Ready.\n - FAILED: Failed to be ready." dspSharedAudienceTarget: type: object properties: id: type: string description: ID of the SharedAudienceTarget. Automatically set by server on creation. title: type: string description: A descriptive name of the SharedAudienceTarget. targeting_condition: $ref: '#/components/schemas/dspAudienceTargetingCondition' aud_size: type: string format: int64 description: Original audience size information. readOnly: true reachable_aud_size: type: string format: int64 description: Reachable audience size information. readOnly: true top_n_countries_aud_size_map: type: object additionalProperties: type: string format: int64 description: Top N countries audience size information. readOnly: true last_aud_size_computed_at: type: string format: date-time description: Last updated time of the audience size information. readOnly: true auto_delete_at: type: string format: date-time description: 'AudienceTarget used nowhere for specific time will be removed automatically. It represents when this will be deleted in UTC.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: 'SharedAudienceTarget represents a persisted AudienceTargetingCondition that can be shared across multiple Campaigns. It can be referenced by ID by other objects, e.g. the Audience object.' required: - title CampaignGoalOptimizeCpaRepeatedForAppUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE dspCreativeGroupReferrerInfo: type: object properties: ad_group_id: type: string description: ID of the AdGroup. ad_group_title: type: string description: Title of the AdGroup. ad_group_state: $ref: '#/components/schemas/commonEnablingState' description: EnablingState of the AdGroup. ad_group_experiment_id: type: string description: ID of the Experiment the AdGroup is involved in. campaign_id: type: string description: ID of the Campaign. campaign_title: type: string description: Title of the Campaign. campaign_description: type: string description: Description of the Campaign. campaign_state: $ref: '#/components/schemas/dspCampaignState' description: State of the Campaign. campaign_type: $ref: '#/components/schemas/dspCampaignType' description: Type of the Campaign. campaign_goal: $ref: '#/components/schemas/dspCampaignGoal' description: Goal of the Campaign. campaign_countries: type: array items: type: string description: The countries of the Campaign. campaign_schedule: $ref: '#/components/schemas/commonTimeInterval' description: Schedule of the Campaign. campaign_auto_delete_at: type: string format: date-time description: Auto delete timestamp of the Campaign. description: 'CreativeGroupReferrerInfo is CreativeGroup''s relational data. It contains which Campaign and AdGroup use the CreativeGroup.' messagesCreateCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesCreateCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string AudienceTargetingConditionSkanTraffic: type: string enum: - UNKNOWN_SKAN - TARGET_SKAN_ONLY - TARGET_NON_SKAN default: UNKNOWN_SKAN description: "Indicates whether to bid according to bid requests that support SKAN(SKAdNetwork) or not.\n\n - UNKNOWN_SKAN: Doesn't filter BidRequest according to support skan or not in this filter.\n - TARGET_SKAN_ONLY: Bids only for skan support traffic.\n - TARGET_NON_SKAN: Bids only for non-skan traffic." CampaignGoalOptimizeClicksToAppMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - TARGET_CPC_CENTRIC default: UNKNOWN_MODE ProductWebProperties: type: object properties: category: type: string description: 'The main IAB content category of the web product. When creating a WEB product, provide exactly one of ''category'' or ''categories''; the other field is derived automatically. Providing both is rejected. REQUIRED was dropped to allow ''categories''-only WEB creates; BRAND products reuse this message via ''brand.web'' and still require ''category'' (enforced at the API layer). Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf)' landing_url: type: string description: 'URL of the final destination page the audience users will be redirected to. Length of the URL should not exceed 10000 characters.' categories: type: array items: type: string description: 'Multiple IAB categories of the web product. When creating a product, provide exactly one of ''category'' or ''categories''; the other field is derived automatically. Providing both is rejected. Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf).' description: 'WebProperties defines the Web type Product specific properties. Should contain only one of ''app'' or ''web''.' dspCampaignGoalType: type: string enum: - 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 default: UNKNOWN_TYPE description: "Type enumerates available Campaign goal types.\nCorresponding details to the type must be specified.\n\n - OPTIMIZE_NONE: Goal type for the Campaigns which do not use any of pricing engines.\n - FIXED_CPM_FOR_APP_UA: Goal type for the UA Campaigns which do not use any of pricing engines.\n - FIXED_CPM_FOR_APP_RE: Goal type for the RE Campaigns which do not use any of pricing engines.\n - OPTIMIZE_CPI_FOR_APP_UA: Aim to drive app installs while satisfying the long-term cost per install.\n - OPTIMIZE_CPA_FOR_APP_UA: Aim to drive app installs while satisfying long-term cost per (certain) action.\n - OPTIMIZE_CPC_FOR_APP_UA: Aim to drive app installs while satisfying long-term cost per click.\n - OPTIMIZE_ROAS_FOR_APP_UA: Aim to drive app installs while satisfying long-term return on advertising spend (ROAS).\n - OPTIMIZE_ROAS_FOR_APP_RE: Aim to drive the user re-engagements while satisfying long-term return on advertising spend (ROAS).\n - OPTIMIZE_CPC_FOR_APP_RE: Aim to drive the user re-engagements while satisfying long-term cost per click.\n - OPTIMIZE_CPC_FOR_WEB_VISIT: Aim to drive the web-site visit while satisfying long-term cost per click.\n - OPTIMIZE_APP_INSTALLS: Deprecated. Aim to drive app installs while satisfying long-term cost per install.\n - OPTIMIZE_APP_ROAS: Deprecated. Aim to drive certain in-app actions while satisfying long-term return on advertising spend (ROAS).\n - OPTIMIZE_CLICKS_TO_WEB: Deprecated. Aim to drive clicks for web-site Product while satisfying long-term cost per click.\n - OPTIMIZE_CLICKS_TO_APP: Deprecated. Aim to drive clicks for web-site Product while satisfying long-term cost per click.\n - OPTIMIZE_CPA_FOR_APP_RE: Aim to drive the user re-engagements while satisfying long-term cost per (certain) action.\n - OPTIMIZE_RETENTION_FOR_APP_UA: Aim to drive the user retention.\n - OPTIMIZE_REATTRIBUTION_FOR_APP: Aim to drive user's app reattribution.\n - OPTIMIZE_CPA_REPEATED_FOR_APP_UA: Aim to drive app installs while satisfying long-term cost per (certain) action - repeated count.\n - FIXED_CPM_GENERIC: Default goal type for generic fixed-cpm. Fixed cpm with budget-pacing option is given.\n - FIXED_CPM_FOR_CTV: Default goal type for CTV. Fixed cpm with budget-pacing option is given.\n - FIXED_CPM_FOR_WEB_VISIT: Goal type for the WEB_VISIT Campaigns which do not use any of pricing engines.\n - OPTIMIZE_LANDING_FOR_WEB_UA: Goal type for optimizing landing event for web user acquisition campaign.\n - OPTIMIZE_CPA_FOR_WEB_UA: Goal type for optimizing cost per action for web user acquisition campaign." CustomAudienceSetCustomAudienceCondition: type: object properties: app_events: type: array items: type: object $ref: '#/components/schemas/CustomAudienceSetAppEvent' user_lists: type: array items: type: string description: 'IDs of pre-defined CustomerSets. IP CustomerSet is not included.' apps: type: array items: type: object $ref: '#/components/schemas/CustomAudienceSetApp' description: Matches users by app engagement regardless of event type. messagesListCampaignsErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesListCampaignsErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string adcloudcommonCreativeFeatureType: type: string enum: - UNKNOWN_CREATIVE_FEATURE_TYPE - GENERAL - DYNAMIC_CREATIVE default: UNKNOWN_CREATIVE_FEATURE_TYPE description: CreativeFeatureType. dspCreativeGroupPublisherProperties: type: object properties: skippable: type: boolean title: 'if the field is true, creatives of this group can be skipped. skippable ads reference : https://support.google.com/google-ads/answer/6055025?hl=en' video_target_ad_position: $ref: '#/components/schemas/CreativeVideoSrcTargetAdPosition' description: Target ad position of videos in this group. messagesReadCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CAMPAIGN_ALREADY_ARCHIVED default: ERROR_REASON_UNKNOWN description: ' - CAMPAIGN_ALREADY_ARCHIVED: The target campaign is already archived.' CampaignGoalOptimizeCpaForAppUa: type: object properties: action: type: string description: '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: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppUaMode' description: Optimization mode. rate: type: number format: double description: '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: type: number format: double description: '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: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Read-only. Operational target KPI value set by System. Populated when the mode is TARGET_PRIMARY_KPI_CENTRIC.' readOnly: true description: Detailed configuration of OPTIMIZE_CPA_FOR_APP_UA goal. required: - action messagesDeleteCampaignResponse: type: object adcloudcommonCreativeType: type: string enum: - UNKNOWN_CREATIVE_TYPE - IMAGE_BANNER - IMAGE_INTERSTITIAL - VIDEO_BANNER - VIDEO_INTERSTITIAL - NATIVE_LOGO - NATIVE_VIDEO - NATIVE_IMAGE - CUSTOM_HTML_BANNER - CUSTOM_HTML_INTERSTITIAL - TEMPLATE_HTML_BANNER - TEMPLATE_HTML_INTERSTITIAL - RICH_CUSTOM_HTML_BANNER - RICH_CUSTOM_HTML_INTERSTITIAL - DYNAMIC_HTML_BANNER - DYNAMIC_HTML_INTERSTITIAL default: UNKNOWN_CREATIVE_TYPE description: 'Enumeration of creative types supported by Moloco Ads. This value is not part of the specification.' dspCreativeGroup: type: object properties: id: type: string description: Unique identifier of the CreativeGroup. Automatically set by server on creation. ad_account_id: type: string description: ID of the AdAccount the CreativeGroup belongs to. readOnly: true product_id: type: string description: ID of the Product the CreativeGroup belongs to. readOnly: true title: type: string description: A descriptive name of the CreativeGroup. description: type: string description: An optional description about this CreativeGroup. enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this CreativeGroup is enabled by the AdAccount. If this field is unset or set to UNSPECIFIED, the server will change it to ENABLED automatically by default. An active CreativeGroup can be paused at any time by setting this field to DISABLED.' creative_ids: type: array items: type: string description: List of Creative ids in this CreativeGroup. status: $ref: '#/components/schemas/dspCreativeGroupStatus' description: 'The current status of the CreativeGroup. This state is readonly to the client after it gets into a SUBMITTED state. When a new CreativeGroup is created, it will be created in "SUBMITTED" state by default and it requires all the validations to pass. However, the client can specify "DRAFT" as the state in the creation request to request the CreativeGroup be saved as a draft without mandating all the required data. But any user entered data still need to pass their own validation individually for them to be accepted by the Moloco Ads backend. The client can switch a "DRAFT" Creative to "SUBMITTED" by specifying "SUBMITTED" as the state value in an update request later after all required data are entered, and full validation will be invoked on this state switch. After a CreativeGroup gets out of the DRAFT state, the state will be fully managed by the Moloco Ads backend and the state value will become readonly to the client. Any state value specified by the client in the future update requests will be ignored.' action_history: type: array items: type: object $ref: '#/components/schemas/dspCreativeGroupAction' description: List of actions taken on the current Creative. readOnly: true tracking_link_id: type: string description: 'MMP specific impression and click TrackingLinks defined specifically for this CreativeGroup. Optional for CreativeGroup which has APP type Product, not allowed for WEB type Product.' landing_url: type: string description: 'CreativeGroup specific landing URL. Optional for CreativeGroup which has WEB type Product, not allowed for APP type Product.' final_landing_url: type: string description: 'CreativeGroup specific final landing URL. Optional for CreativeGroup which has WEB type Product, not allowed for APP type Product. Deprecated. v1.3 would be the last version supporting this field. Use landing_url field instead.' mmp_tag: type: string description: 'Name of the mmp side reporting tag. mmp_tag should be URL-safe string.' audience: $ref: '#/components/schemas/adclouddspAudience' description: Creative group level audience. feature: $ref: '#/components/schemas/dspCreativeFeature' description: CreativeFeature and its configuration. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. publisher_properties: $ref: '#/components/schemas/dspCreativeGroupPublisherProperties' description: CreativeGroup is a group of Creatives that may serve with the same purpose, to be referenced by a Campaign. required: - title dspCreativeFeature: type: object properties: type: $ref: '#/components/schemas/adcloudcommonCreativeFeatureType' description: CreativeFeatureType. dynamic_creative: $ref: '#/components/schemas/CreativeFeatureDynamicCreative' description: CreativeFeature indicates the feature of the CreativeGroup and its configuration. CampaignGoalOptimizeAppReattribution: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppReattributionMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_REATTRIBUTION_FOR_APP goal. CampaignGoalOptimizeCpaForWebUa: type: object properties: action: type: string description: '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: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForWebUaMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' required: - action TrackingLinkVerificationAttemptUrlDataType: type: string enum: - UNKNOWN_URL_DATA_TYPE - CT_LINK - VT_LINK default: UNKNOWN_URL_DATA_TYPE description: The type of the UrlData that this attempt belongs to. AudienceTargetingConditionMediaChannelType: type: string enum: - UNKNOWN_MEDIA_CHANNEL_TYPE - APP - WEB default: UNKNOWN_MEDIA_CHANNEL_TYPE description: ' - UNKNOWN_MEDIA_CHANNEL_TYPE: This value is not part of the specification.' AudienceTargetingConditionDeviceOsFilter: type: object properties: os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS. min_version: type: string max_version: type: string description: Device OS and version filter condition. required: - os dspCreativeType: type: string enum: - UNKNOWN_TYPE - IMAGE - VIDEO - VAST_VIDEO - NATIVE - NATIVE_IMAGE - NATIVE_VIDEO - CUSTOM_HTML - TEMPLATE_HTML - RICH_CUSTOM_HTML - DYNAMIC_HTML - AD_TAG default: UNKNOWN_TYPE description: "Type of the Creative. Only one of the Creative source fields matching the type is allowed to be specified.\n\n - UNKNOWN_TYPE: This value is not part of the specification.\n - IMAGE: Image Creative. The image Creative source must be specified for this type.\n - VIDEO: Video Creative. The video Creative source must be specified for this type.\n - VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type.\n - NATIVE: Deprecated. v1.5 is the last version supporting this version.\nNative Creative. The native Creative source must be specified for this type.\n - NATIVE_IMAGE: Native image Creative. The native image Creative source must be specified for this type.\n - NATIVE_VIDEO: Native video Creative. The native video Creative source must be specified for this type.\n - CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative source must be specified for this type.\n - TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The template HTML Creative source must be specified for this type.\n - RICH_CUSTOM_HTML: The rich custom HTML Creative. The rich custom HTML Creative source must be specified for this type.\n - DYNAMIC_HTML: (Will be supported soon) The dynamic HTML Creative. The dynamic HTML Creative source must be specified for this type.\n - AD_TAG: (Will be supported soon) Third-party ad tag Creative with script-based or vast tag-based ad tag." CustomAudienceSetAppEvent: type: object properties: product_id: type: string description: The ID of the Product of which PostbackIntegration info is used. event: type: string description: A case-sensitive string name of an event. (e.g. install, purchase). sliding_window_duration: $ref: '#/components/schemas/commonTimeDuration' description: The duration of time for which this condition is effective before now. dspProductType: type: string enum: - UNKNOWN_TYPE - APP - WEB default: UNKNOWN_TYPE description: "Product type.\n\n - UNKNOWN_TYPE: This value is not part of the specification.\n - APP: App type.\n - WEB: Web type." SKAdNetworkInputTargetingState: type: string enum: - UNKNOWN_TARGETING_STATE - TARGET_DO_NOT_CARE - TARGET_ALL - TARGET_SKADN_ONLY - TARGET_NON_SKADN_ONLY - TARGET_CUSTOM default: UNKNOWN_TARGETING_STATE description: "Enumeration of all supported targeting state w.r.t SKAdNetwork traffic.\nTARGET_ALL, TARGET_SKADN_ONLY, TARGET_NON_SKADN_ONLY is a predefined set of traffic.\nTARGET_CUSTOM is to support DIY configuration of traffic.\n\nThis value is not part of the specification.\n\n - TARGET_DO_NOT_CARE: Do not care whether the Campaign targets SKAdNetwork traffic or not.\n - TARGET_ALL: Target all traffic including SKAdNetwork and others.\nIt includes SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE.\n - TARGET_SKADN_ONLY: Target only SKAdNetwork traffic.\nIt includes SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE.\n - TARGET_NON_SKADN_ONLY: Target only non-SKAdNetwork traffic.\nIt includes SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE, SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE.\n - TARGET_CUSTOM: Target customized configuration traffic.\nWhen the targeting_state is set with this value, then custon_options should be also set." AppPropertiesIosPrimaryMeasurement: type: string enum: - IOS_PRIMARY_MEASUREMENT_UNKNOWN - IOS_PRIMARY_MEASUREMENT_NONE - IOS_PRIMARY_MEASUREMENT_SKAN - IOS_PRIMARY_MEASUREMENT_MMP default: IOS_PRIMARY_MEASUREMENT_UNKNOWN description: "Primary measurement used for iOS apps.\n\n - IOS_PRIMARY_MEASUREMENT_UNKNOWN: Zero value. Every non-iOS app must have this value.\n - IOS_PRIMARY_MEASUREMENT_NONE: Unset value for iOS app. It means the primary measurement is not decided yet.\n - IOS_PRIMARY_MEASUREMENT_SKAN: SKAdNetwork (SKAN)\n - IOS_PRIMARY_MEASUREMENT_MMP: MMP Probabilistic Attribution" TrackingLinkUrlData: type: object properties: url: type: string description: URL of the TrackingLink. status: $ref: '#/components/schemas/TrackingLinkUrlDataVerificationStatus' description: 'The verification status of the supplied URL. It''s managed by the Moloco servers and is readonly to the client.' readOnly: true unverified_status_data: $ref: '#/components/schemas/UrlDataUnverifiedStatusData' verifying_status_data: $ref: '#/components/schemas/UrlDataVerifyingStatusData' verified_status_data: $ref: '#/components/schemas/UrlDataVerifiedStatusData' required: - url CampaignGoalOptimizeFixedCpmPacing: type: object properties: target_cpm: $ref: '#/components/schemas/adcloudcommonMoney' description: Target cpm in USD currency (Not in AdAccount currency). pacing_mode: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpmPacingPacingMode' rate: type: number format: double description: 'Budget consume rate. The rate should be in (0, 2].' description: 'General fixed-cpm goal with pacing option. Currently for FIXED_CPM_FOR_CTV and FIXED_CPM_GENERIC.' required: - target_cpm MmpContextAdjustContext: type: object properties: url_host_universal_link: type: string title: Immutable. Ends with ".adj.st" ex) moloco.adj.st url_host_branded_link: type: string title: Immutable. Ends with ".go.link" ex) moloco.go.link CampaignGoalOptimizeClicksToWebMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - TARGET_CPC_CENTRIC default: UNKNOWN_MODE commonPostbackEventCount: type: object properties: app_bundle: type: string range: $ref: '#/components/schemas/adcloudcommonInterval' events: type: array items: type: string description: Postback Event Count. It specifies an interval for a list of events from an app bundle. dspCreativeGroupStatus: type: string enum: - UNKNOWN_STATUS - DRAFT - SUBMITTED - REVIEW_NOT_NEEDED - UNDER_REVIEW - APPROVED - DISAPPROVED default: UNKNOWN_STATUS description: "Enumeration of all possible CreativeGroup status.\n\n - UNKNOWN_STATUS: This value is not part of the specification.\n - DRAFT: The CreativeGroup is created but not submitted for review yet.\n - SUBMITTED: The CreativeGroup is submitted and pending review.\n - REVIEW_NOT_NEEDED: Review is determined by Moloco not needed for this CreativeGroup.\n - UNDER_REVIEW: The CreativeGroup is being reviewed.\n - APPROVED: The CreativeGroup has been approved.\n - DISAPPROVED: The CreativeGroup has been rejected." CampaignGoalOptimizeLandingForWebUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE dspTrackingLinkVerificationAttempt: type: object properties: id: type: string description: The ID of the TrackingLinkVerificationAttempt. ad_account_id: type: string description: The AdAccount ID that this attempt belongs to. tracking_link_id: type: string description: The ID of the TrackingLink that this attempt belongs to. url_data_type: $ref: '#/components/schemas/TrackingLinkVerificationAttemptUrlDataType' user_id: type: string description: The ID of the user who is conducting the link verification. user_email: type: string description: The user's email. user_name: type: string description: The user's name. tracking_bundle_id: type: string description: The tracking bundle value appears at the postback event. resolved_url: type: string description: 'The URL sent to the MMP for the verification test. This is the macro expansion result of the original link URL.' resolved_idfa: type: string description: The IDFA value used to generate the resolved_url. started_at: type: string format: date-time description: The starting time of the verification. verified_at: type: string format: date-time description: The time when the verification test is completed. description: TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink. CampaignGoalOptimizeFixedCpm_2: type: object properties: target_cpm: $ref: '#/components/schemas/adcloudcommonMoney' description: Target cost per click in AdAccount-wide currency. description: Detailed configuration of FIXED_CPM_* goal. required: - target_cpm CampaignGoalOptimizeCpaForAppUaMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - MARGIN_CENTRIC - TARGET_PRIMARY_KPI_CENTRIC default: UNKNOWN_MODE messagesDeleteCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesDeleteCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string commonLatLng: type: object properties: latitude: type: number format: double longitude: type: number format: double description: Point defines a geo location by latitude, longitude. dspProduct: type: object properties: id: type: string description: Unique identifier of the Product. Automatically set by server on creation. ad_account_id: type: string description: The ID of the AdAccount the Product belongs to. readOnly: true title: type: string description: A descriptive name of the Product. description: type: string description: A short description of the Product. advertiser_domain: type: string description: 'Advertiser domain (e.g., "ford.com"). Usually the domain of AdAccounts''s web page. From v1.7.4, it should be non empty if the value of allow_empty_advertiser_domain is false. If the value is empty, some exchanges may deny campaigns under the product.' allow_empty_advertiser_domain: type: boolean description: 'A flag to allow empty value of advertiser_domain. Setting this flag to true acknowledges that some exchanges may deny campaigns if the advertiser_domain is empty. From v1.7.4, the value should be true if the value of advertiser_domain is empty.' device_os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS of the Product. It means that the OS of the device where the Campaign of this Product is provided. developer_name: type: string description: 'The developer name of the Product. Some publishers request the sponsor information for the native Creative. The value of developer_name will be used to fill that information. Please note that this value could be displayed on user''s screen. If this field is empty, native Creative''s title will be used.' type: $ref: '#/components/schemas/dspProductType' description: The type of the Product. app: $ref: '#/components/schemas/ProductAppProperties' description: Required for APP type. web: $ref: '#/components/schemas/ProductWebProperties' description: Required for WEB type. dynamic_creative_property: $ref: '#/components/schemas/ProductDynamicCreativeProperty' description: Properties for using dynamic Creative. Immutable. suspension_history: type: array items: type: object $ref: '#/components/schemas/ProductSuspensionAction' description: 'List of suspension actions. It is sorted by timestamp in descending order, so the first one is the current suspension result.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. readOnly: true description: 'Product represents an app (per device OS) or a website that an AdAccount want to promote with a Campaign. A Campaign should be associated with a single Product.' required: - type - title - advertiser_domain dspCampaignState: type: string enum: - UNKNOWN_CAMPAIGN_STATE - SUBMITTED - READY - UPCOMING - ACTIVE - PAUSED - SUSPENDED - COMPLETED default: UNKNOWN_CAMPAIGN_STATE description: "CampaignState represents various states of a Campaign.\n\nThis value is not part of the specification.\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." messagesReadCampaignResponse: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The retrieved Campaign data. postback_integration_status: $ref: '#/components/schemas/dspPostbackIntegrationStatus' description: The postback integration status. dspCreativeHtmlRequirementAttributesFlag: type: string enum: - UNKNOWN_FLAG - MRAID2 - IN_BANNER_VIDEO default: UNKNOWN_FLAG description: "This value is not part of the specification.\n\n - MRAID2: AdX: 32 MraidType: MRAID.\n - IN_BANNER_VIDEO: AdX: 95 VideoType: In-Banner Video (Publisher Blockable)." title: "This is similar to AdX' Creative attributes:\n https://storage.googleapis.com/adx-rtb-dictionaries/buyer-declarable-creative-attributes.txt\nSince the purpose of these flags is filtering, we also take into consideration\nwhat inventories can ban:\n https://storage.googleapis.com/adx-rtb-dictionaries/publisher-excludable-creative-attributes.txt" CreativeHtmlSizeAttributesFixed: type: object properties: width: type: integer format: int64 height: type: integer format: int64 AudienceTargetingConditionPlacementReason: type: string enum: - UNKNOWN_PLACEMENT_REASON - REASON_BRAND_SAFETY - REASON_PERFORMANCE_IMPROVEMENT - REASON_AGE_RESTRICTION - REASON_FRAUD - REASON_OWN_APP_CROSS_PROMOTION_BLOCKING - REASON_NOT_OPERATING_IN_A_SPECIFIC_LOCATION - REASON_INCREMENTALITY_TESTING - REASON_OTHER default: UNKNOWN_PLACEMENT_REASON description: The reason of the placement. It is used to track the reason why customers set the allowed or blocked app's. dspAdTrackingAllowance: type: string enum: - UNKNOWN_AD_TRACKING_ALLOWANCE - NON_LAT_ONLY - LAT_ONLY - DO_NOT_CARE default: UNKNOWN_AD_TRACKING_ALLOWANCE description: "AdTrackingAllowance represents targeting conditions regarding\npersonalized ad tracking.\n\nThis value is not part of the specification.\n\n - NON_LAT_ONLY: Campaign will bid only to the traffic with IDFA as usual Campaigns.\n - LAT_ONLY: Campaign will bid only to the traffic without IDFA. Limited Ad Tracking only.\n - DO_NOT_CARE: Campaign will not care whether it has an IDFA or not. Default as of now." ConversionValueConfigurationItemCvConfigurationForSkanV4Events: type: object properties: postbacks: type: array items: type: object $ref: '#/components/schemas/CvConfigurationForSkanV4EventsPostback' messagesCreateCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesCreateCampaignErrorAPIErrorInfo' title: CampaignError ProductAppProperties: type: object properties: bundle_id: type: string description: App bundle ID. Immutable. category: type: string description: 'The main IAB content category of the App. This field is now output only and will be removed after v1.10. Before that, it is auto-filled from the categories field. Please use ''categories'' field instead. Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf).' readOnly: true categories: type: array items: type: string description: 'The IAB categories of the App. All the categories must be valid IAB categories. On create Product, the system checks the App Metadata Inventory: if the app is found, the Inventory values override user input; otherwise, the API uses the provided input. This field is editable only when the app is not in Inventory, and becomes read-only if the app exists there. Valid category values can be found in section "5.1 Content Categories" in the [OpenRTB API Specification] (https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf).' category_readable: type: string title: App category in a human-readable format from the app store rating: type: number format: double description: App rating in the range of [0, 5]. rating_cnt: type: string format: int64 title: Total number of app ratings from the app store app_store_url: type: string description: App store URL for Google Play, Apple App Store or Other App Markets. available_countries: type: array items: type: string description: 'Country codes where the app is available in the store. The value format is ISO-3166-1 Alpha-2 using uppercase letters only, such as "KR" or "US".' unavailable_countries: type: array items: type: string description: 'Country codes where the app is unavailable in the store. The value format is ISO-3166-1 Alpha-2 using uppercase letters only, such as "KR" or "US".' rtb_bundle_ids: type: array items: type: string description: 'RTB bundle names that related to the target app for which a Campaign runs. This field is useful when the target app and/or its family apps send out bid requests to the exchanges: (1) by nature, the Campaign must not deliver ad to the AdAccount''s own apps; (2) it''s better to ignore such apps for ads serving model training.' postback_integration: $ref: '#/components/schemas/dspPostbackIntegration' description: Active postback integration for the app. mmp_integration: $ref: '#/components/schemas/dspMmpIntegration' description: MmpIntegration of the Product. Immutable. skadn_mmp_integration: $ref: '#/components/schemas/dspMmpIntegration' description: SKAN MmpIntegration of the Product. Immutable. content_rating: type: string description: Content rating(App store age information) of the App. storekit_enabled: type: boolean description: StoreKit can be applied only for iOS app. autoinline_enabled: type: boolean description: AutoInline can be applied only for Android app. localized_app_name: type: object additionalProperties: type: string title: Field for mapping language to it’s app name readOnly: true localized_app_icon_url: type: object additionalProperties: type: string description: Field for url of app icon. readOnly: true localized_app_screenshots: type: object additionalProperties: $ref: '#/components/schemas/AppPropertiesAppScreenshots' description: App screenshots from the app store. readOnly: true app_event_types: type: object additionalProperties: $ref: '#/components/schemas/AppPropertiesAppEventType' description: 'Information on relationships between in-app events and its event type. This field is to categorize in-app events and categorized event types for each in-app event are used to optimize training of ML model.' description: type: string title: App description from the app store short_description: type: string description: Short description (promo text) from the app store. ios_primary_measurement: $ref: '#/components/schemas/AppPropertiesIosPrimaryMeasurement' description: Primary measurement used for iOS apps. ios_secondary_measurement: $ref: '#/components/schemas/AppPropertiesIosSecondaryMeasurement' description: Secondary measurement used for iOS apps. ios_custom_measurement: type: string title: 'Custom secondary measurement label for iOS apps. Set only when ios_secondary_measurement == IOS_SECONDARY_MEASUREMENT_CUSTOM. If set when the secondary measurement is not CUSTOM, this field must be empty' description: 'AppProperties defines the App type Product specific properties. Should contain only one of ''app'' or ''web''.' required: - bundle_id AudienceTargetingConditionLocationSet: type: object properties: osm_ids: type: array items: type: string format: int64 description: OpenStreetMap IDs to represent areas to target. zipcodes: type: array items: type: object $ref: '#/components/schemas/LocationSetZipCodeSet' description: 'LocationSet represents target areas to allow or block. If multiple fields are set, a union of them is used.' messagesUpdateCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesUpdateCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string PolicyFunctionConfigMcmItemRecommendationConfig: type: object properties: mcm_platform_id: type: string title: Platform identifier for MCM Item Recommendation. (e.g. MOLOCO_PORTAL_DEMO) inventory_id: type: string title: Inventory identifier for MCM Item Recommendation. (e.g. home_recommendation) CustomerSetCustomerSetStatusDetail: type: object properties: connection_method: $ref: '#/components/schemas/CustomerSetStatusDetailConnectionMethod' error_id: $ref: '#/components/schemas/CustomerSetStatusDetailErrorId' error_description: type: string description: Error description is a detailed description of the error. csv_file_size: type: integer format: int32 title: CSV file size is the size of the CSV file in bytes. (Deprecated) aud_size: type: integer format: int32 description: Audience size is the size of the audience in bytes. adclouddspAdCapper: type: object properties: imp_interval: $ref: '#/components/schemas/commonTimeDuration' description: 'Cooling time interval between impressions to a user. If not specified, the API set the default value of 1 hour.' description: AdCapper represents capping settings for an AdGroup. CampaignGoalOptimizeLandingForWebUa: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeLandingForWebUaMode' description: Optimization mode. rate: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' CampaignGoalOptimizeAppInstalls: type: object properties: mode: $ref: '#/components/schemas/CampaignGoalOptimizeAppInstallsMode' description: Optimization mode. target_cpi: $ref: '#/components/schemas/adcloudcommonMoney' description: Target cost per install in AdAccount-wide currency. Required when the mode is TARGET_CPI_CENTRIC. rate: type: number format: double description: '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: type: number format: double description: '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].' dspCreativeImageSrc: type: object properties: image_url: type: string description: URL of the image. filename: type: string description: Original filename of the image. width: type: integer format: int64 description: Width of the Creative. readOnly: true height: type: integer format: int64 description: Height of the Creative. readOnly: true size_in_bytes: type: integer format: int64 description: Size of the image in bytes. description: "Source of image Creative.\n\nSupported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).\n\nBanner dimensions:\n - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100\n - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60\n - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50\n - 970x250, 994x250, 1029x258\n\nFull screen dimensions:\n - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640\n - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736\n - 428x846, 480x320, 640x360\n\nMedium dimensions:\n - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500\n\nTablet dimensions:\n - 728x90, 768x1024, 1024x90, 1024x768, 1280x90" AudienceTargetingConditionRecentCampaignActivityFilter: type: object properties: event: $ref: '#/components/schemas/adcloudcommonEventType' description: Event type for the Campaign activities to filter on. campaign_id: type: string description: ID of the Campaign to filter on. last_n_days: type: integer format: int32 description: Target only new users with earliest known activities falling into the window of last N days. description: Recent Campaign activities for the targeted user. required: - event - campaign_id - last_n_days dspReadCreativeGroupOverview: type: object properties: creative_group: $ref: '#/components/schemas/dspCreativeGroup' description: The retrieved CreativeGroup. state: $ref: '#/components/schemas/commonEnablingState' description: 'State of the CreativeGroup. Enabled state means that the CreativeGroup is used for bidding.' inactive_reasons: type: array items: $ref: '#/components/schemas/dspCreativeGroupInactiveReason' description: "Inactive reasons of CreativeGroup if the CreativeGroup is not used for bidding.\n\n - NO_CREATIVE: It implies that the CreativeGroup has no Creative.\n - NO_ADGROUP: It implies that the CreativeGroup is not linked to any AdGroup.\n - SCHEDULED: It implies that the CreativeGroup is scheduled to run at a future day/time.\n - NO_ENABLED_CREATIVE: It implies that the CreativeGroup has no enabled Creative. If a CreativeGroup has NO_CREATIVE as inactive reasons, NO_ENABLED_CREATIVE won't be included.\n - NO_ENABLED_ADGROUP: It implies that the CreativeGroup is not linked to any enabled AdGroup. If a CreativeGroup has NO_ADGROUP as inactive reasons, NO_ENABLED_ADGROUP won't be included.\n - NO_ENABLED_CAMPAIGN: It implies that the CreativeGroup is not linked to any enabled Campaign. If a CreativeGroup has NO_ADGROUP as inactive reasons, which implies it doesn't belongs to any campaign too, so NO_ENABLED_CAMPAIGN won't be included.\n - DISABLED_CREATIVE_GROUP: It implies that the CreativeGroup's enabling state is set as DISABLED.\n - ENDED: It implies that the CreativeGroup has passed its schedule end date." creative_group_referrer_infos: type: array items: type: object $ref: '#/components/schemas/dspCreativeGroupReferrerInfo' description: CreativeGroupReferrerInfo is data of the CreativeGroup's relational entities which use the CreativeGroup. description: 'ReadCreativeGroupOverview is an overview information of CreativeGroup entity. Retrieved when the inquiry_option = INQUIRY_OVERVIEW.' TargetFuturePreferenceInfoProductScope: type: string enum: - UNKNOWN - ALL - ANDROID - IOS default: UNKNOWN description: ProductScope indicates the scope of Product of which the target prefers. dspAudienceTargetingConditionVideoType: type: string enum: - UNKNOWN_VIDEO_TYPE - REWARD_VIDEO - NON_REWARD_VIDEO - NON_VIDEO default: UNKNOWN_VIDEO_TYPE description: This value is not part of the specification. commonAdvertiserIdType: type: string enum: - UNKNOWN_ADVERTISER_ID_TYPE - ANDROID_IDFA - IOS_IDFA - GENERIC_USER_ID - GENERIC_DEVICE_ID - ANDROID_LAT_IDFA - IOS_LAT_IDFA default: UNKNOWN_ADVERTISER_ID_TYPE description: "Enumeration of supported ID types for advertises.\n\nThis value is not part of the specification.\n\n - ANDROID_IDFA: IDFA used in Android.\n - IOS_IDFA: IDFA used in iOS.\n - GENERIC_USER_ID: This is used when IDFA is unavailable and an alternative user id is available.\nFor example, Google's adid is used for mobile web inventories.\n - GENERIC_DEVICE_ID: This is used when IDFA is unavailable and an alternative device id is available.\nFor example, Mopub sends out device id in some apps.\n - ANDROID_LAT_IDFA: infra-generating IDFA used for Android LAT devices\n - IOS_LAT_IDFA: infra-generating IDFA used for iOS LAT devices" PolicyPolicyFunction: type: string enum: - UNKNOWN_POLICY - RANDOM_SELECTION - MOST_RECENT_VIEW - IN_CART - GLOBAL_TREND - TREND - COMBINED_EVENTS_RECENCY - FREQUENTLY_BOUGHT_TOGETHER - FREQUENTLY_SEEN_TOGETHER - KEYWORD_SEARCH_WITH_CLIENT_RESULT - COMBINED_EVENTS_RECENCY_WITH_KEYWORD_SEARCH - MODEL - GAME - RMP_AUDIENCE_EXTENSION - MCM_ITEM_RECOMMENDATION - NEXT_ITEM_SELECTION default: UNKNOWN_POLICY description: "PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game.\n\n - IN_CART: GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test.\n - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE}\n - GAME: GAME policy is used to select Creative elements of game.\n - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience Extension.\n - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation.\n - NEXT_ITEM_SELECTION: Policy for NEXT Item Selection." CampaignGoalOptimizeAppRoasMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - MARGIN_CENTRIC - TARGET_PRIMARY_KPI_CENTRIC default: UNKNOWN_MODE ProductSuspensionActionType: type: string enum: - UNKNOWN_TYPE - SUSPEND_UNTIL - SUSPEND_INDEFINITELY - STOP_SUSPENSION default: UNKNOWN_TYPE description: "The type which the current action achieves.\n\n - SUSPEND_UNTIL: The current action is for product suspension until someday.\n - SUSPEND_INDEFINITELY: The current action is for product suspension indefinitely.\n - STOP_SUSPENSION: The current action is to stop product suspension." CampaignGoalOptimizeCpaForAppRe: type: object properties: action: type: string description: 'In-app action events the AdAccount wants to optimize. Remarkable notes: - Case-sensitive as specified in the post-back from MMP.' reengagement_action: type: string description: 'Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppReMode' description: Optimization mode. rate: type: number format: double description: '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].' description: Detailed configuration of OPTIMIZE_CPA_FOR_APP_RE goal. required: - action commonBannerApi: type: string enum: - UNKNOWN_BANNER_API - MRAID_2 default: UNKNOWN_BANNER_API title: Banner API MmpIntegrationConversionValueConfigurationItem: type: object properties: effective_date: type: string description: The start date of the CV configuration in the form of YYYY-MM-DD. scheme: $ref: '#/components/schemas/ConversionValueConfigurationItemConversionValueScheme' description: 'Scheme of CV configuration. There are two types of scheme single event scheme and multiple events scheme.' cv_single: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForSingleEvent' cv_multi: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForMultipleEvents' cv_custom: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForCustomEvents' cv_skan_v4: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForSkanV4Events' auto_refresh: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationAutoRefresh' description: Settings for SKAdNetwork conversion value configuration auto-refresh. description: 'Conversion value configuration. Show the valid item among the history in the storage entity. (Most recent item of which the effective date is not later than current date.) Use case in MCP: https://help.moloco.com/hc/en-us/articles/1500012981641-SKAdNetwork-Conversion-Value-Configuration- .' dspCustomerSetIdType: type: string enum: - UNKNOWN_ID_TYPE - GOOGLE_ADID - APPLE_IDFA default: UNKNOWN_ID_TYPE description: " - UNKNOWN_ID_TYPE: Unknown user ID type.\n - GOOGLE_ADID: Google Android advertising ID type.\n - APPLE_IDFA: Apple iOS advertising ID type." commonAdExchange: type: string enum: - UNKNOWN_AD_EXCHANGE - MOPUB - ADX - ADMIXER - SMAATO - RUBICON - EXELBID - BRIGHTROLL - CAULYRTB - ADLIB - ORION - MOLOCO - ADOP - APPLOVIN - FYBER - SAMSUNG - ADCOLONY - POLYMORPH - CHARTBOOST - MANPLUS - KAKAO - UNITY - FYBERCORE - ADGENERATION - SAMSUNGPAY - NHN - ADPOPCORN - OPENX - VUNGLE - ADALPHA - BYTEDANCE - NAVER - INMOBI - SIGNALPLAY - ACUITY - IRONSOURCE - PUBMATIC - BAIDU - FLUCT - FIVE - APPODEAL - ADPIE - MOBILITYWARE - TPMN - PUBNATIVE - TAPJOY - MOMENTO - BIDENCE - APS - INDEX - IQZONE - STARTIO - FLOWER - ONESTORE - NIMBUS - AEQUUS - MCTV - MINTEGRAL - MOLOCO_SDK_APPLOVIN - MOLOCO_SDK_IRONSOURCE - PANGLE - MAGNITE - MOLOCO_SDK_X3MADS - FREE_WHEEL - MOLOCO_SDK_ADMOB - ADX_RTB - XIAOMI - MOLOCO_SDK_CREATIVE_TEST - MOLOCO_SDK_MAX - MOLOCO_SDK_LEVELPLAY - NEXXEN - MOLOCO_SDK_ADMOB_MEDIATION - MOLOCO_SDK - MOLOCO_SDK_IN_HOUSE_MEDIATION - TABOOLA - CRITEO - MOLOCO_SDK_DIRECT_AD - APX1 - DIRECT_AD - BIGO - CAS - TUBI default: UNKNOWN_AD_EXCHANGE description: "Enumeration of ad exchanges supported by Moloco Ads.\n\n - SIGNALPLAY: MANPLUS == SIGNALPLAY. just added for distinguishing video and banner report\n - MOLOCO_SDK: Used for a consolidated MOLOCO SDK exchange.\n - APX1: APX1 is LINE's anonymized exchange name (renamed from LINE - no production traffic, direct replacement)" PolicyItemCapperFrequency: type: object properties: period: type: string description: 'The period is represented in a format {INTEGER}[smhdw]. For example, "1m" indicates 1 minute. When this field is empty, the system default cooling time is used.' max_exposures: type: integer format: int32 description: The max number of exposures of a CatalogItem within a period of time. description: "Frequency represents frequency capping. One can specify\n\"at most 3 exposures per 1 hour\" by setting:\n {\n \"period\": \"1h\",\n \"max_exposures\": 3\n }\nThis means, when a user sees a CatalogItem 3 times, he/she won't\nsee the same CatalogItem again for 1 hour." CvConfigurationForCustomEventsEventList: type: object properties: events: type: array items: type: object $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForCustomEventsEventInfo' description: events hold multiple EventInfo. dspCustomerSet: type: object properties: id: type: string description: Unique identifier of the CustomerSet. Automatically set by server on creation. title: type: string description: A descriptive name of the CustomerSet. description: type: string description: An optional description of the CustomerSet. id_type: $ref: '#/components/schemas/dspCustomerSetIdType' description: Type of user identifiers of this CustomerSet. status: $ref: '#/components/schemas/dspCustomerSetStatus' data_file_path: type: string description: "Data source path of users.\nex) gcs path for txt file of specific-type user lists (query result for postback, or journal...).\n\nAPPLE_IDFA user list txt file example: (one idfa per line).\n ______________________________________\n8a05cce7-da5c-4980-8cef-2603ae1742b6\nffffffff-ffff-4fff-8fff-ffffffffffff" is_upper: type: boolean description: A flag indicating that identifiers are upper-cased. False if they are lower-cased. auto_delete_at: type: string format: date-time description: 'CustomerSet used nowhere for specific time will be removed automatically. It represents when this will be deleted in UTC.' readOnly: true created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. recent_file_update_info: $ref: '#/components/schemas/CustomerSetFileUpdateInfo' description: Most recent update info. readOnly: true status_detail: $ref: '#/components/schemas/CustomerSetCustomerSetStatusDetail' file_update_histories: type: array items: type: object $ref: '#/components/schemas/CustomerSetFileUpdateHistory' title: 'Maximum # of histories: 10' readOnly: true description: 'CustomerSet represents a group of user identifiers can be used in Moloco Ads. (e.g. Targeting, Audience Lift model generation and so on).' required: - title - id_type - data_file_path CvConfigurationAutoRefreshAutoRefreshResult: type: string enum: - UNKNOWN - OK - ERROR default: UNKNOWN TrackingLinkUrlDataVerificationStatus: type: string enum: - UNKNOWN_VERIFICATION_STATUS - UNVERIFIED - VERIFYING - VERIFIED default: UNKNOWN_VERIFICATION_STATUS description: "Enumeration of various TrackingLink verification status.\n\nThis value is not part of the specification.\n\n - UNVERIFIED: The TrackingLink is not yet verified.\n - VERIFYING: The TrackingLink is being verified.\n - VERIFIED: The TrackingLink has been verified." dspCreativeNativeSrc: type: object properties: icon_image: $ref: '#/components/schemas/dspCreativeImageSrc' description: 'App icon image for the native Creative. Width and height must be equal. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).' main_image: $ref: '#/components/schemas/dspCreativeImageSrc' description: 'Main image for the native Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). For native image ads, the following dimensions are supported: - 720x720, 720x960, 720x1280 - 1200x222, 1200x600, 1200x628, 1200x844, 1200x1600 For native video ads, the following dimensions are supported: - 360x480, 360x640, 480x360, 480x480, 640x360 - 720x720, 720x960, 720x1280, 800x418, 1200x628, 1280x720' shrunk_main_image: $ref: '#/components/schemas/dspCreativeImageSrc' description: 'Thumbnail image displayed alongside the native video Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).' title: type: string description: Title of the native ad. text: type: string description: Text message to show. cta_text: type: string description: Call to action text (e.g. "Get a quote"). sponsored_by: type: string description: Brand name of the sponsor/advertiser. star_rating: type: number format: float description: Star rating value of the app. Value should be in the range of [0, 5]. video: $ref: '#/components/schemas/dspCreativeVideoSrc' description: 'Video asset for native video ads. Only one of the video and vast_video fields may be specified, not both.' vast_video: $ref: '#/components/schemas/dspCreativeVastVideoSrc' description: 'Vast video for native video ads. Only one of the video and vast_video fields may be specified, not both.' description: Source of native Creative. required: - icon_image - main_image - title - text - cta_text UrlDataUnverifiedStatusData: type: object properties: stored_at: type: string format: date-time description: Creation time of this link. user_id: type: string description: The ID of the user who created this link. description: 'UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration.' CreativeHtmlRequirementAttributesCustomCloseType: type: string enum: - UNKNOWN_CUSTOM_CLOSE_TYPE - CUSTOM_CLOSE_TYPE_NONE - CUSTOM_CLOSE_TYPE_ENABLED - CUSTOM_CLOSE_TYPE_CONTROLLABLE default: UNKNOWN_CUSTOM_CLOSE_TYPE description: "The Creative uses useCustomClose() functionally in MRAID. It may not be specified.\n\nIt is NOT SPECIFIED.\n\n - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose().\n - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose().\n - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange." adcloudcommonCurrency: type: string enum: - UNKNOWN_CURRENCY - USD - KRW - JPY - EUR - GBP default: UNKNOWN_CURRENCY description: "Enumeration of currencies supported by Moloco Ads.\n\nThis value is not part of the specification.\n\n - USD: US Dollar.\n - KRW: Korean Won.\n - JPY: Japanese Yen.\n - EUR: EU Euro.\n - GBP: British Pound." UrlDataVerifyingStatusData: type: object properties: attempt_ids: type: array items: type: string description: Each of ID refers to a TrackingLinkVerificationAttempt. description: 'VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state indefinitely until receiving a postback.' CampaignGoalOptimizeRoasForAppRe: type: object properties: target_roas: type: number format: double description: 'Target return on advertising spend (ROAS) in percent. For example, a value 312.5 denotes 312.5% ROAS.' reengagement_action: type: string description: 'Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action.' revenue_actions: type: array items: type: string description: '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: type: number format: double description: 'The ratio of the daily budget for the autopilot to spend. The rate should be in (0, 2].' description: Detailed configuration of OPTIMIZE_ROAS_FOR_APP_RE goal. required: - revenue_actions CampaignGoalOptimizeCpaRepeatedForAppUa: type: object properties: action: type: string description: 'In-app action events the AdAccount wants to optimize. Remarkable notes: - Case-sensitive as specified in the post-back from MMP.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpaRepeatedForAppUaMode' description: Optimization mode. rate: type: number format: double description: '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].' description: Detailed configuration of OPTIMIZE_CPA_REPEATED_FOR_APP_UA goal. required: - action CampaignGoalOptimizeAppRetentionMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - MARGIN_CENTRIC default: UNKNOWN_MODE PolicyEvaluatorType: type: string enum: - UNKNOWN_EVALUATOR - EVALUATOR_TEST_CATALOG_DEPENDENT - EVALUATOR_TEST_CATALOG_INDEPENDENT - EVALUATOR_RANDOM - EVALUATOR_LR default: UNKNOWN_EVALUATOR description: EvaluatorType defines the type of evaluator for the model. PolicyFunctionConfigTrendConfig: type: object properties: name: type: string description: TREND PolicyFunction's config. adcloudcommonMoney: type: object properties: currency: $ref: '#/components/schemas/adcloudcommonCurrency' amount_micros: type: string format: int64 description: '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.' AppPropertiesAppEventType: type: string enum: - UNKNOWN - IN_APP_ADVERTISING - IN_APP_PURCHASE - SIGN_UP - SUBSCRIPTION - PREDICTED_LIFETIME_VALUE - ACHIEVE_LEVEL - START_TRIAL - ADD_PAYMENT_INFO - VIEW_PRODUCT_OR_CONTENT - ADD_TO_WISHLIST - SEARCH - ADD_TO_CART - BEGIN_CHECKOUT - FIRST_DEPOSIT - FIRST_TRADE - OTHER default: UNKNOWN description: AppEventType indicates standardized event types representing each in-app event. adcloudcommonDayOfWeek: type: string enum: - UNKNOWN_DAY_OF_WEEK - MON - TUE - WED - THU - FRI - SAT - SUN default: UNKNOWN_DAY_OF_WEEK description: 'Enumeration for week days. This value is not part of the specification.' adcloudcommonTrackingCompany: type: string enum: - 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 default: UNKNOWN_TRACKING_COMPANY description: "Enumeration for tracking companies supported by Moloco Ads.\n\n - WEB: Unnamed trackers\n - AIRBRIDGE: Moloco's e2e tracker (test purpose only)\n - KOCHAVA_FOR_PUBLISHER: Kochava's CTV to web event dedicated tracking company." SKAdNetworkInputCustomOption: type: string enum: - UNKNOWN_SKAN_CUSTOM_OPTION - SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE - SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE - SKAN_CUSTOM_OPTION_NON_ATTRIBUTABLE - SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE default: UNKNOWN_SKAN_CUSTOM_OPTION description: "CustomOption enumerates all the available traffic.\nWhile the targeting_state other than 'TARGET_CUSTOM' is a pre-defined set of traffic,\nCustomOption enables configuring the targeted traffic in a custom way.\n\nThis value is not part of the specification.\n\n - SKAN_CUSTOM_OPTION_MMP_ATTRIBUTABLE: This option target traffic which is iOS < 14.5 and SKAdNetwork incompatible.\n - SKAN_CUSTOM_OPTION_BI_ATTRIBUTABLE: This option target traffic which is iOS < 14.5 and SKAdNetwork compatible.\n - SKAN_CUSTOM_OPTION_NON_ATTRIBUTABLE: This option target traffic which is iOS >= 14.5 and SKAdNetwork incompatible.\n - SKAN_CUSTOM_OPTION_SKAN_ATTRIBUTABLE: This option target traffic which is iOS >= 14.5 and SKAdNetwork compatible." dspAudienceTargetingCondition: type: object properties: allowed_countries: type: array items: type: string description: Allowed countries in ISO_3166-1_alpha-3 format. blocked_countries: type: array items: type: string description: Blocked countries in ISO_3166-1_alpha-3 format. placement_reasons: type: array items: $ref: '#/components/schemas/AudienceTargetingConditionPlacementReason' custom_placement_reason: type: string description: The reason of the placement in free-form text. allowed_app_bundles: type: array items: type: string description: "App bundles. A bid-request having a matching publisher app bundle from the list\nwill be accepted.\n\nExample to target com.moloco.game or com.moloco.travel apps:\n\n \"allowed_app_bundles\": [ \"com.moloco.game\", \"com.moloco.travel\" ]\n\nExample to exclude com.moloco.office app:\n\n \"blocked_app_bundles\": [ \"com.moloco.office\" ]" blocked_app_bundles: type: array items: type: string description: See the documentation for `allowed_app_bundles`. allowed_content_categories: type: array items: type: string description: "Filter for allowed publisher IAB categories.\n\nValid category values can be found in section \"5.1 Content Categories\" in the \"OpenRTB API Specification\":\n https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf\n\nFor example: \"allowed_content_categories\": [ \"IAB26-1\" ]" blocked_content_categories: type: array items: type: string description: "Filter for blocked publisher IAB categories.\n\nValid category values can be found in section \"5.1 Content Categories\" in the \"OpenRTB API Specification\":\n https://github.com/openrtb/OpenRTB/blob/master/OpenRTB-API-Specification-Version-2-3-1-FINAL.pdf\n\nFor example: \"blocked_content_categories\": [ \"IAB26-1\" ]" allowed_cities: type: array items: type: string description: "Allowed cities. A bid-request will be accepted when there is at least one\nmatch from the city list. Note that each element must be in\nthe form of \"city, region\" such as \"Seattle, WA\" in order to disambiguate\nthe same city but different regions. The entry is case-insensitive\nand whitespace will be ignored.\n\nExample to target Seattle or Newyork:\n\n \"allowed_cities\": [ \"Seattle, WA\", \"Newyork, ny\" ]" blocked_cities: type: array items: type: string description: Blocked cities. allowed_creative_types: type: array items: $ref: '#/components/schemas/adcloudcommonCreativeType' description: Allowed Creative types. blocked_creative_types: type: array items: $ref: '#/components/schemas/adcloudcommonCreativeType' description: Blocked Creative types. allowed_websites: type: array items: type: string description: 'Allowed websites. A glob pattern can be used for matching. Ignored for app inventories. For example: "allowed_websites": [ "*youtube.com" ].' blocked_websites: type: array items: type: string description: 'Blocked websites. A glob pattern can be used for matching. Ignored for app inventories. For example: "blocked_websites": [ "*example.com" ].' allowed_geofences: type: array items: type: object $ref: '#/components/schemas/commonCircle' description: Allowed geofences. blocked_geofences: type: array items: type: object $ref: '#/components/schemas/commonCircle' description: Blocked geofences. allowed_exchanges: type: array items: $ref: '#/components/schemas/commonAdExchange' description: 'Allowed ad exchanges. Restricts targeting to bid only on the listed exchanges; an empty list places no restriction. MOLOCO_SDK is automatically included whenever the list is non-empty: submitting a non-empty list that omits MOLOCO_SDK will have it appended on the server side.' blocked_exchanges: type: array items: $ref: '#/components/schemas/commonAdExchange' description: 'Blocked ad exchanges. Excludes the listed exchanges from targeting. Adding MOLOCO_SDK to this list is rejected with PERMISSION_DENIED.' allowed_idfas: type: array items: type: string description: Allowed user IDFAs. IDFA supports glob; e.g. use "*f" to match all IDFAs ending with "f". blocked_idfas: type: array items: type: string description: Blocked user IDFAs. IDFA supports glob; e.g. use "*f" to match all IDFAs ending with "f". allowed_zipcodes: type: array items: type: string description: Allowed zipcodes. blocked_zipcodes: type: array items: type: string description: Blocked zipcodes. allowed_device_models: type: array items: type: string description: "Allowed device models.\n\nFor example:\n\n \"allowed_device_models\": [ \"KFFOWI\", \"KFGIWI\", \"KFTT\", \"KFJWA\" ]" blocked_device_models: type: array items: type: string description: Blocked device models. allowed_user_audience_tags: type: array items: type: string description: Allowed user custom audience tags. blocked_user_audience_tags: type: array items: type: string description: Blocked user custom audience tags. allowed_languages: type: array items: type: string description: 'Allowed languages. Languages in use mostly follow ISO 639-1 code(https://www.loc.gov/standards/iso639-2/php/code_list.php), e.g. "ko" for Korean and "en" for English.' blocked_languages: type: array items: type: string description: Blocked languages. allowed_device_types: type: array items: $ref: '#/components/schemas/commonDeviceType' description: 'Allowed device types. For example: "allowed_device_types": [ "HIGHEND_PHONE", "TABLET" ]' blocked_device_types: type: array items: $ref: '#/components/schemas/commonDeviceType' description: 'Blocked device types. For example: "allowed_device_types": [ "SET_TOP_BOX" ]' allowed_mostly_visited_countries: type: array items: type: string description: 'This filter checks user''s history of mostly visited countries against the specified countries in the condition, and passes a request if there is at least one common entry in both lists.' blocked_mostly_visited_countries: type: array items: type: string allowed_regions: type: array items: type: string description: Regions are to filter a bid-request based on its region information. blocked_regions: type: array items: type: string allowed_recent_campaign_activities: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionRecentCampaignActivityFilter' description: "Recent Campaign activities filter a bid-request by user's recent activity such as click or install\nin the last n days. The filter is satisfied if there is at least one satisfying condition among the list.\n\nExample to target a user who has a click event for com.moloco.gameapp:\n\n \"allowed_recent_campaign_activities\": [\n {\n \"campaign_id\": \"com.moloco.gameapp\",\n \"event\": \"CLICK\"\n }\n ]\n\nExample to block a user who has a install event for com.moloco.officeapp within the past five days:\n\n \"blocked_recent_campaign_activities\": [\n {\n \"campaign_id\": \"com.moloco.officeapp\",\n \"event\": \"INSTALL\",\n \"last_n_days\": 5\n }\n ]" blocked_recent_campaign_activities: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionRecentCampaignActivityFilter' allowed_locations: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionLocationFilter' description: 'Location filter targets specific geo-locational audience using combined conditions of different types such as city, region, zipcode and geofence.' blocked_locations: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionLocationFilter' genders: type: array items: $ref: '#/components/schemas/commonGender' connection_types: type: array items: type: string description: 'Connection_types include ETHERNET, WIFI, CELL_UNKNOWN, CELL_2G, CELL_3G, CELL_4G. For example: "connection_types": [ "WIFI", "CELL_4G" ]' allowed_direct_deal_ids: type: array items: type: string description: "IDs of the allowed direct deals. A bid-request is accepted only if there is at least one matching id.\n\nFor example:\n\n \"allowed_direct_deal_ids\": [\n \"ip_9161499632014fe8b9ef60673a51b745\",\n \"ip_e13c0cb23dd54a8ea742b2af61e0712d\",\n \"ip_0cfeaebb190d47df8b86399232853e23\"\n ]" blocked_direct_deal_ids: type: array items: type: string description: IDs of the blocked direct deals. device_oses: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionDeviceOsFilter' description: Device OS requirements if specified. media_channel_type: $ref: '#/components/schemas/AudienceTargetingConditionMediaChannelType' description: Media channel types. new_users: $ref: '#/components/schemas/AudienceTargetingConditionNewUserFilter' description: "Filter to target only new users.\n\nExample to accept a bid-request for new users with earliest known activities within the last 5 days:\n\n \"new_users\": {\n \"last_n_days\": 5\n }" advertiser_id_types: type: array items: $ref: '#/components/schemas/commonAdvertiserIdType' description: Filter on advising ID types, including "ANDROID_IDFA" or "IOS_IDFA". allowed_video_types: type: array items: $ref: '#/components/schemas/dspAudienceTargetingConditionVideoType' description: Video type filter. Ignored when the bid request is not for video ads. blocked_video_types: type: array items: $ref: '#/components/schemas/dspAudienceTargetingConditionVideoType' weekly_schedules: type: array items: type: object $ref: '#/components/schemas/AudienceTargetingConditionWeeklyScheduleFilter' description: "Weekly schedule specifies more fine-grained time range filtering for days of a week. For example,\nthis list can be used to specify commute time ranges in the morning and evening on workdays.\n\nExample to target 7-9 am and 5-7 pm during week days:\n\n \"weekly_schedules\": [\n {\n \"hour_range\": {\n \"start\": 7,\n \"end\": 9\n },\n \"days\": [ \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" ]\n },\n {\n \"hour_range\": {\n \"start\": 17,\n \"end\": 19\n },\n \"days\": [ \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" ]\n }\n ]\n\nExample to target 10pm to 2am on Fridays and Saturdays:\n\n \"weekly_schedules\": [\n {\n \"range\": {\n \"start\": 22,\n \"end\": 2\n },\n \"days\": [ \"FRI\", \"SAT\" ]\n }\n ]" allowed_gender_score: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' description: 'Gender score filter uses approximated gender score probability distribution in the range of [0, 1], with 0 indicating a strong probability of male, and 1 indicating a strong probability of female. The filter is specified with a range of [start, end] to filter on user''s gender score.' blocked_gender_score: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' allowed_ages: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' description: 'Age is used to filter based on user''s approximate age. A valid value must be in the exclusive range of (0, 100).' blocked_ages: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' allowed_ip_ranges: type: array items: type: string description: "IP net based condition. The CIDR format must be used for an entry such as\nhttps://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing.\nNote that both of IP v4 and v6 could be used at the same time.\n\nExample to block bid-requests with any IP within 32.76.52.0 - 32.76.52.255 or 127.0.0.0 - 127.255.255.255:\n\n \"blocked_ip_ranges\": [\n \"32.76.52.0/24\",\n \"127.0.0.0/8\"\n ]" blocked_ip_ranges: type: array items: type: string allowed_device_carriers: type: array items: type: string description: "Device carrier filter.\n\nExample to target SKT:\n\n \"allowed_device_carriers\": [ \"SKTelecom\" ]\n\n\nExample to exclude T-MOBILE and XFINITY Mobile\n\n \"blocked_device_carriers\": [ \"T-MOBILE\", \"XFINITY Mobile\" ]" blocked_device_carriers: type: array items: type: string allowed_keywords: type: array items: type: string description: 'Filter regarding ''keywords'' field in a bid request. If specified, an ad request must have at least one of the allowed keywords to satisfy the filter.' blocked_keywords: type: array items: type: string description: 'Filter regarding ''keywords'' field in a bid request. An ad request must not have any of the blocked keywords to satisfy the filter.' user_buckets: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' description: Filter for the user buckets. allowed_ad_units: type: array items: type: string description: '// Target timetree_i_prod or timetree_a_prod ad_units "condition": { "allowed_ad_units": [ "timetree_i_prod", "timetree_a_prod" ] } // Exclude timetree_i_test ad_unit "condition": { "blocked_ad_units": [ "timetree_i_test" ] }' title: 'Example:' blocked_ad_units: type: array items: type: string allowed_placements: type: array items: type: string description: placement (a group of ad_units) names. It is untied to ad_units, and follow the ad_unit's filtering rule. blocked_placements: type: array items: type: string allowed_banner_apis: type: array items: $ref: '#/components/schemas/commonBannerApi' description: '// Target MRAID_2 banner only "condition": { "allowed_banner_apis": [ "MRAID_2" ] }' title: 'Example:' blocked_banner_apis: type: array items: $ref: '#/components/schemas/commonBannerApi' schedule: $ref: '#/components/schemas/commonTimeInterval' description: "Schedule to allow bid-requests in a absolute time range, where start and end\nare in RFC3339 format. A few example from https://tools.ietf.org/html/rfc3999\nis listed below.\n\n 1985-04-12T23:20:50.52Z\n\n This represents 20 minutes and 50.52 seconds after the 23rd hour of\n April 12th, 1985 in UTC.\n\n\n 1996-12-19T16:39:57-08:00\n\n This represents 39 minutes and 57 seconds after the 16th hour of\n December 19th, 1996 with an offset of -08:00 from UTC (Pacific\n Standard Time). Note that this is equivalent to 1996-12-20T00:39:57Z\n in UTC.\n\n Example:\n\n // Christmas through end of the year\n \"condition\": {\n \"schedule\": {\n \"start\": \"2020-12-24T00:00:00Z\",\n \"end\": \"2020-12-31T23:59:59Z\"\n }\n }" audience_data: $ref: '#/components/schemas/commonAudienceData' description: "Audience data.\n\n Example:\n \"condition\": {\n \"audience_data\": {\n \"provider\": \"moloco\",\n \"condition\": \"name == \\\"John\"\\ AND age > 30\"\n }\n }" allowed_apps_by_checksum: type: array items: type: string description: Allow apps by their checksum value. blocked_apps_by_checksum: type: array items: type: string description: Block apps by their checksum value. allowed_postback_event_counts: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventCount' description: "PostbackEventCount condition checks the number of specified events and\naccepts if there is one event that falls within given range of [start,\nend). In the example, User's event named \"Transaction confirmation\"\nmust have been appeared 16 times or more to accept for zigbang app.\n\n Example:\n \"condition\": {\n \"allowed_postback_event_counts\": [\n {\n \"app_bundle\": \"com.chbreeze.jikbang4a\",\n \"range\": {\n \"start\": 16,\n \"end\": 0\n },\n \"events\": [\n \"Transaction confirmation\"\n ]\n }\n ]\n }" auction_types: type: array items: type: string description: "Auction types including first price or second price auctions.\n\n Example:\n \"condition\": {\n \"auction_types\": [ \"first\", \"second\" ]\n }" throttle_apt_tags: $ref: '#/components/schemas/commonTagsThrottleCondition' title: "Allow throttle apps with apt tags with throttle rate. In the example,\nthrottle apps with apt_tags [bad_apptag1, bad_apptag2] with 95% of throttle rate\nare allowed.\nExample:\n\"condition\":{\n \"throttle_apt_tags\": {\n \"tags\": [\"badapp_tag1\", \"badapp_tag2\"],\n \"throttle_rate\": 0.95\n }\n}" allowed_dev_makes: type: array items: type: string description: "Allowed device make.\n\n Example:\n \"condition\":{\n \"allowed_dev_makes\": [ \"Apple\" ]\n }" blocked_dev_makes: type: array items: type: string description: Blocked device make. See the example of `allowed_dev_makes`. display_manager_versions: type: array items: type: object $ref: '#/components/schemas/commonDisplayManagerVersion' description: "DisplayManager Version.\n\n Example:\n\n \"condition\": {\n \"display_manager_versions\": [\n {\n \"min\": \"1.2\",\n \"max\": \"4.5.6\"\n }\n ]\n }\n\n // With minimum version requirement:\n \"condition\": {\n \"display_manager_versions\": [\n {\n \"min\": \"3.0\"\n }\n ]\n }\n\n // With maximum version requirement:\n \"condition\": {\n \"display_manager_versions\": [\n {\n \"max\": \"5\"\n }\n ]\n }" allowed_audiences: type: array items: type: string description: Allowed audiences. blocked_audiences: type: array items: type: string description: Blocked audiences. allowed_postback_has_all_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' description: 'Postback event condition filter a bid-request by user''s postback summary. Note that audience name and events are of case-sentitive string types. Each entry of allowed_postback_has_all_events_conditions will be satisfied when all listed events are found from user''s postback summary.' blocked_postback_has_all_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' description: 'Each entry of blocked_postback_has_all_events_conditions will be satisfied when all listed events are not found from user''s postback summary.' allowed_postback_has_any_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' title: "Each entry of allowed_postback_has_any_events_conditions will be satisfied when there is at least\none matching event by the condition from user's postback summary.\nThe following example defines in-app events of \"com.moloco.gameapp\" for a user bound to the\nbid-request. The condition must have both of \"adview\" and \"purchase\" events within the\npast 14 days but no \"Open\" or \"Close\" events in the last 7 days.\nExample:\n \"condition\": {\n \"allowed_postback_has_all_events_conditions\": [\n {\n \"audiences\": [ \"com.moloco.gameapp\" ],\n \"events\": [ \"adview\", \"purchase\" ],\n \"past_time_range\": {\n \"start\": 14\n }\n }\n ],\n \"blocked_postback_has_any_events_conditions\": [\n {\n \"audiences\": [ \"com.moloco.gameapp\" ],\n \"events\": [ \"Open\", \"Close\" ],\n \"past_time_range\": {\n \"start\": 7\n }\n }\n ]\n }" blocked_postback_has_any_events_conditions: type: array items: type: object $ref: '#/components/schemas/commonPostbackEventsCondition' description: 'Each entry of blocked_postback_has_any_events_conditions will be satisfied when there is at least one event not matched by the condition from user''s postback summary. See the documentation for `allowed_postback_has_any_events_conditions`.' allowed_location_set: $ref: '#/components/schemas/AudienceTargetingConditionLocationSet' description: 'Allowed and blocked location sets. If these fields are set, allowed_location_codes and blocked_location_codes are ignored.' blocked_location_set: $ref: '#/components/schemas/AudienceTargetingConditionLocationSet' allowed_apt_tags: type: array items: type: string blocked_apt_tags: type: array items: type: string coppa_acceptance: $ref: '#/components/schemas/AudienceTargetingConditionCoppaAcceptance' description: Whether to bid according to BidRequest.regs.coppa value. skan_traffic: $ref: '#/components/schemas/AudienceTargetingConditionSkanTraffic' description: 'Whether to bid according to bid requests that support SKAN or not. Decide based on bidreq.ext.sk_ad_network_request_ext field exists.' contains_custom_audience: type: boolean description: 'Whether it contains a `custom_audience` targeting condition. The `custom_audience` targeting condition is legacy, and may contain some internal information. Therefore, we do not reveal them by the API but only signals its non-emptiness with this field.' custom_audience_set: $ref: '#/components/schemas/AudienceTargetingConditionCustomAudienceSet' description: 'CustomAudienceSet is a combination of app events and user lists filters. The app events filter checks if the targeted user conforms to given app events. The CustomerSet filter checks if an entry in the list can be found from tags in a user profile. There is an assumption that a CustomerSet entity exists for each and every entry in the list.' description: 'AudienceTargetingCondition specifies conditions for AudienceTargeting. This condition object contains various filters on multiple dimensions of bid-request, app, and user. Advertisers can selectively configure desired filters to form a meaningful AudienceTarget condition collectively. The configured individual filters must be satisfied unanimously in order for the resulting collective condition to be satisfied. Only filters with values will be effective. When a filter condition accepts a list of values, i.e., list of countries for "allowed_countries", the filter condition will be met when any match is found among the list. String literals are case insensitive unless specified otherwise; i.e. "USA" and "usa" equally represents the United States of America.' commonPostbackEventsCondition: type: object properties: audiences: type: array items: type: string description: Audience name. i.e. app bundle. events: type: array items: type: string description: List of events such as install and purchase. past_time_range: $ref: '#/components/schemas/adcloudcommonInterval' description: Past time range for a postback event. past_time_range_unit: $ref: '#/components/schemas/commonTimeUnit' description: 'The unit for past_time_range. In PostbackEventsCondition, only DAY and MINUTE are used.' range: $ref: '#/components/schemas/commonTimeInterval' description: Range for a postback event. short_term_user_profile: type: boolean description: If set, short-term user profile information is used to evaluate this condition. count_range: $ref: '#/components/schemas/adcloudcommonInterval' description: Accepted range of event count. description: Postback Events Condition. dspMmpIntegrationStatus: type: string enum: - UNKNOWN_STATUS - UNDER_REVIEW - DENIED - ACTIVE default: UNKNOWN_STATUS LaunchNoticeNoticeMessage: type: string enum: - 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 default: UNKNOWN_MESSAGE description: "- UNKNOWN_MESSAGE: Default fallback for unrecognized message types.\n - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED: MMP Probabilistic Attribution (PA) is disabled. User should enable PA from MMP side.\n - MMP_VIEW_THROUGH_PROBABILISTIC_ATTRIBUTION_STATUS_DISABLED: View-Through Probabilistic Attribution (VT PA) is disabled in MMP settings.\n - MMP_ADVANCED_PRIVACY_STATUS_ENABLED: Appsflyer Advanced Privacy is currently enabled.\n - MMP_PROBABILISTIC_ATTRIBUTION_STATUS_UNKNOWN: The current status of Probabilistic Attribution cannot be determined.\n - CAMPAIGN_WILL_PAUSE_IF_ADVANCED_PRIVACY_ENABLED_AFTER_48H: The campaign is scheduled to pause in 48 hours if Advanced Privacy remains enabled." title: NoticeMessage indicates the message user should confirm adclouddspAudience: type: object properties: shared_audience_target_ids: type: array items: type: string description: A list of IDs for the named AudienceTargets referenced by this audience specification. targeting_condition: $ref: '#/components/schemas/dspAudienceTargetingCondition' description: Ad-hoc AudienceTargeting condition constructed for this audience specification only. description: 'Audience is a final form of AudienceTargeting specification. It is represented by a list of IDs of SharedAudienceTargets and an ad-hoc target condition. All conditions in the audience specification must be met to accept a bid-request. IDs of the SharedAudienceTargets can be either at global or AdAccount level.' adcloudcommonTimezonePolicy: type: string enum: - UNKNOWN_TIME - DEVICE_TIME - UTC_TIME - AD_ACCOUNT_TIME - ADVERTISER_TIME default: UNKNOWN_TIME description: "TimezonePolicy defines the time configuration.\n\n - DEVICE_TIME: Time object is given in the device's time (depends on user device timezone).\n - UTC_TIME: Time object is given in the fixed UTC time (depends on nothing).\n - AD_ACCOUNT_TIME: Given time is given in fixed ad account time (depends on ad account timezone)." CreativeVideoSrcTranscodingInfoStatus: type: string enum: - UNKNOWN_STATUS - IN_PROGRESS - SUCCEEDED - FAILED default: UNKNOWN_STATUS description: " - IN_PROGRESS: The transcoding is in progress.\n - SUCCEEDED: The transcoding has succeeded.\n - FAILED: The transcoding has failed.\nDetailed reason can be found from failed_reason." dspWeeklyFlexibleBudgetSchedule: type: object properties: weekly_budget: $ref: '#/components/schemas/adcloudcommonMoney' description: Weekly budget in Campaign's currency. commonTimeUnit: type: string enum: - UNKNOWN_TIME_UNIT - MINUTE - HOUR - DAY - WEEK default: UNKNOWN_TIME_UNIT description: 'A unit of time, e.g. second, minute, etc. This value is not part of the specification.' dspMmpIntegration: type: object properties: id: type: string description: The unique identifier of the MmpIntegration. mmp_bundle_id: type: string description: Exact key which is used in MMP. mmp: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: MMP (e.g., Appsflyer, MAT, and so on). ownership: type: boolean description: Whether the Product's AdAccount has ownership for the MmpIntegration. readOnly: true status: $ref: '#/components/schemas/dspMmpIntegrationStatus' description: Current status of this IntegrationID. denied_reason: type: string description: Review denied reason if its status is DENIED. cv_config_item: $ref: '#/components/schemas/MmpIntegrationConversionValueConfigurationItem' description: Conversion value configuration setting. mmp_context: $ref: '#/components/schemas/MmpIntegrationMmpContext' description: Stores MMP-specific contextual data. updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. allow_fingerprinting: type: boolean description: Whether the app owner has allowed the MMP's fingerprinting for attributions. fingerprinting_last_auto_refreshed_at: type: string format: date-time description: Timestamp for last update of "allow_fingerprinting". readOnly: true description: MmpIntegration represents the MMP integration information. CampaignGoalOptimizeCpcForAppRe: type: object properties: target_cpc: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per click in AdAccount-wide currency. Required when the mode is TARGET_CPC_CENTRIC.' reengagement_action: type: string description: 'Re-engagement action to measure re-engaging a user. This action is also used as a cohort base action.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeCpcForAppReMode' description: Optimization mode. rate: type: number format: double description: '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.' description: Detailed configuration of OPTIMIZE_CPC_FOR_APP_RE goal. commonAudienceData: type: object properties: provider: type: string title: Data provider's unique name condition: type: string title: 'SQL like condition statement for filtering powered by qlbridge library. Ref. https://github.com/araddon/qlbridge' description: Audience Data. It is a filter based on AudienceData stored in UPT. messagesReadCampaignErrorAPIErrorInfo: type: object properties: reason: $ref: '#/components/schemas/messagesReadCampaignErrorAPIErrorInfoErrorReason' error_log_id: type: string context: type: object additionalProperties: type: string AudienceTargetingConditionNewUserFilter: type: object properties: last_n_days: type: integer format: int32 description: Target only new users with earliest known activities falling into the window of last N days. description: Filter to target new users only. required: - last_n_days CustomerSetFileUpdateInfo: type: object properties: status: $ref: '#/components/schemas/FileUpdateInfoUpdateStatus' description: Update status. timestamp: type: string format: date-time description: Update timestamp. file_name: type: string description: Updated file name. dspDailyBudgetSchedule: type: object properties: daily_budget: $ref: '#/components/schemas/adcloudcommonMoney' description: Daily budget in Campaign's currency. Daily spending resets at 12am UTC every day. messagesDeleteCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN default: ERROR_REASON_UNKNOWN ConversionValueConfigurationItemCvConfigurationForSingleEventEventInfo: type: object properties: event_name: type: string revenue_interval: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' description: 'Revenue value cannot be negative. Range min value cannot be larger than the range max value.' CampaignGoalOptimizeClicksToWeb: type: object properties: target_cpc: $ref: '#/components/schemas/adcloudcommonMoney' description: 'Target cost per click in AdAccount-wide currency. Required when the mode is TARGET_CPC_CENTRIC.' mode: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToWebMode' description: Optimization mode. rate: type: number format: double description: '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].' description: Detailed configuration of OPTIMIZE_CPC_FOR_WEB_VISIT goal. CustomerSetFileUpdateHistory: type: object properties: status: $ref: '#/components/schemas/dspCustomerSetStatus' status_detail: $ref: '#/components/schemas/CustomerSetCustomerSetStatusDetail' updated_at: type: string format: date-time description: Updated at is the timestamp when the status is changed. dspCreativeTemplateHtmlSrc: type: object properties: template_id: type: string description: ID of the template used to render this Creative. template_env: type: object additionalProperties: type: string description: Environment used to render this Creative. rendered_entry_html: type: string description: The entry HTML of the rendered Creative. html_requirement_attributes: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributes' description: 'Requirements of this Creative. Based on this field and inventory''s excludable Creative attributes, Moloco can filter out this Creative at serving time.' html_size_attributes: $ref: '#/components/schemas/dspCreativeHtmlSizeAttributes' description: Size-related attributes of this Creative. max_video_duration_seconds: type: integer format: int64 description: Max duration of video sources. Will be 0 if no video source is found in this Creative. description: (Will be supported soon) Creative source based on MRAID template. required: - template_id - rendered_entry_html TargetFuturePreferenceInfoCustomProducts: type: object properties: product_ids: type: array items: type: string description: CustomProducts stores Products' ids of which the target prefers. CampaignGoalOptimizeAppReattributionMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE ConversionValueConfigurationItemCvConfigurationForCustomEvents: type: object properties: cv_events: type: object additionalProperties: $ref: '#/components/schemas/CvConfigurationForCustomEventsEventList' description: 'Information on relationships between conversion value and events for custom event scheme. The key of this map is the registered conversion value between 1 to 63. The value of this map is the list of events for each conversion value.' CreativeRichCustomHtmlSrcPlayableADSourceData: type: object properties: type: $ref: '#/components/schemas/CreativeRichCustomHtmlSrcPlayableADSourceType' description: Type of the source. value: type: string description: 'When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file. When type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string.' dspCreativeGroupInactiveReason: type: string enum: - UNKNOWN_REASON - NO_CREATIVE - NO_ADGROUP - SCHEDULED - EXTERNAL_ISSUE - NO_ENABLED_CREATIVE - NO_ENABLED_ADGROUP - NO_ENABLED_CAMPAIGN - DISABLED_CREATIVE_GROUP - ENDED default: UNKNOWN_REASON description: "InActiveReason indicates why the CreativeGroup is not used for bidding.\n\nThis value is not part of the specification.\n\n - NO_CREATIVE: NO_CREATIVE implies that the CreativeGroup has no Creative.\n - NO_ADGROUP: NO_ADGROUP implies that the CreativeGroup is not linked to any AdGroup.\n - SCHEDULED: SCHEDULED implies that the CreativeGroup is scheduled to run at a future day/time.\n - EXTERNAL_ISSUE: EXTERNAL_ISSUE is deprecated.\n - NO_ENABLED_CREATIVE: NO_ENABLED_CREATIVE implies that the CreativeGroup has no enabled Creative.\nIf a CreativeGroup has NO_CREATIVE as inactive reasons, NO_ENABLED_CREATIVE won't be included.\n - NO_ENABLED_ADGROUP: NO_ENABLED_ADGROUP implies that the CreativeGroup is not linked to any enabled AdGroup.\nIf a CreativeGroup has NO_ADGROUP as inactive reasons, NO_ENABLED_ADGROUP won't be included.\n - NO_ENABLED_CAMPAIGN: NO_ENABLED_CAMPAIGN implies that the CreativeGroup is not linked to any enabled Campaign.\nIf a CreativeGroup has NO_ADGROUP as inactive reasons, which implies it doesn't belongs to any campaign too, so NO_ENABLED_CAMPAIGN won't be included.\n - DISABLED_CREATIVE_GROUP: DISABLED_CREATIVE_GROUP implies that the CreativeGroup's enabling state is set as DISABLED.\n - ENDED: ENDED implies that the CreativeGroup has passed its schedule end date." FileUpdateInfoUpdateStatus: type: string enum: - UNKNOWN_STATUS - IN_PROGRESS - SUCCESS - FAILED default: UNKNOWN_STATUS description: " - IN_PROGRESS: Update is in progress.\n - SUCCESS: Update succeed.\n - FAILED: Update failed. Please check the contents format." protobufAny: type: object properties: '@type': type: string additionalProperties: {} ConversionValueConfigurationItemCvConfigurationAutoRefresh: type: object properties: enable_auto_refresh: type: boolean description: 'Enables automatically importing the latest SKAdNetwork CV configuration from the integrated MMP and updating CV config items.' refresh_result: $ref: '#/components/schemas/CvConfigurationAutoRefreshAutoRefreshResult' description: Result status of auto refresh. readOnly: true refresh_error_message: type: string description: Auto refresh error message in case the refresh request failed. readOnly: true last_auto_refreshed_at: type: string format: date-time description: Timestamp when the last auto SKAdNetwork CV configuration refresh occurred. readOnly: true description: Settings for automatically importing and updating SKAdNetwork conversion value configuration from MMP. dspCreative: type: object properties: id: type: string description: Unique identifier of the Creative. Automatically set by server on creation. ad_account_id: type: string description: ID of the AdAccount the Creative belongs to. readOnly: true product_id: type: string description: ID of the Product the Creative belongs to. readOnly: true title: type: string description: A descriptive name of the Creative. enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this Creative is enabled by the AdAccount. If the value of this field is unset or set to UNSPECIFIED in the Creative creation request, it will be set to ENABLED by default by the server. A disabled Creative will still get reviewed, but won''t be served automatically after approval. An active serving Creative can be paused at any time by setting this field to DISABLED.' advertiser_info: $ref: '#/components/schemas/dspAdvertiserInfo' description: Basic information about the Creative's AdAccount. readOnly: true type: $ref: '#/components/schemas/dspCreativeType' description: Type of the Creative. original_filename: type: string description: Original Creative filename given by user. size_in_bytes: type: integer format: int64 description: Estimated size of the Creative in bytes. custom_key_values: type: object additionalProperties: type: string description: '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.' image: $ref: '#/components/schemas/dspCreativeImageSrc' video: $ref: '#/components/schemas/dspCreativeVideoSrc' vast_video: $ref: '#/components/schemas/dspCreativeVastVideoSrc' native: $ref: '#/components/schemas/dspCreativeNativeSrc' custom_html: $ref: '#/components/schemas/dspCreativeCustomHtmlSrc' template_html: $ref: '#/components/schemas/dspCreativeTemplateHtmlSrc' rich_custom_html: $ref: '#/components/schemas/dspCreativeRichCustomHtmlSrc' dynamic_html: $ref: '#/components/schemas/dspCreativeDynamicHtmlSrc' feature_type: $ref: '#/components/schemas/adcloudcommonCreativeFeatureType' description: CreativeFeatureType. creator_tag: type: string description: Creator tag to identify who is the resource creator. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: 'Creative contains all data and assets required to visually render an ad. One and only one of the sources must be specified for the Creative.' required: - title - original_filename ConversionValueConfigurationItemCvConfigurationForSingleEvent: type: object properties: cv_revenue_events: type: object additionalProperties: $ref: '#/components/schemas/ConversionValueConfigurationItemCvConfigurationForSingleEventEventInfo' description: 'Information on relationships between conversion value and (event name & revenue interval) for single event scheme. The key of this map is the registered conversion value between 1 to 63. The value of this map is a EventInfo message. EventInfo without revenue value should be unique. For the same event name, conversion value should be consecutive. Range min value cannot be smaller than previous range''s max value. At least 4 Purchase Value should be registered for each event.' CreativeVideoSrcTranscodingInfo: type: object properties: status: $ref: '#/components/schemas/CreativeVideoSrcTranscodingInfoStatus' description: Status of the transcoding. failed_reason: type: string description: Error message for the FAILED status. CampaignGoalOptimizeCpcForAppReMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC - TARGET_CPC_CENTRIC default: UNKNOWN_MODE CustomerSetStatusDetailConnectionMethod: type: string enum: - UNKNOWN_METHOD - CLOUD_API - MCP_UPLOAD - AF_AUDIENCE_BUILDER - BESPOKE default: UNKNOWN_METHOD description: "Connection method is an indicator of how the customer set file is updated.\n\n - CLOUD_API: Update via cloud API\n - MCP_UPLOAD: MCP Upload\n - AF_AUDIENCE_BUILDER: AF Audience Builder\n - BESPOKE: Bespoke" dspCreativeHtmlSizeAttributes: type: object properties: interstitial: type: boolean description: Passes as long as the inventory is for an interstitial ad. fixed: type: array items: type: object $ref: '#/components/schemas/CreativeHtmlSizeAttributesFixed' description: 'Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required.' description: 'Size-related attributes for a resizable Creative, such as an HTML-based one. This message acts as a filter condition; if an inventory is matched with the condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out.' dspTrackingLink: type: object properties: id: type: string description: Unique identifier of the TrackingLink. Automatically set by server on creation. ad_account_id: type: string description: The ID of the AdAccount the TrackingLink belongs to. readOnly: true product_id: type: string description: The ID of the Product the TrackingLink belongs to. readOnly: true title: type: string description: A descriptive name of the TrackingLink. description: type: string description: An optional description about the TrackingLink. device_os: $ref: '#/components/schemas/commonDeviceOs' description: Device OS for which this TrackingLink should be served. click_through_link: $ref: '#/components/schemas/TrackingLinkUrlData' description: Click-through landing page URL. This URL is usually provided by the tracking company. view_through_link: $ref: '#/components/schemas/TrackingLinkUrlData' description: View-through impression tracking URL. This URL is usually provided by the tracking company. ctv_adjust_dual_vt_link: $ref: '#/components/schemas/TrackingLinkUrlData' title: This is used only for DSP CTV with adjust supporting dual link solution in s2s manner tracking_company: $ref: '#/components/schemas/adcloudcommonTrackingCompany' description: Tracking company (e.g., Appsflyer, MAT, and so on). created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. description: TrackingLink represents an AdAccount's configuration for. required: - device_os - click_through_link - title dspCreativeVideoSrc: type: object properties: video_url: type: string description: URL of the video media. Currently we support only mp4 format. filename: type: string description: Original filename of the video. width: type: integer format: int64 description: Width of the Creative. height: type: integer format: int64 description: Height of the Creative. length_seconds: type: integer format: int64 description: Video length in seconds. fps: type: integer format: int64 description: Number of frames per second for the video. size_in_bytes: type: integer format: int64 description: Size of the video in bytes. Note it doesn't include the bytes for the companion images. companion_images: type: array items: type: object $ref: '#/components/schemas/dspCreativeImageSrc' description: 'Endcard image shown after video play ends. The orientation must match the video orientation. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).' auto_endcard: type: boolean description: Whether the endcard is generated automatically by MCP or manually uploaded by the user. playable_endcard: $ref: '#/components/schemas/dspCreativeRichCustomHtmlSrc' description: 'HTML-based playable endcard that is shown after video play is ended. Either a playable or an image (via `companion_images`) or a dynamic html (via `dynamic_html_endcard`) must be used.' dynamic_html_endcard: $ref: '#/components/schemas/dspCreativeDynamicHtmlSrc' description: 'HTML-based dynamic html endcard that is shown after video play is ended. Either a dynamic html or an image (via `companion_images`) or a playable (via `playable_endcard`) must be used.' transcoding_info: $ref: '#/components/schemas/CreativeVideoSrcTranscodingInfo' description: Transcoding information of the video. readOnly: true description: 'Source of video Creative. Supported format: MP4. Maximum file size: 300MB (before transcoding). At least one of width or height must be ≥ 640px. Duration: 6–180 seconds.' required: - video_url - width - height - length_seconds dspSKAdNetworkInput: type: object properties: targeting_state: $ref: '#/components/schemas/SKAdNetworkInputTargetingState' description: Targeting state w.r.t SKAdNetwork traffic. include_traffic_without_attributions: type: boolean description: '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: type: array items: $ref: '#/components/schemas/SKAdNetworkInputCustomOption' description: '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: type: boolean description: '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.' title: 'prefer_mmp_attribution indicates whether the Campaign prefers MMP attribution when both MMP and SKAdNetwork attributions are available. It is valid only in the following cases:' description: '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.' AudienceTargetingConditionWeeklyScheduleFilter: type: object properties: timezone_policy: $ref: '#/components/schemas/adcloudcommonTimezonePolicy' description: Timezone Policy to apply. hour_range: $ref: '#/components/schemas/adcloudcommonInterval' description: 'Hour range for each day specified below. It''s required and both start and end values must be in the range of [0, 23].' days: type: array items: $ref: '#/components/schemas/adcloudcommonDayOfWeek' description: Days of week to filter on. At least one is required. description: WeeklyScheduleFilter specifies a time range on certain days of a week. required: - days messagesUpdateCampaignErrorAPIErrorInfoErrorReason: type: string enum: - ERROR_REASON_UNKNOWN - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED - CAMPAIGN_TYPE_LANDING_URL_REQUIRED - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES - CAMPAIGN_NO_VALID_TRACKING_COMPANY - CAMPAIGN_SKAN_INVALID_GOAL_ACTION - CAMPAIGN_NO_REVENUE_FOR_EVENT - CAMPAIGN_ALREADY_ARCHIVED - CAMPAIGN_CANNOT_ENABLE_WITH_DISABLED_PAYOUT_ITEM - CAMPAIGN_NO_ENABLED_CREATIVE_GROUP - CAMPAIGN_CANNOT_ENABLE_FOR_NON_PAYABLE_ADVERTISER - CAMPAIGN_BUDGET_REQUIRED - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES default: ERROR_REASON_UNKNOWN description: " - CAMPAIGN_SKAN_MUST_BE_UNSET_FOR_NON_IOS_CAMPAIGN: Cannot specify skadn_input for non IOS campaign.\n - CAMPAIGN_SKAN_MUST_BE_SET_FOR_IOS_CAMPAIGN: Must specify skadn_input for IOS campaign.\n - CAMPAIGN_SKAN_CUSTOM_OPTIONS_REQUIRED: custom_options must be set for skadn_input.\n - CAMPAIGN_TYPE_TRACKING_LINK_REQUIRED: tracking_link_id is required for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_NOT_ALLOWED: landing_url is not allowed for APP installs or re-engagement type campaign.\n - CAMPAIGN_TYPE_LANDING_URL_REQUIRED: landing_url is required for WEB type campaign.\n - CAMPAIGN_TYPE_TRACKING_LINK_NOT_ALLOWED: campaign.tracking_link_id is not allowed for WEB type campaign.\n - CAMPAIGN_TYPE_CANNOT_CREATE_FOR_NON_APP_PRODUCT: Specified campaign type cannot have non APP type product.\n - CAMPAIGN_TYPE_REQUIRES_APP_PROPERTIES: Specified campaign type should have APP properties under the Product.\n - CAMPAIGN_NO_VALID_TRACKING_COMPANY: Creating campaign has invalid tracking company information.\nInput tracking link id should be set or target Product should have postback integration.\n - CAMPAIGN_SKAN_INVALID_GOAL_ACTION: The specified goal action is not valid event for SKAdNetwork.\n - CAMPAIGN_NO_REVENUE_FOR_EVENT: The specified goal action does not have revenue range.\n - CAMPAIGN_ALREADY_ARCHIVED: The target campaign is already archived.\n - CAMPAIGN_CANNOT_ENABLE_WITH_DISABLED_PAYOUT_ITEM: Cannot enable the campaign with disabled PayoutItem.\n - CAMPAIGN_NO_ENABLED_CREATIVE_GROUP: Cannot enable the campaign with no enabled CreativeGroup with Creatives.\n - CAMPAIGN_CANNOT_ENABLE_FOR_NON_PAYABLE_ADVERTISER: Cannot enable a campaign whose advertiser is not ready for billing.\n - CAMPAIGN_BUDGET_REQUIRED: Campaign budget is required.\n - CAMPAIGN_ZERO_BUDGET_AE_CAMPAIGN_NOT_DISABLED: Campaign should be disabled if budget_ratio_percent of audience extension is 0% or 100%.\n - CAMPAIGN_TARGET_DUPLICATED_AD_PLATFORM: Campaign has duplicated targeting ad platform.\n - CAMPAIGN_AD_PLATFORMS_SHOULD_BE_SUPERSET_OF_AD_GROUPS: Campaign's targeting ad platforms should be superset of AdGroups'.\n - CAMPAIGN_TYPE_CANNOT_TARGET_MULTIPLE_OSES: Given campaign type cannot target multiple OSes." PolicySourcerType: type: string enum: - UNKNOWN_SOURCER - SOURCER_TEST_CATALOG_DEPENDENT - SOURCER_TEST_CATALOG_INDEPENDENT - SOURCER_DEFAULT - SOURCER_USER_SIGNAL - SOURCER_TRENDS - SOURCER_RELATED_ITEMS - SOURCER_AUCTION_ITEMS default: UNKNOWN_SOURCER description: SourcerType defines the type of sourcer for the model. CreativeHtmlRequirementAttributesAutoPlayAudioType: type: string enum: - UNKNOWN_AUTO_PLAY_AUDIO_TYPE - AUTO_PLAY_AUDIO_TYPE_MUTED - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE default: UNKNOWN_AUTO_PLAY_AUDIO_TYPE description: "The Creative plays audio automatically; i.e., it starts muted. It may not be specified.\n\nIt is NOT SPECIFIED.\n\n - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically.\n - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically.\n - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange." CreativeRichCustomHtmlSrcPlayableADSourceType: type: string enum: - UNKNOWN_PLAYABLE_AD_SOURCE_TYPE - PLAYABLE_AD_SOURCE_TYPE_URL - PLAYABLE_AD_SOURCE_TYPE_TAG default: UNKNOWN_PLAYABLE_AD_SOURCE_TYPE description: " - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style).\n - PLAYABLE_AD_SOURCE_TYPE_TAG: Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus)." CampaignGoalOptimizeCpaForAppReMode: type: string enum: - UNKNOWN_MODE - BUDGET_CENTRIC default: UNKNOWN_MODE CampaignGoalOptimizeFixedCpmPacingPacingMode: type: string enum: - NONE - BY_FREQUENCY default: NONE description: Force pacing option. ConversionValueConfigurationItemCvConfigurationForMultipleEvents: type: object properties: cv_events: type: object additionalProperties: type: string description: 'Information on relationships between conversion value and event name for multiple events scheme. The key of this map is the registered conversion value between 0 to 5. The value of this map is the event name.' ConversionValueConfigurationItemConversionValueScheme: type: string enum: - UNKNOWN_CONVERSION_VALUE_SCHEME - CONVERSION_VALUE_SCHEME_SINGLE_EVENT - CONVERSION_VALUE_SCHEME_MULTIPLE_EVENTS - CONVERSION_VALUE_SCHEME_CUSTOM_EVENTS - CONVERSION_VALUE_SCHEME_SKAN_V4_EVENTS default: UNKNOWN_CONVERSION_VALUE_SCHEME PolicyFunctionConfigNextItemSelectionConfig: type: object description: 'NEXT_ITEM_SELECTION PolicyFunction''s config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level.' LaunchNoticeNoticeType: type: string enum: - UNKNOWN - WARNING - DISCLAIMER default: UNKNOWN description: "NoticeType defines the severity or category of the notice.\n\n - WARNING: Warning: Informational message that does not block the launch but requires attention.\n - DISCLAIMER: Disclaimer: Explicit agreement or acknowledgement is required from the user." messagesReadCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesReadCampaignErrorAPIErrorInfo' AudienceTargetingConditionCustomAudienceSet: type: object properties: include_having_all: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: 'This will include a customer only if all of the listed conditions are satisfied. Note that it is not allowed to set include_having_all and include_having_any at the same time.' include_having_any: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: This will include a customer if at least one condition from the listed conditions is satisfied. exclude_having_all: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: 'This will exclude a customer only if all of the listed conditions are satisfied. Note that it is not allowed to set exclude_having_all and exclude_having_any at the same time.' exclude_having_any: $ref: '#/components/schemas/CustomAudienceSetCustomAudienceCondition' description: This will exclude a customer if at least one condition from the listed conditions is satisfied. description: 'CustomAudienceSet represents a group of target users to whom we''re going to show an ad. CustomAudienceSet is consist of a dynamic (not pre-determined) set of target users based on App-events described in the postback messages and pre-defined CustomerSets.' commonTimeDuration: type: object properties: amount: type: string format: int64 unit: $ref: '#/components/schemas/commonTimeUnit' description: Represents a time duration with an amount and a unit. dspCreativeHtmlRequirementAttributes: type: object properties: flags: type: array items: $ref: '#/components/schemas/dspCreativeHtmlRequirementAttributesFlag' description: Flags for describing features that the enclosing Creative requires. use_custom_close: $ref: '#/components/schemas/CreativeHtmlRequirementAttributesCustomCloseType' auto_play_audio: $ref: '#/components/schemas/CreativeHtmlRequirementAttributesAutoPlayAudioType' description: 'Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served.' AdAccountTargetFuturePreferenceInfo: type: object properties: product_scope: $ref: '#/components/schemas/TargetFuturePreferenceInfoProductScope' custom_products: $ref: '#/components/schemas/TargetFuturePreferenceInfoCustomProducts' description: 'TargetFuturePreferenceInfo contains each target''s future preference information. If the newly created Campaign satisfies the condition of target future preference info the target will be automatically assigned to that Campaign.' CampaignServingStatus: type: object properties: serving_blocked: type: boolean description: serving_blocked is true when this campaign is blocked in the serving side for some reason. serving_blocked_timestamp: type: string format: date-time description: The timestamp of the latest serving block. description: ServingStatus stores current serving status of the campaign, such as whether it is blocked and when it is blocked. LocationSetZipCodeSet: type: object properties: zipcodes: type: array items: type: string description: Zipcodes to represent areas to target. country: type: string description: Uppercase Country code in ISO 3166-1 alpha-2. commonDisplayManagerVersion: type: object properties: min: type: string max: type: string description: Display Manager Version. commonDeviceOs: type: string enum: - UNKNOWN_DEVICE_OS - ANDROID - IOS - VERSATILE - MOBILE_WEB - MACOS - WINDOWS - NEXT_VERSATILE default: UNKNOWN_DEVICE_OS description: "Enumeration of device OS types supported by Moloco Ads.\n\nThis value is not part of the specification.\n\n - ANDROID: Android device OS.\n - IOS: iOS device OS.\n - VERSATILE: Product with multiple OSes.\nSpecifically for CTV.\n - MOBILE_WEB: OS for mobile web traffic.\n - MACOS: OS for MacOS traffic.\n - WINDOWS: OS for Windows traffic.\n - NEXT_VERSATILE: OS for Next web product." CreativeGroupActionType: type: string enum: - UNKNOWN_TYPE - CREATE - UPDATE - START_REVIEW - DISAPPROVE - APPROVE - REQUEST_REVIEW default: UNKNOWN_TYPE description: "Enumeration of all supported CreativeGroup action types.\n\n - UNKNOWN_TYPE: This value is not part of the specification.\n - CREATE: The user created the CreativeGroup.\nThe status of a new Creative will be set to SUBMITTED upon creation.\n - UPDATE: The user updated the CreativeGroup.\nThe status of the CreativeGroup may be set to SUBMITTED for some significant updates.\n - START_REVIEW: The reviewer user started the review of the CreativeGroup.\nThe status of the CreativeGroup will be set to UNDER_REVIEW.\n - DISAPPROVE: The reviewer user reviewed and disapproved the CreativeGroup.\nThe status of the CreativeGroup will be set to DISAPPROVED.\n - APPROVE: The reviewer user reviewed and approved the CreativeGroup.\nThe status of the CreativeGroup will be set to APPROVED.\n - REQUEST_REVIEW: Request the CreativeGroup to be reviewed. The CreativeGroup could previously be\nin UNDER_REVIEW, APPROVED or DISAPPROVED state." CustomAudienceSetApp: type: object properties: product_id: type: string description: The ID of the Product. sliding_window_duration: $ref: '#/components/schemas/commonTimeDuration' description: The duration of time for which this condition is effective before now. description: 'App matches a user based on app engagement within a time window. Use AppEvent when targeting a specific event by name.' dspAdGroup: type: object properties: id: type: string description: Unique identifier of the AdGroup. Automatically set by server on creation. title: type: string description: A descriptive name of the AdGroup. campaign_id: type: string description: ID of the Campaign the AdGroup belongs to. readOnly: true product_id: type: string description: ID of the Product the AdGroup belongs to. readOnly: true ad_account_id: type: string description: ID of the AdAccount the AdGroup belongs to. readOnly: true experiment_id: type: string description: ID of the Experiment the AdGroup is involved in. readOnly: true enabling_state: $ref: '#/components/schemas/commonEnablingState' description: 'Whether this AdGroup is enabled. If the value of this field is unset or set to UNSPECIFIED in the AdGroup creation request, it will be set to ENABLED by default by the server. An active AdGroup can be paused any time by setting this field to DISABLED.' audience: $ref: '#/components/schemas/adclouddspAudience' description: If specified, audience describes AdGroup-level targeting conditions. capper: $ref: '#/components/schemas/adclouddspAdCapper' description: AdGroup wide capper. pricing_model_id: type: string description: PricingModel id. readOnly: true creative_group_ids: type: array items: type: string description: 'CreativeGroup IDs. These CreativeGroups'' Product IDs must match the Product ID of the current Campaign. A Campaign eligible for serving must have at least one enabled CreativeGroup with enabled Creatives.' user_buckets: type: array items: type: object $ref: '#/components/schemas/adcloudcommonInterval' description: User buckets for traffic control. audience_extension: $ref: '#/components/schemas/dspAdGroupAudienceExtension' description: AudienceExtension settings for AdGroup. created_at: type: string format: date-time description: Created time. readOnly: true updated_at: type: string format: date-time description: Last updated time. Should not modify on the client side. aud_size: type: string format: int64 description: Original audience size information. readOnly: true matchable_aud_size: type: string format: int64 description: Matchable audience size information. readOnly: true last_aud_size_computed_at: type: string format: date-time description: Last updated time of the audience size information. readOnly: true description: AdGroup represents the seed information for a full AdGroup used by bidders. required: - title AudienceTargetingConditionLocationFilter: type: object properties: cities: type: array items: type: string regions: type: array items: type: string zipcodes: type: array items: type: string geofences: type: array items: type: object $ref: '#/components/schemas/commonCircle' description: 'LocationFilter represents a geolocationcal condition using different related conditions. The condition will be met if any of the listed conditions is met.' CreativeVideoSrcTargetAdPosition: type: string enum: - DEFAULT - FIRST_AD_ONLY - LAST_AD_ONLY default: DEFAULT description: Target ad position for the video source. messagesQueryCampaignOverviewsResponse: type: object properties: ad_account: $ref: '#/components/schemas/dspAdAccount' description: AdAccount data of the queried Campaigns. product: $ref: '#/components/schemas/dspProduct' description: Product data of the queried Campaigns. campaigns: type: array items: type: object $ref: '#/components/schemas/dspCampaign' description: List of Campaign and it's following AdGroups. ad_groups: type: array items: type: object $ref: '#/components/schemas/dspAdGroup' description: AdGroups of the Campaign. customer_sets: type: array items: type: object $ref: '#/components/schemas/dspCustomerSet' description: List of all the CustomerSet for queried Campaigns. customer_activities: type: array items: type: object $ref: '#/components/schemas/dspCustomerActivity' description: List of all the CustomerActivity for queried Campaigns. tracking_links: type: array items: type: object $ref: '#/components/schemas/dspTrackingLink' description: List of all the TrackingLink for queried Campaigns. creative_groups: type: array items: type: object $ref: '#/components/schemas/dspReadCreativeGroupOverview' description: List of all the CreativeGroup for queried Campaigns. creatives: type: array items: type: object $ref: '#/components/schemas/dspCreative' description: List of all the Creative for queried Campaigns. audience_targets: type: array items: type: object $ref: '#/components/schemas/dspSharedAudienceTarget' description: List of all the SharedAudienceTarget for queried Campaigns. dspBudgetSchedule: type: object properties: daily_schedule: $ref: '#/components/schemas/dspDailyBudgetSchedule' description: Budget for every day. weekly_schedule: $ref: '#/components/schemas/dspDayOfWeekBudgetSchedule' description: Budget for each day-of-week. weekly_flexible_schedule: $ref: '#/components/schemas/dspWeeklyFlexibleBudgetSchedule' description: Budget for a week. description: 'BudgetSchedule represents the AdAccount''s plan for budget spending. Any change in this object takes effect immediately.' ProductSuspensionAction: type: object properties: user_name: type: string description: Name who judges the product to be suspended. readOnly: true user_email: type: string description: Email who judges the product to be suspended. readOnly: true reason: type: string description: The reason for the product suspension. kind: $ref: '#/components/schemas/ProductSuspensionActionKind' readOnly: true type: $ref: '#/components/schemas/ProductSuspensionActionType' effective_from: type: string format: date-time description: The time from the app suspension will have been effective. effective_until: type: string format: date-time description: 'The time until the app suspension will have been effective. If the value of Type is set to STOP_SUSPENSION, SUSPEND_INDEFINITELY, there is no need to enter a value and the system automatically enters a value for you.' created_at: type: string format: date-time description: The time when the current suspension action is created. readOnly: true description: 'Product suspension action to block campaign activation under the product. The value can be updated only on Moloco''s end.' dspDayOfWeekBudgetSchedule: type: object properties: monday_budget: $ref: '#/components/schemas/adcloudcommonMoney' tuesday_budget: $ref: '#/components/schemas/adcloudcommonMoney' wednesday_budget: $ref: '#/components/schemas/adcloudcommonMoney' thursday_budget: $ref: '#/components/schemas/adcloudcommonMoney' friday_budget: $ref: '#/components/schemas/adcloudcommonMoney' saturday_budget: $ref: '#/components/schemas/adcloudcommonMoney' sunday_budget: $ref: '#/components/schemas/adcloudcommonMoney' description: Budget for each day of the week; all 7-day budgets need be filled for use. commonDeviceType: type: string enum: - UNKNOWN_DEVICE_TYPE - MOBILE - PERSONAL_COMPUTER - CONNECTED_TV - HIGHEND_PHONE - TABLET - CONNECTED_DEVICE - SET_TOP_BOX default: UNKNOWN_DEVICE_TYPE description: 'Enumeration of device types supported by Moloco Ads. This value is not part of the specification.' ConversionValueConfigurationItemCvConfigurationForCustomEventsEventInfo: type: object properties: event_name: type: string description: In-app event. event_value: type: string description: 'String set by the developer containing data to be decoded by the AdAccount in their systems. Typically this is in the format of a JSON.' revenue_interval: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' description: Optional. Revenue range for the event. predict_revenue_interval: $ref: '#/components/schemas/adcloudcommonFloatingPointRange' title: 'Optional. Revenue range for customer''s predicted future spending. Reference: https://mlc.atlassian.net/browse/MMP-166' event_counter: type: integer format: int32 description: 'Number of times the event is duplicated on decoding. Typically it represents the number of times the user performed a given action. Minimum value 1.' hours_from_install: type: integer format: int32 description: 'Hours elapsed since the install. Minimum value: 1. The value for all rows of a given conversion_value must be identical. Meaning different values for different conversion values is permitted.' title: 'EventInfo holds data for decoding conversion value to events. Reference: https://support.appsflyer.com/hc/en-us/articles/360014696297-Custom-conversion-value-decode-for-SKAdNetwork#decode-csv-file-specification' required: - event_name - event_counter - hours_from_install messagesCampaignInput: type: object properties: campaign: $ref: '#/components/schemas/dspCampaign' description: The Campaign to create. ad_group: $ref: '#/components/schemas/dspAdGroup' description: Deprecated. Use AdGroups instead. readOnly: true ad_groups: type: array items: type: object $ref: '#/components/schemas/dspAdGroup' description: The initial AdGroups of the creating Campaign. required: - campaign PolicyItemCapper: type: object properties: frequency: $ref: '#/components/schemas/PolicyItemCapperFrequency' description: "Item-specific capper configurations.\nThe configuration in this message is enforced:\n - across AdAccounts,\n - across Campaigns,\n - across AdGroups,\n - across CreativeGroups, and\n - across Creatives." ProductSuspensionActionKind: type: string enum: - UNKNOWN_KIND - CREATE - UPDATE default: UNKNOWN_KIND description: "The kind to represent whether the current action is newly created, or is for updating the previous action.\n\n - CREATE: This suspension action is independently created.\n - UPDATE: This suspension action is for updating the previous suspension action." AppPropertiesAppScreenshots: type: object properties: urls: type: array items: type: string dspCampaignType: type: string enum: - 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 default: UNKNOWN_CAMPAIGN_TYPE description: "CampaignType represents the type of a Campaign.\nIt captures the goal of the Campaign at a high level.\n\nThis value is not part of the specification.\n\n - GENERIC: Campaign is for generic purpose (only for legacy Campaigns).\n - APP_USER_ACQUISITION: The goal of the Campaign is to drive app user acquisitions.\n - APP_REENGAGEMENT: The goal of the Campaign is to drive app reengagement.\n - WEBSITE_VISIT: The goal of the Campaign is to drive website visits.\n - CTV_GENERIC: Campaign is for the general CTV ad.\n - CTV_APP_USER_ACQUISITION: Campaign is for the mobile app install CTV ad.\n - WEB_USER_ACQUISITION: The goal of the Campaign is to drive web user acquisitions.\nOriginally, this was used for APP to WEB user acquisition. However,\nit is now also used for WEB to WEB user acquisition.\n - CTV_WEBSITE_VISIT: Campaign is for the website visit CTV ad.\n - WEB_RETARGETING: The goal of the Campaign is to drive web retargeting.\nCurrently, this is used for WEB to WEB retargeting." ProductDynamicCreativeProperty: type: object properties: permission: type: boolean description: Permission to use dynamic CreativeGroups. description: Dynamic Creative specific properties. UrlDataVerifiedStatusData: type: object properties: verified_attempt: $ref: '#/components/schemas/dspTrackingLinkVerificationAttempt' description: The attempt that has verified the link. description: VerifiedStatusData represents the information of the completed verification. messagesUpdateCampaignError: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/components/schemas/messagesUpdateCampaignErrorAPIErrorInfo' dspPostbackIntegrationStatus: type: object properties: device_os: $ref: '#/components/schemas/commonDeviceOs' description: The device OS of the postback integration. country: type: string description: '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: type: number format: double description: Integration completion percentage per each country. integration_success: type: boolean description: The flag that specifies the integration is completed in any country. dspCustomerActivity: type: object properties: id: type: string description: 'The server generated random unique identifier of the CustomerActivity. (Required/Immutable).' title: type: string description: 'The human readable short name. (Required/Mutable).' description: type: string description: 'The description about the CustomerActivity. (Optional/Mutable).' include_having_all: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will include a customer only if all of the listed activity conditions are satisfied. include_having_any: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will include a customer if at least one condition from the listed activity conditions is satisfied. exclude_having_all: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will exclude a customer only if all of the listed activity conditions are satisfied.. exclude_having_any: type: array items: type: object $ref: '#/components/schemas/CustomerActivityActivityCondition' description: This condition will exclude a customer if at least one condition from the listed activity conditions is satisfied. created_at: type: string format: date-time updated_at: type: string format: date-time description: 'CustomerActivity represents a group of target customers to whom we''re going to show an ad. CustomerActivity determines a dynamic (not pre-determined) set of target customers based on App-events described in the postback messages. (e.g. purchase, close, open, etc.).' dspCampaignGoal_2: type: object properties: type: $ref: '#/components/schemas/dspCampaignGoalType' description: Type of the goal. optimize_app_installs: $ref: '#/components/schemas/CampaignGoalOptimizeAppInstalls' optimize_cpa_for_app_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppUa' optimize_app_roas: $ref: '#/components/schemas/CampaignGoalOptimizeAppRoas' optimize_clicks_to_web: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToWeb' optimize_clicks_to_app: $ref: '#/components/schemas/CampaignGoalOptimizeClicksToApp' optimize_roas_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeRoasForAppRe' optimize_cpc_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeCpcForAppRe' optimize_fixed_cpm: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpm_3' optimize_cpa_for_app_re: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForAppRe' optimize_app_retention: $ref: '#/components/schemas/CampaignGoalOptimizeAppRetention' optimize_app_reattribution: $ref: '#/components/schemas/CampaignGoalOptimizeAppReattribution' optimize_cpa_repeated_for_app_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaRepeatedForAppUa' optimize_fixed_cpm_pacing: $ref: '#/components/schemas/CampaignGoalOptimizeFixedCpmPacing' optimize_landing_for_web_ua: $ref: '#/components/schemas/CampaignGoalOptimizeLandingForWebUa' optimize_cpa_for_web_ua: $ref: '#/components/schemas/CampaignGoalOptimizeCpaForWebUa' kpi_actions: type: array items: type: string description: List of KPI actions. description: CampaignGoal describes the details of goal of a Campaign. required: - type CampaignGoalOptimizeFixedCpm_3: type: object properties: target_cpm: $ref: '#/components/schemas/adcloudcommonMoney' description: Target cost per click in AdAccount-wide currency. description: Detailed configuration of FIXED_CPM_* goal. required: - target_cpm securitySchemes: ApiKeyAuth: type: apiKey name: x-api-key in: header Bearer: type: apiKey description: Note that the bearer authentication has been deprecated. Please refer [API and SSO Credential Management](https://mcm-docs.moloco.com/docs/api-key-and-sso-secret-generation) section to use API-key instead. name: Authorization in: header x-refined-from: - mcm-management-api.json - moloco-ads-campaign-management-api.json - moloco-ads-campaign-management-openapi.yml - moloco-commerce-media-management-openapi.yml x-readme: explorer-enabled: true