> For the complete documentation index, see [llms.txt](https://support.gamoshi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.gamoshi.com/gamoshi-wiki/general-information/macro-help.md). # Macro help The following macros are supported in Gamoshi's system. ## Overview {% hint style="warning" %} **Important Syntax Rules:** Before using any macro, follow these formatting rules so the system recognizes them: * **Case-sensitive:** macros must be written in uppercase. * **Brackets:** macros must be surrounded by square brackets. * **Example:** use \[DEVICE\_TYPE], not device\_type or \[Device\_Type]. {% endhint %} This overview highlights the macros used most often. Refer to the relevant category below for the full list. *** ## Core Tracking Macros (Campaign & Advertiser) Use these to pass internal Gamoshi IDs to your tracker or landing page, to identify which campaign, creative, or advertiser generated the traffic. * **Campaign:** \[CAMPAIGN\_ID], \[CAMPAIGN\_NAME] * **Creative:** \[CREATIVE\_ID], \[CREATIVE\_NAME] * **Advertiser:** \[ADVERTISER\_ID], \[ADVERTISER\_NAME] * **Inventory/Publisher:** \[INVENTORY\_ID], \[PUBLISHER\_ID], \[INVENTORY\_NAME] * **Custom Mapping:** \[CUSTOM\_REQ\_01] through \[CUSTOM\_REQ\_10] (placeholders for mapping rules) *** ## Financial & Auction Macros Used for dynamic pricing and reconciling costs. * **Winning Price:** \[PRICE] — the CPM price of the bid. * **Auction ID:** \[BID\_ID] or \[REQ\_ID] — the unique ID of the bid request. * **Bid Floor:** \[BID\_FLOOR\_PRICE] — the minimum bid required. *** ## User & Device Identifiers Pass data about who is seeing the ad and on what device. * **User IDs:** \[USER\_ID] (exchange-specific user ID), \[BUYER\_UID] (buyer-specific ID mapped by the exchange) * **Device IDs (mobile/in-app):** \[IFA] (IDFA for Apple devices), \[DEVICE\_DID\_MD5] / \[DEVICE\_DID\_SHA1] (hashed hardware IDs), \[DEVICE\_PLATFORM\_DID\_SHA1] (hashed Android ID) * **Network/hardware:** \[IPADDR] (user IP address), \[UA] (browser user agent), \[CARRIER] (ISP or mobile carrier name), \[DEVICE\_TYPE] (mobile, desktop, etc.) *** ## Contextual & Source Macros Understand where the ad appeared — site vs. app. * **Web environment:** \[DOMAIN] (site domain), \[PURL] (page URL where the impression occurred), \[SITE\_PAGE] (URL of the page) * **App environment:** \[APP\_NAME] and \[APP\_BUNDLE\_ID] (e.g. com.game.example), \[APP\_STORE\_URL] (link to the app store) *** ## Privacy & Regulatory Macros Essential for GDPR and CCPA compliance. * **GDPR:** \[GDPR] (indicates if the user is in the EU), \[CONSENT] (the consent string) * **CCPA/US Privacy:** \[US\_PRIVACY] (compliance string for US privacy laws) * **Do Not Track:** \[DNT] (0 = track allowed, 1 = do not track) *** ## Creative & Technical Macros Identify which ad was shown and handle technical execution. * **Creative ID:** \[CRI\_ID] — the ID of the creative served. * **Ad size:** \[AD\_SIZE], \[ADW] (width), \[ADH] (height) * **Click handling:** \[CLICK\_URL] (the click-tracking URL), \[CACHEBUSTER] or \[RANDOM] (ensures the request is unique to prevent caching) * **Time:** \[TIMESTAMP] (Unix time) *** ## Video-Specific Macros For tracking player behavior on video campaigns. * **Duration:** \[VDR] — video duration. * **Skippability:** \[VIDEO\_SKIPPABLE] (0 or 1) * **Placement:** \[VIDEO\_PLACEMENT] (type of video placement) and \[VIDEO\_POSITION] (position on screen) *** ## Content & Audio Macros * **Audio:** \[AUDIO\_MIN\_DURATION], \[AUDIO\_MAX\_DURATION] * **Content details:** \[CONTENT\_GENRE], \[CONTENT\_EPISODE], \[CONTENT\_RATING], \[CONTENT\_SERIES], \[CONTENT\_LANGUAGE], \[CONTENT\_KEYWORD] * **Producer info:** \[CONTENT\_PRODUCER\_NAME] and \[CONTENT\_PRODUCER\_DOMAIN] *** ## Advanced Location/Geo Macros For highly granular location data. * **Coordinates:** \[LAT] (latitude) and \[LON] (longitude) * **Locale:** \[CITY], \[ZIP], \[METRO] (DMA), \[REGION] (state/province) * **Source:** \[LOCATION\_TYPE] — defines where the location data came from (e.g. GPS vs. IP) *** ## 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 | Physical width of the screen in pixels. | | DEVICE\_HEIGHT | Integer | Physical height of the screen in pixels. | | DISPLAY\_MANAGER | String | Name of the ad mediation partner, SDK technology, or player responsible for rendering the 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 the ad mediation partner, SDK technology, or player responsible for rendering the ad. Recommended for video and/or apps. | | IFA\_TYPE | string | — | | IFV | String | — | | IFA | — | Device IFA (a.k.a. Device ID) — Identifier for Advertisers (IFA/IDFA), a temporary device identifier used by Apple handheld devices. | | DEVICE\_PLATFORM\_DID\_SHA1 | String | Platform device ID (e.g., Android ID); hashed via SHA1. | | DEVICE\_PLATFORM\_DID\_MD5 | String | Platform device ID (e.g., Android ID); hashed via MD5. | | DEVICE\_MAC\_SHA1 | String | MAC address of the device; hashed via SHA1. | | DEVICE\_MAC\_MD5 | 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 the device. | | IPADDR\_6 / IP\_6 | String | IPv6 address. | | IPADDR\_RESOLVED | String | IPv4 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. See the[ IAB CCPA/US Privacy extension](https://github.com/InteractiveAdvertisingBureau/USPrivacy/blob/master/CCPA/OpenRTB%20Extension%20for%20USPrivacy.md). | | DNT | 0, 1 | Do Not Track — the browser's do-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 (omitted = 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 the OpenRTB spec of IAB). | | METRO | String | Metro code of the device/user — the OpenRTB equivalent of DMA. | | CITY | String | City, using the 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 code. | | ZIP | String | Zip or postal code. | *** ## Regulatory & Privacy Macros | **Macro** | **Supported Values** | **Description** | | ----------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GDPR | Integer | Indicates if the user falls under EU GDPR. | | CONSENT | String | The consent string (all formats are supported). Mandatory for all EU traffic. | | US\_PRIVACY | String | 1. Spec version (1 character number). 2. Opportunity to opt out (N = No, Y = Yes, - = N/A). 3. Opt-out of sale (N = No, Y = Yes, - = N/A). 4. LSPA — whether the publisher is a signatory to the IAB Limited Service Provider Agreement (N = No, Y = Yes, - = N/A). | *** *** ## Gamoshi Macros | **Macro** | **Supported Values** | **Description** | | ---------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | CAMPAIGN\_ID | Integer | Campaign ID in the Gamoshi system. | | CAMPAIGN\_NAME | String | Campaign name in the Gamoshi system. | | GAM\_CREATIVE\_ID | Integer | Creative ID in the Gamoshi system. | | GAM\_CREATIVE\_NAME | String | Creative name in the Gamoshi system. | | INVENTORY\_ID (SUPID, SUPPLY\_ID) | Integer | Inventory ID in the Gamoshi system. | | INVENTORY\_NAME | — | Inventory name in the Gamoshi system. | | ADVERTISER\_ID (DEMAND\_ID) | Integer | Advertiser ID in the Gamoshi system. | | ADVERTISER\_BUSINESS\_PARTNER\_ID | Integer | Advertiser business partner ID in the Gamoshi system. | | ADVERTISER\_NAME | String | Advertiser name in the Gamoshi system. | | INVENTORY\_BUSINESS\_PARTNER\_ID | Integer | Inventory business partner ID in the Gamoshi system. | | INVENTORY\_BUSINESS\_PARTNER\_NAME | String | Inventory business partner name in the Gamoshi system. | | GAMOSHI\_PUBLISHER\_ID | Integer | Publisher ID in the Gamoshi system. | | MEDIA\_TYPE | String | — | | CUSTOM\_REQ\_ | String | Custom request property usable as a placeholder for mapping rules, where XX ranges from 1 to 10 (e.g. "CUSTOM\_REQ\_05"). | | CUSTOMER\_PCHAIN | String | — | | REQUEST\_PCHAIN | String | — | | CUSTOM\_IMP\_ | String | Custom impression property usable as a placeholder for mapping rules, where XX ranges from 1 to 10 (e.g. "CUSTOM\_IMP\_05"). | | CUSTOM\_EVENT\_1 | String | Custom event 1 — event URL. | | CUSTOM\_EVENT\_2 | String | Custom event 2 — event URL. | | CUSTOM\_EVENT\_3 | String | Custom event 3 — event URL. | | CUSTOM\_EVENT\_4 | String | Custom event 4 — event URL. | | CUSTOM\_EVENT\_5 | String | Custom event 5 — event URL. | *** ## 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). | | 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 a specific ad placement. | | PAID | 0, 1 | 0 = app is free, 1 = app is a paid version. | | SECURE | Integer | Indicates 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 the video. | | VIDEO\_SKIPPABLE | 0, 1 | Whether the player allows 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 the OpenRTB spec 2.5 of IAB). | | MIN\_DURATION | Integer | Minimum ad duration; can be used for both video and audio. | | MAX\_DURATION | Integer | Maximum 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 describing the content producer (refer to List 5.1 in the 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 when 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 describing the publisher (refer to List 5.1 on the 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] (e.g., 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 isn't explicitly listed, it's assumed not to be supported. | | APP\_BUNDLE\_ID | String | A platform-specific application identifier, 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's typically a numeric ID. | | APP\_CONTENT\_ID | String | Content ID — exchange-specific app ID. | | APP\_CONTENT\_LEN | Integer | Mobile app content length, in seconds; appropriate for video or audio. | | APP\_ID | String | Mobile app ID — exchange-specific app ID. | | APP\_NAME | String | App name (may be 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) — a 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 — assists 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"). Can be an array for rotating creatives. Exchanges can mandate that only one domain is allowed. | | CRI\_ID | string | Creative ID — assists with creative quality checking. | | AD\_ID | String | Ad ID — the ad/creative ID returned as part of the bid. | | PRICE | Float | Bid price, expressed as CPM, although the actual transaction is for a unit impression only. Note: 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) and LiveRamp Macros | **Macro** | **Supported Values** | **Description** | | ---------------------------------- | -------------------- | ------------------------------------------------------------------------------------------- | | MEDIA\_GUARD\_PREDICTION\_ID | — | Human. | | MEDIA\_GUARD\_PREDICTION\_RESPONSE | — | Human. | | LIVE\_RAMP\_UUID | String | LiveRamp envelope ID. Available only if the LiveRamp service is activated for your account. | *** ## General Macros | **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. | | FORM\_SUBMISSION\_EVENT | String | A form submission pixel (like a click). | | INVITATION\_EVENT | String | A full invitation pixel. | | 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 selling or reselling a given bid request. Can be used with OpenRTB 2.5 or OpenRTB 3.0. See[ IAB Sellers.json](https://iabtechlab.com/sellers-json/) for more information. | | 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 milliseconds. | | 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. |