MOLOCO Audience Target API

openapi: 3.2.0
info:
  title: Moloco Audience Target API
  version: '1.10'
  contact:
    name: Moloco Inc.
    url: https://www.moloco.com
  description: 'Operations tagged AudienceTarget across 2 of this provider''s published API definitions: moloco-ads-campaign-management-api.json, moloco-ads-campaign-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.moloco.cloud
security:
- Bearer: []
tags:
- name: AudienceTarget
paths:
  /cm/v1/audience-targets:
    get:
      summary: List up AudienceTargets.
      description: List up all AudienceTargets of the AdAccount.
      operationId: DspApi_ListAudienceTargets
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesListAudienceTargetsResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesListAudienceTargetsError'
      parameters:
      - name: ad_account_id
        description: The AdAccount ID the AudienceTargets belong to.
        in: query
        required: true
        schema:
          type: string
      tags:
      - AudienceTarget
    post:
      summary: Create a new AudienceTarget.
      description: Create a new AudienceTarget of the AdAccount.
      operationId: DspApi_CreateAudienceTarget
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesCreateAudienceTargetResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesCreateAudienceTargetError'
      parameters:
      - name: ad_account_id
        description: The AdAccount ID the AudienceTarget belongs to.
        in: query
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dspSharedAudienceTarget'
        description: The AudienceTarget data to be created.
        required: true
      tags:
      - AudienceTarget
    servers:
    - url: https://api.moloco.cloud
  /cm/v1/audience-targets/{audience_target_id}:
    get:
      summary: Read an existing AudienceTarget.
      description: Read an existing AudienceTarget.
      operationId: DspApi_ReadAudienceTarget
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadAudienceTargetResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadAudienceTargetError'
      parameters:
      - name: audience_target_id
        description: The ID of the AudienceTarget to be retrieved.
        in: path
        required: true
        schema:
          type: string
      - name: ad_account_id
        description: The AdAccount ID the AudienceTarget belongs to.
        in: query
        required: true
        schema:
          type: string
      tags:
      - AudienceTarget
    delete:
      summary: Delete an existing AudienceTarget.
      description: Delete an existing AudienceTarget.
      operationId: DspApi_DeleteAudienceTarget
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesDeleteAudienceTargetResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesDeleteAudienceTargetError'
      parameters:
      - name: audience_target_id
        description: The ID of the AudienceTarget to be deleted.
        in: path
        required: true
        schema:
          type: string
      - name: ad_account_id
        description: The AdAccount ID the AudienceTarget belongs to.
        in: query
        required: true
        schema:
          type: string
      tags:
      - AudienceTarget
    put:
      summary: Update an existing AudienceTarget.
      description: Update an existing AudienceTarget.
      operationId: DspApi_UpdateAudienceTarget
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesUpdateAudienceTargetResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesUpdateAudienceTargetError'
      parameters:
      - name: audience_target_id
        description: The ID of the AudienceTarget to be updated.
        in: path
        required: true
        schema:
          type: string
      - name: ad_account_id
        description: The AdAccount ID the AudienceTarget belongs to.
        in: query
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dspSharedAudienceTarget'
        description: The AudienceTarget data to be updated.
        required: true
      tags:
      - AudienceTarget
    servers:
    - url: https://api.moloco.cloud
