openapi: 3.2.0
info:
  title: Moloco Ad Manager Account API
  version: '1.0'
  contact:
    name: Moloco Inc.
    url: https://www.molocoads.com
  description: 'Operations tagged AdManagerAccount across 2 of this provider''s published API definitions: mcm-management-api.json, moloco-commerce-media-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://<platform>-mgmt.mcm-api.moloco.com
security:
- ApiKeyAuth: []
tags:
- name: AdManagerAccount
paths:
  /rmp/mgmt/v1/platforms/{platform_id}/ad-manager-accounts:
    get:
      summary: ListAdManagerAccounts
      description: List ad manager accounts
      operationId: RmpManagementApi_ListAdManagerAccounts
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicListAdManagerAccountsResponse'
        '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
      tags:
      - AdManagerAccount
    post:
      summary: CreateAdManagerAccount
      description: Create an ad manager account
      operationId: RmpManagementApi_CreateAdManagerAccount
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicCreateAdManagerAccountResponse'
        '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
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ad_manager_account:
                  $ref: '#/components/schemas/publicCreateAdManagerAccountRequestAdManagerAccountInfo'
              description: CreateAdManagerAccount request.
              title: ///////////////////////////////////////////////////////
              required:
              - ad_manager_account
              additionalProperties: true
        required: true
      tags:
      - AdManagerAccount
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-manager-accounts/{ad_manager_account_id}:
    get:
      summary: ReadAdManagerAccount
      description: Read an ad manager account
      operationId: RmpManagementApi_ReadAdManagerAccount
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicReadAdManagerAccountResponse'
        '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_manager_account_id
        description: AdManagerAccount id.
        in: path
        required: true
        schema:
          type: string
      tags:
      - AdManagerAccount
    put:
      summary: UpdateAdManagerAccount
      description: Update an ad manager account
      operationId: RmpManagementApi_UpdateAdManagerAccount
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicUpdateAdManagerAccountResponse'
        '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_manager_account_id
        description: Identifier of the AdManagerAccount. It is passed as a path parameter.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ad_manager_account:
                  $ref: '#/components/schemas/publicUpdateAdManagerAccountRequestAdManagerAccountInfo'
              description: UpdateAdManagerAccount request.
              required:
              - ad_manager_account
              additionalProperties: true
        required: true
      tags:
      - AdManagerAccount
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
components:
  schemas:
    v1AdManagerAccountManagingType:
      type: string
      enum:
      - UNKNOWN_MANAGING_TYPE
      - OWNER
      default: UNKNOWN_MANAGING_TYPE
    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
    publicUpdateAdManagerAccountRequestAdManagerAccountInfo:
      type: object
      properties:
        title:
          type: string
          description: Title of the AdManagerAccount.
        managing_ad_account_ids:
          type: array
          items:
            type: string
          description: List of ad account ids that the AdManagerAccount manages.
        updated_at:
          type: string
          format: date-time
          description: Updated timestamp of the AdManagerAccount.
      description: AdManagerAccount info.
      required:
      - title
      additionalProperties: true
    publicReadAdManagerAccountResponse:
      type: object
      properties:
        ad_manager_account:
          $ref: '#/components/schemas/v1AdManagerAccount'
      description: ReadAdManagerAccount response.
      required:
      - ad_manager_account
      additionalProperties: true
    CreateAdManagerAccountRequestAdManagerAccountInfoManagingType:
      type: string
      enum:
      - UNKNOWN_MANAGING_TYPE
      - OWNER
      default: UNKNOWN_MANAGING_TYPE
    publicCreateAdManagerAccountRequestAdManagerAccountInfo:
      type: object
      properties:
        title:
          type: string
          description: Title of the AdManagerAccount.
        managing_type:
          $ref: '#/components/schemas/CreateAdManagerAccountRequestAdManagerAccountInfoManagingType'
        managing_ad_account_ids:
          type: array
          items:
            type: string
          description: List of ad account ids that the AdManagerAccount manages.
      description: AdManagerAccount info.
      required:
      - title
      - managing_type
      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"
    publicUpdateAdManagerAccountResponse:
      type: object
      properties:
        ad_manager_account:
          $ref: '#/components/schemas/v1AdManagerAccount'
      description: UpdateAdManagerAccount response.
      required:
      - ad_manager_account
      additionalProperties: true
    publicListAdManagerAccountsResponse:
      type: object
      properties:
        ad_manager_accounts:
          type: array
          items:
            $ref: '#/components/schemas/v1AdManagerAccount'
          description: List of AdManagerAccount info.
      description: ListAdManagerAccounts response.
      required:
      - ad_manager_accounts
      additionalProperties: true
    v1AdManagerAccount:
      type: object
      properties:
        id:
          type: string
          description: The id of the ad manager account.
          readOnly: true
        title:
          type: string
          description: The title of the ad manager account.
        managing_type:
          $ref: '#/components/schemas/v1AdManagerAccountManagingType'
        managing_ad_account_ids:
          type: array
          items:
            type: string
          description: The list of managing ad account id of the ad manager account.
        created_at:
          type: string
          format: date-time
          description: The created time of the ad manager account.
          readOnly: true
        updated_at:
          type: string
          format: date-time
          description: The updated time of the ad manager account.
          readOnly: true
      description: Definition of an ad manager account.
      required:
      - id
      - title
      - managing_type
      - created_at
      - updated_at
      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
    publicCreateAdManagerAccountResponse:
      type: object
      properties:
        ad_manager_account:
          $ref: '#/components/schemas/v1AdManagerAccount'
      description: CreateAdManagerAccount response.
      required:
      - ad_manager_account
      additionalProperties: true
  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-commerce-media-management-openapi.yml
x-readme:
  explorer-enabled: true