TagSetting
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eTag settings can be configured with JSON, allowing control over additional key-values, click tracking, click-through URLs, and keyword options.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eKeywordHandlingOption\u003c/code\u003e dictates how keywords are integrated into ad tags, impacting tag export behavior.\u003c/p\u003e\n"],["\u003cp\u003eThree keyword handling options are available: \u003ccode\u003ePLACEHOLDER_WITH_LIST_OF_KEYWORDS\u003c/code\u003e, \u003ccode\u003eIGNORE\u003c/code\u003e, and \u003ccode\u003eGENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD\u003c/code\u003e, each offering a different approach to keyword implementation in ad tags.\u003c/p\u003e\n"]]],[],null,["# TagSetting\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [KeywordHandlingOption](#KeywordHandlingOption)\n\nTag Settings\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"additionalKeyValues\": string, \"includeClickTracking\": boolean, \"includeClickThroughUrls\": boolean, \"keywordOption\": enum (/doubleclick-advertisers/rest/v4/TagSetting#KeywordHandlingOption) } ``` |\n\n| Fields ||\n|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `additional``Key``Values` | `string` Additional key-values to be included in tags. Each key-value pair must be of the form `key=value` , and pairs must be separated by a semicolon ( `;` ). Keys and values must not contain commas. For example, `id=2;color=red` is a valid value for this field. |\n| `include``Click``Tracking` | `boolean` Whether click-tracking string should be included in the tags. |\n| `include``Click``Through``Urls` | `boolean` Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. |\n| `keyword``Option` | `enum (`[KeywordHandlingOption](/doubleclick-advertisers/rest/v4/TagSetting#KeywordHandlingOption)`)` Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. |\n\nKeywordHandlingOption\n---------------------\n\nThis enum influences how tags are exported.\n\n| Enums ||\n|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `PLACEHOLDER_WITH_LIST_OF_KEYWORDS` | Creates DART ad tags with a placeholder, such as kw=\\[keyword\\] and a list of keywords. The site trafficker must replace \\[keyword\\] with the keywords targeted by an ad. |\n| `IGNORE` | Creates DART ad tags that do not have a placeholder for keywords and creates a list of keywords separately from the DART ad tags. Use this option if the site uses a keyword referrer or is a site that uses DART for Publishers. |\n| `GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD` | Results in unique tag generation for each relevant keyword during tag export. For example, an ad with three keywords will generate three tags with each tag having its kw= parameter filled in with the relevant keyword values. |"]]