DecideAdBrands

post

https://sandbox-dcsn.mcm-api.moloco.com/rmp/decision/v1/platforms/{platform_id}/brand-auction

Request brand ads by auction. Server host may vary by platform. Moloco's staff will provide accurate host information.

Path Params

platform_id

string

required

Body Params

request_id

string

required

length ≤ 128

Unique identifier of the request. The client is responsible to create this value.

channel_type

string

enum

Defaults to UNKNOWN_CHANNEL_TYPE

ChannelType enumerates available channel types. Simply using APP and SITE is fine, but you can also further distinguish DESKTOP_SITE and MOBILE_SITE for web users.

APP: Mobile App (iOS or Android)
SITE: Site (e.g. Website)
DESKTOP_SITE: Desktop Site (e.g. Desktop Website)
MOBILE_SITE: Mobile Site (e.g. Mobile Website)

Allowed:

domain

string

Set domain to a value that can identify the domain portion of your website's URL. We recommend you keep the same value across your website and application if they share your backend.

session_id

string

length ≤ 128

Deprecated. Unique identifier for tracking users regardless of sign-in status.

custom_id

string

length ≤ 128

Alternative ID to track users regardless of sign-in status or device. This ID should be provided as a third option following the user.user_id and device.persistent_id, and is highly recommended to be hashed prior to being sent to Moloco. This ID must be provided if both the user.user_id and device.persistent_id fields are left empty. Please do not fill in a default value, and instead randomize it if you must, but we recommend you send some ID that can be used to track users even if for a short time span. Please reach out to Moloco if you have further questions about this ID.

user

object

User who gets recommended products or product ads.

device

object

inventories

array of objects

required

length ≤ 1

List of ad inventories (placements) to request decisions for. Each inventory represents a placement where ads can be displayed. Currently only supports an array of length 1.

inventories*

page_id

string

ID of the page where the ads will be displayed. It is a mandatory field if the Ad Placement (Inventory) is configured to use the PAGE_VIEW event type. If the ad placement is configured to use this Event type, please ensure that the 'page_id' value is consistent with the value you’re passing via the User Event API. If the ad placement is not configured to use the PAGE_VIEW Event type, it is not required to have a value for the 'page_id' parameter.

filtering

object

This field is used to filter ads based on a variety of criteria. Multiple filtering criteria are considered in an AND relationship. This means that an ad must meet all of the filtering criteria in order to be displayed. We support up to 5 simultaneous filtering criteria.

Responses

200A successful response.

400Bad request. Detailed cause can be found in the response message.

401Unauthorized. The request does not have valid authentication credentials for the operation.

403Permission denied. The caller does not have permission to execute the specified operation.

404Not found. One or more resources required to perform the request does not exist. Detailed cause can be found in the response message.

429Too many requests either by platform or by user. Detailed cause can be found in the response message.

500Internal server error. Detailed cause can be found in the response message.