components:
  schemas:
    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.
    messagesReadAudienceTargetResponse:
      type: object
      properties:
        audience_target:
          $ref: '#/components/schemas/dspSharedAudienceTarget'
          description: The retrieved AudienceTarget data.
    messagesUpdateAudienceTargetErrorAPIErrorInfoErrorReason:
      type: string
      enum:
      - ERROR_REASON_UNKNOWN
      - AUDIENCE_TARGET_NOT_FOUND
      - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE
      - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE
      - AUDIENCE_TARGET_INVALID_AGE_CONDITION
      - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE
      - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE
      - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION
      - AUDIENCE_TARGET_INVALID_KEYWORD
      - AUDIENCE_TARGET_INVALID_AUCTION_TYPE
      - AUDIENCE_TARGET_INVALID_THROTTLE_RATE
      - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE
      - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET
      - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE
      - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE
      - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET
      - AUDIENCE_TARGET_CANNOT_UPDATE_CUSTOM_TARGET_IN_USE
      - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION
      - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY
      - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT
      default: ERROR_REASON_UNKNOWN
      description: " - AUDIENCE_TARGET_NOT_FOUND: Cannot find the requested audience.\n - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE: targeting_condition has an invalid latitude value, which should be between 0 and 90.\n - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE: targeting_condition has an invalid longitude value, which should be between -180 and 180.\n - AUDIENCE_TARGET_INVALID_AGE_CONDITION: targeting_condition has an invalid age condition, it should be between 0 and 100.\n - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE: user bucket should be a number between 0 and 100.\n - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE: The absolute time range would be calculated as [now - Start, now - End).\nSo the start value should be larger than the end value, and the end value cannot be negative.\n - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION: condition value cannot be parsed.\n - AUDIENCE_TARGET_INVALID_KEYWORD: Keyword cannot be empty or have whitespace characters only.\n - AUDIENCE_TARGET_INVALID_AUCTION_TYPE: auction_type should be FIRST or SECOND.\n - AUDIENCE_TARGET_INVALID_THROTTLE_RATE: throttle_rate should be between 0.0 and 1.0.\n - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE: Cannot use whitespace for given audience target condition field.\n - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET: One of id or keywords of audience target condition field should be set.\n - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE: Audience target condition field cannot have both past time range and range at the same time.\n - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE: Audience target condition range cannot have same start and end value.\n - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET: Update for predefined audience target is not allowed.\n - AUDIENCE_TARGET_CANNOT_UPDATE_CUSTOM_TARGET_IN_USE: Cannot add or remove custom audience if the custom target is used in Campaigns or AdGroups.\n - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION: AudienceTarget condition cannot exclude all target conditions in specified field.\n - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY: targeting_condition must not have both 'all' and 'any' in the same side of custom audience set.\n - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT: The length of the target condition exceeds the limit."
    messagesListAudienceTargetsErrorAPIErrorInfo:
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/messagesListAudienceTargetsErrorAPIErrorInfoErrorReason'
        error_log_id:
          type: string
        context:
          type: object
          additionalProperties:
            type: string
    commonBannerApi:
      type: string
      enum:
      - UNKNOWN_BANNER_API
      - MRAID_2
      default: UNKNOWN_BANNER_API
      title: Banner API
    messagesReadAudienceTargetError:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/messagesReadAudienceTargetErrorAPIErrorInfo'
    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)"
    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."
    messagesDeleteAudienceTargetErrorAPIErrorInfoErrorReason:
      type: string
      enum:
      - ERROR_REASON_UNKNOWN
      - AUDIENCE_TARGET_NOT_FOUND
      - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET
      default: ERROR_REASON_UNKNOWN
      description: " - AUDIENCE_TARGET_NOT_FOUND: Cannot find the requested audience.\n - AUDIENCE_TARGET_CANNOT_UPDATE_PREDEFINED_AUDIENCE_TARGET: Update for predefined audience target is not allowed."
    adcloudcommonInterval:
      type: object
      properties:
        start:
          type: integer
          format: int32
        end:
          type: integer
          format: int32
      description: Interval represents a contiguous integer range [start, end).
    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.'
    messagesListAudienceTargetsErrorAPIErrorInfoErrorReason:
      type: string
      enum:
      - ERROR_REASON_UNKNOWN
      default: ERROR_REASON_UNKNOWN
    messagesReadAudienceTargetErrorAPIErrorInfo:
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/messagesReadAudienceTargetErrorAPIErrorInfoErrorReason'
        error_log_id:
          type: string
        context:
          type: object
          additionalProperties:
            type: string
    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
    messagesUpdateAudienceTargetResponse:
      type: object
      properties:
        audience_target:
          $ref: '#/components/schemas/dspSharedAudienceTarget'
          description: The updated AudienceTarget data.
    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
    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.'
    messagesDeleteAudienceTargetError:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/messagesDeleteAudienceTargetErrorAPIErrorInfo'
    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.
    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.
    messagesCreateAudienceTargetErrorAPIErrorInfo:
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/messagesCreateAudienceTargetErrorAPIErrorInfoErrorReason'
        error_log_id:
          type: string
        context:
          type: object
          additionalProperties:
            type: string
    messagesUpdateAudienceTargetErrorAPIErrorInfo:
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/messagesUpdateAudienceTargetErrorAPIErrorInfoErrorReason'
        error_log_id:
          type: string
        context:
          type: object
          additionalProperties:
            type: string
    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.'
    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.
    messagesCreateAudienceTargetErrorAPIErrorInfoErrorReason:
      type: string
      enum:
      - ERROR_REASON_UNKNOWN
      - AUDIENCE_TARGET_NOT_FOUND
      - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE
      - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE
      - AUDIENCE_TARGET_INVALID_AGE_CONDITION
      - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE
      - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE
      - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION
      - AUDIENCE_TARGET_INVALID_KEYWORD
      - AUDIENCE_TARGET_INVALID_AUCTION_TYPE
      - AUDIENCE_TARGET_INVALID_THROTTLE_RATE
      - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE
      - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET
      - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE
      - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE
      - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION
      - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY
      - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT
      default: ERROR_REASON_UNKNOWN
      description: " - AUDIENCE_TARGET_NOT_FOUND: Cannot find the requested audience.\n - AUDIENCE_TARGET_LATITUDE_VALUE_NOT_IN_RANGE: targeting_condition has an invalid latitude value, which should be between 0 and 90.\n - AUDIENCE_TARGET_LONGITUDE_VALUE_NOT_IN_RANGE: targeting_condition has an invalid longitude value, which should be between -180 and 180.\n - AUDIENCE_TARGET_INVALID_AGE_CONDITION: targeting_condition has an invalid age condition, it should be between 0 and 100.\n - AUDIENCE_TARGET_INVALID_USER_BUCKET_RANGE: user bucket should be a number between 0 and 100.\n - AUDIENCE_TARGET_INVALID_PAST_TIME_RANGE: The absolute time range would be calculated as [now - Start, now - End).\nSo the start value should be larger than the end value, and the end value cannot be negative.\n - AUDIENCE_TARGET_FAILED_TO_PARSE_CONDITION: condition value cannot be parsed.\n - AUDIENCE_TARGET_INVALID_KEYWORD: Keyword cannot be empty or have whitespace characters only.\n - AUDIENCE_TARGET_INVALID_AUCTION_TYPE: auction_type should be FIRST or SECOND.\n - AUDIENCE_TARGET_INVALID_THROTTLE_RATE: throttle_rate should be between 0.0 and 1.0.\n - AUDIENCE_TARGET_CANNOT_USE_WHITESPACE: Cannot use whitespace for given audience target condition field.\n - AUDIENCE_TARGET_AT_LEAST_ID_OR_KEYWORDS_MUST_BE_SET: One of id or keywords of audience target condition field should be set.\n - AUDIENCE_TARGET_CANNOT_SET_BOTH_PAST_TIME_RANGE_AND_RANGE: Audience target condition field cannot have both past time range and range at the same time.\n - AUDIENCE_TARGET_CONDITION_RANGE_CANNOT_HAVE_SAME_START_AND_END_VALUE: Audience target condition range cannot have same start and end value.\n - AUDIENCE_TARGET_CANNOT_EXCLUDE_ALL_CONDITION: AudienceTarget condition cannot exclude all target conditions in specified field.\n - AUDIENCE_TARGET_CANNOT_HAVE_BOTH_ALL_AND_ANY: targeting_condition must not have both 'all' and 'any' in the same side of custom audience set.\n - AUDIENCE_TARGET_LENGTH_EXCEED_LIMIT: The length of the target condition exceeds the limit."
    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.
    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.
    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

           

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