General Information
      Back to home
      1. Help Center
      2. General Information

      Macros help

      The following macros are supported in Gamoshi's system.

      Macros are case-sensitive and should be surrounded by square brackets on both sides to be recognized. For example: [DEVICE_TYPE].

      Table of contents

      1. Device macros
      2. User macros
      3. Location/GEO macros
      4. Regulatory & Privacy macros
      5. Gamoshi's macros
      6. Impression macros
      7. Video macros
      8. Audio macros
      9. Content macros
      10. Publisher macros
      11. Bid macros
      12. Seller JSON macros
      13. Human (white ops) and LiveRamp macros
      14. General macros

       

      Device macros

       

      Macro Supported values Description
      CARRIER string Carrier or ISP (e.g., “VERIZON”) using exchange curated string
      names which should be published to bidders a priori.
      CONNECTION_TYPE Integer Network connection type. (Refer to List 5.22 on openRTB SPEC 2.5 from IAB).
      DEVICE_DID_MD5 String Hardware device ID (e.g., IMEI); hashed via MD5.
      DEVICE_DID_SHA1 String Hardware device ID (e.g., IMEI); hashed via SHA1
      DEVICE_JS Integer Support for JavaScript, where 0 = no, 1 = yes.
      DEVICE_TYPE Integer The general type of device. (Refer to List 5.21 on openRTB spec 2.5 of IAB)
      DEVICE_MAKE String Device make (Example: Apple/Samsung)
      DEVICE_MODEL String Device model (Example: iPhone)
      DEVICE_OS String Device OS (Example: iOS)
      DEVICE_OS_VERSION String Device OS Version (Example: "3.1.6")
      DEVICE_WIDTH Integer device width. Physical width of the screen in pixels
      DEVICE_HEIGHT Integer device height. Physical height of the screen in pixels.
      DISPLAY_MANAGER String Name of ad mediation partner, SDK technology, or player
      responsible for rendering ad (typically video or mobile). Used
      by some ad servers to customize ad code by partner.
      Recommended for video and/or apps.
      DISPLAY_MANAGER_VERSION String Version of ad mediation partner, SDK technology, or player
      responsible for rendering ad (typically video or mobile). Used
      by some ad servers to customize ad code by partner.
      Recommended for video and/or apps.
      IFA_TYPE string   
      IFV String  
      IFA   Device IFA. Identifier for Advertisers (IFA or IDFA) is a temporary device identifier used by the Apple set of handheld devices 
      DEVICE_PLATFORM_DID_SHA1 String dpidsha1 string Platform device ID (e.g., Android ID); hashed via SHA1.
      DEVICE_PLATFORM_DID_MD5 String dpidmd5 string Platform device ID (e.g., Android ID); hashed via MD5. 
      DEVICE_MAC_SHA1 String macsha1 string MAC address of the device; hashed via SHA1. 
      DEVICE_MAC_MD5 String macmd5 string MAC address of the device; hashed via MD5.
      IPADDR String The IP address of the user 
      PREF String Referrer URL that caused navigation to the current page.
      REGION String Region code using ISO-3166-2; 2-letter state code if USA
      IP String IPv4 address closest to device.
      IPADDR_6 / IP_6 String IPV 6
      IPADDR_RESOLVED String ip4 or ipv6

      User macros

      Macro Supported values Description
      CCPA Integer  Buyer-specific ID for the user as mapped by the exchange for
      the buyer. At least one of buyeruid or id is recommended.
      https://github.com/InteractiveAdvertisingBureau/USPrivacy/blob/master/CCPA/OpenRTB%20Extension%20for%20USPrivacy.md
      DNT 0,1 Do Not Track. Browser does not track setting. 0 = do not track 1= track
      UA String Browser user agent string.
      USER_GENDER String , M/F/O Gender, where “M” = male, “F” = female, “O” = known to be
      other (i.e., omitted is unknown).
      USER_ID String Exchange-specific ID for the user. 
      USER_KEYWORDS string Comma separated list of keywords, interests, or intent.
      USER_YOB Integer Year of birth as a 4-digit integer.

      Location/GEO macros

       

      Macro Supported values Description
      LAT float The latitude of the device/user
      LON float The longitude of the device/user 
      LOCATION_TYPE Integer Source of location data; recommended when passing lat/lon. (Refer to List 5.20 on openRTB spec of IAB)
      METRO String Metro code of the device/user. it is the OpenRTB equivalent of DMA.
      CITY String City using United Nations Code for Trade & Transport Locations. 
      COUNTRY String Country code using ISO-3166-1-alpha-3.
      COUNTRY_2_LETTERS String Two-character country code of the device/user.
      GEO String Country. Country code.
      ZIP String Zip or postal code

      Regulatory & Privacy

       

      Macro Supported values Description
      GDPR Integer Indicates if the user is part of the EU GDPR
      CONSENT String The consent string. (All formats are supported) Mandatory for all EU traffic
      US_PRIVACY String 1.The spec ver (A number 1 char)
      2.Opportunity to opt out (N = No, Y = yes, - = N/A)
      3. Opt-out sale: N = No, Y = Yes, - = N/A
      4. LSPA: N= No, Y= Yes, - = N
      Publisher is a signatory to the IAB limited Service Provider Agreement

      Gamoshi macros

       

      Macro Supported values Description
      CAMPAIGN_ID Integer Campaign ID in Gamoshi system
      CAMPAIGN_NAME String Campaign name in Gamoshi system
      INVENTORY_ID (SUPID, SUPPLY_ID) Integer Inventory ID in Gamoshi system
      INVENTORY_NAME   Inventory name in Gamoshi system
      ADVERTISER_ID (DEMAND_ID) Integer Advertiser ID in Gamoshi system
      ADVERTISER_BUSINESS_PARTNER_ID Integer Advertiser business partner ID in Gamoshi system
      ADVERTISER_NAME String Advertiser name in Gamoshi system
      INVENTORY_BUSINESS_PARTNER_ID Integer Inventory business partner ID in Gamoshi system
      INVENTORY_BUSINESS_PARTNER_NAME String Inventory business partner name Gamoshi system
      GAMOSHI_PUBLISHER_ID Integer Publisher ID in Gamoshi system
      MEDIA_TYPE String  
      CUSTOM_REQ_<XX> String custom request property that you can use as a placeholder for Mapping Rules. Where XX  range from 1 to 10. For example: "CUSTOM_REQ_05"
      CUSTOMER_PCHAIN String  
      REQUEST_PCHAIN String  
      CUSTOM_IMP_<XX> String custom impression property that you can use as a placeholder for Mapping Rules. Where XX  range from 1 to 10. For example: "CUSTOM_IMP_05"

      Impression macros

       

      Macro Supported values Description
      DOMAIN String The domain of the app /The domain of the Site
      PURL String URL of the page where the impression will be shown.
      ENCODED_PURL String URL of the page where the impression will be shown.
      ENCODED_2_PURL String  
      INTERSTITIAL 0,1 1 = the ad is interstitial or full screen, 0 = not interstitial (default 0)
      IMP_EXP Integer The number of seconds that may elapse between the auction and the actual impression.
      IMP_TAG_ID/PLACEMENT  String Identifier for specific ad placement.
      PAID 0,1 0 = app is free, 1 = the app is a paid version.
      SECURE Integer Flag to indicate if the impression requires secure HTTPS URL creative assets and markup, where 0 = non-secure, 1 = secure.
      If omitted, the secure state is unknown, but non-secure HTTP support can be assumed.
      AD_TYPE video, banner, native & audio  

      Video macros

       

      Macro Supported values Description
      VIDEO_PLACEMENT Integer The Placement type of Video
      VIDEO_SKIPPABLE 0,1 Should the player allow the video to be skipped
      VDR Integer Video duration
      VIDEO_MAX_BITRATE                   Integer Maximum bit rate in Kbps
      VIDEO_MAX_DURATION Integer Maximum video ad duration in seconds.
      VIDEO_MIN_BITRATE Integer Minimum bit rate in Kbps.
      VIDEO_MIN_DURATION Integer Minimum video ad duration in seconds.
      VIDEO_POSITION Integer Ad position on screen. (Refer to list 5.4 in openRTB spec 2.5 of IAB)
      MIN_DURATION Integer Minimum video ad duration: can be used for both video and audio.
      MAX_DURATION Integer Max video ad duration: can be used for both video and audio.

      Audio macros

       

      Macro Supported values Description
      AUDIO_MIN_DURATION Integer Minimum audio ad duration in seconds.
      AUDIO_MAX_DURATION Integer Maximum audio ad duration in seconds.

       

      Content macros

       

      Macro Supported values Description
      CONTENT_CATEGORY String array Array of IAB content categories that describe the content producer. (Refer to List 5.1 in openRTB spec 2.5).
      CONTENT_CONTEXT Integer Type of content (game, video, text, etc.). Refer to List 5.18.
      CONTENT_EPISODE Integer Episode number
      CONTENT_GENRE String Genre that best describes the content (e.g., rock, pop)
      CONTENT_KEYWORD String Comma separated list of keywords describing the content.
      CONTENT_LANGUAGE String Content language using ISO-639-1-alpha-2.
      CONTENT_LENGTH Integer Length of content in seconds; appropriate for video or audio.
      CONTENT_PRODUCER_DOMAIN String Highest level domain of the content producer (e.g., “producer.com”).
      CONTENT_PRODUCER_ID String Content producer or originator ID. Useful if content is syndicated and may be posted on a site using embed tags.
      CONTENT_PRODUCER_NAME String Content producer or originator name (e.g., “Warner Bros”).
      CONTENT_RATING String Content rating (e.g., MPAA).
      CONTENT_SEASON String Content season. example: "Season 4"
      CONTENT_SERIES String Content series.
      Video Examples: “The Office” (television), “Star Wars” (movie) Non-Video Example: “Ecocentric” (Time Magazine blog).
      CONTENT_TITLE String Content title.
      Video Examples: “Search Committee” (television), “A New Hope” (movie), or “Endgame” (made for web).
      Non-Video Example: “Why an Antarctic Glacier Is Melting So Quickly” (Time magazine article).

      Publisher macros

       

      Macro Supported values Description
      PUBLISHER_ID/PUBID String Publisher (supplier) ID. Exchange-specific publisher ID
       PUBLISHER_USER_ID String The user identifier passed in the initial bid request, usually representing the exchange’s user ID macro (sent by the publisher’s side).
      PUBLISHER_BUYER_UID String The buyer-specific user identifier passed in the initial bid request, mapped by the exchange for the buyer and typically aligned with your user ID macro (the receiving side).
      PUBLISHER_NAME String Publisher name (may be aliased at the publisher’s request)
      PUBLISHER_CATEGORY String array Array of IAB content categories that describe the publisher.
      (Refer to List 5.1 on openRTB spec 2.5 of IAB).
      PUBLISHER_DOMAIN String Highest level domain of the publisher (e.g., “publisher.com”)

      Bid macros

       

      Macro Supported values Description
      AD_SIZE  String  [ADH]x [ADW]. (250x300)
      ADH  Integer  Creative Height. The vertical height of the Ad in pixels
      ADW  Integer  Creative Width. The horizontal width of the Ad in pixels.
      API_FRAM  1-6  List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported
      APP_BUNDLE_ID String A platform-specific application identifier intended to be
      unique to the app and independent of the exchange. On
      Android, this should be a bundle or package name (e.g.,
      com.foo.mygame). On iOS, it is typically a numeric ID
      APP_CONTENT_ID String Content ID. Exchange-specific app ID
      APP_CONTENT_LEN Integer Mobile App content length. Length of content in seconds; appropriate for video or audio.
      APP_ID String Mobile app id. Exchange-specific app ID.
      APP_NAME String App name (maybe aliased at the publisher’s request)
      APP_CAT String IAB App category
      APP_STORE_URL String App store URL for an installed app
      APP_VERSION String Application version
      APPSTORE_ID String Apple store ID from the request
      BANNER_POSITION String Ad position on screen.
      BID_FLOOR_PRICE Float The minimum bid for this impression expressed in CPM.
      BID_ID/BID_REQUEST_ID/REQ_ID  String The bid request ID (auction id).
      BID_RESPONSE_ID String ID of the bid response (bid_response.bidid) , Bidder generated response ID to assist with logging/tracking (bidid 4.2.1)
      BID_RESPONSE_NBR Integer Reason for not bidding
      BUYER_UID String Buyer-specific ID for the user as mapped by the exchange 
      CA_ID Number Campaign ID of the Advertiser response. Campaign ID to assist with Creative quality checking; the collection of creatives for which iurl should be representative.
      ADVERTISER_BUNDLE string The bid response bundle
      ADVERTISER_DOMAIN String array Advertiser domain for block list checking (e.g., “ford.com”).
      This can be an array of, for the case of rotating creatives.
      Exchanges can mandate that only one domain is allowed
      CRI_ID string Creative ID. Creative ID to assist with Creative quality checking
      AD_ID String AD ID,  Ad/Creative id return as part of the bid
      PRICE Float Bid price expressed as CPM although the actual transaction is
      for a unit impression only. Note that while the type indicates
      float, integer math is highly recommended when handling
      currencies 

      Seller JSON macros

       

      Macro Supported values Description
      SELLER_ID String seller.json seller id
      SELLER_NAME String seller.json seller name
      SELLER_DOMAIN String seller.json seller domain

      HUMAN/WHITE OPS/LiveRamp macros

       

      Macro Supported values Description
      MEDIA_GUARD_PREDICTION_ID   Human 
      MEDIA_GUARD_PREDICTION_RESPONSE   Human 
      LIVE_RAMP_UUID String Liveramp envelope ID. This macro will be available only if the Live ramp service is activated for your account.

      General

       

      Macro Supported values Description
      CACHEBUSTER/CB/RANDOM Integer  
      CLICK_THROUGH_URL String Click-Through URL redirects to the destination website
      CLICK_URL String Click URL
      SITEID String Exchange-specific site ID.
      SITE_PAGE String URL of the page where the impression will be shown
      SCHAIN String Enables buyers to see all parties who are selling or reselling a given bid request. This can be used with OpenRTB 2.5 or OpenRTB 3.0. For more information refer to https://iabtechlab.com/sellers-json/.
      ENCODED_CLICK_URL String URL encoded once. 
      ENCODED_2_CLICK_URL String URL encoded twice.
      TIMESTAMP Integer Unix time in seconds (from 1/1/1970)
      TIMESTAMP_MS Integer Timestamp in mili seconds
      TMAX Integer Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout.
      This value supersedes any a priori guidance from the exchange.
      BIDDER_CODE String the advertiser bidder code / platform code generated by Gamoshi.
      MRAID_VERSION String For example: 2.0