Sign in

v1

latestOpenAPI 3.0.02026-07-2678399358.2 KB
Decision

DecideAdReservedDisplay

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

post/rmp/decision/v1/platforms/{platform_id}/reserved-display-ads

Path parameters

platform_idstring required

Request body

request_idstring required

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

custom_idstring

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.

channel_type'UNKNOWN_CHANNEL_TYPE' | 'APP' | 'SITE' | 'DESKTOP_SITE' | 'MOBILE_SITE'

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)
domainstring

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.

page_idstring

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.

personalization_mode'UNKNOWN_PERSONALIZATION_MODE' | 'STANDARD' | 'METRIC_ONLY' | 'ID_LESS'

PersonalizationMode determines how user identification is handled in decision and event processing.

  • STANDARD: STANDARD means standard user processing with full user identification.
  • METRIC_ONLY: METRIC_ONLY means user data is used for metric collection only, not for personalization.
  • ID_LESS: ID_LESS means no user identification is used.

Response

A successful response.

request_idstring required

Identical with request_id of the corresponding request.