1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.sites.html">sites</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets one site by ID.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Inserts a new site.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, adWordsSite=None, approved=None, campaignIds=None, directorySiteIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, unmappedSite=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a list of sites, possibly filtered. This method supports paging.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates an existing site. This method supports patch semantics.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates an existing site.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code> 106 <pre>Gets one site by ID. 107 108Args: 109 profileId: string, User profile ID associated with this request. (required) 110 id: string, Site ID. (required) 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115 116Returns: 117 An object of the form: 118 119 { # Contains properties of a site. 120 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 121 "approved": True or False, # Whether this site is approved. 122 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 123 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 124 "dimensionName": "A String", # The name of the dimension. 125 "etag": "A String", # The eTag of this response for caching purposes. 126 "id": "A String", # The ID associated with the value if available. 127 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 128 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 129 "value": "A String", # The value of the dimension. 130 }, 131 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 132 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 133 "dimensionName": "A String", # The name of the dimension. 134 "etag": "A String", # The eTag of this response for caching purposes. 135 "id": "A String", # The ID associated with the value if available. 136 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 137 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 138 "value": "A String", # The value of the dimension. 139 }, 140 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 141 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 142 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 143 "siteContacts": [ # Site contacts. 144 { # Site Contact 145 "address": "A String", # Address of this site contact. 146 "contactType": "A String", # Site contact type. 147 "email": "A String", # Email address of this site contact. This is a required field. 148 "firstName": "A String", # First name of this site contact. 149 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 150 "lastName": "A String", # Last name of this site contact. 151 "phone": "A String", # Primary phone number of this site contact. 152 "title": "A String", # Title or designation of this site contact. 153 }, 154 ], 155 "siteSettings": { # Site Settings # Site-wide settings. 156 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 157 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 158 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 159 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 160 "additionalKeyValues": "A 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. 161 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 162 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 163 "keywordOption": "A String", # 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. 164 }, 165 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 166 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 167 }, 168 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 169 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 170 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 171 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 172 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 173 { # Represents the dimensions of ads, placements, creatives, or creative assets. 174 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 175 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 176 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 177 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 178 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 179 }, 180 ], 181 "imageOnly": True or False, # Whether to serve only static images as companions. 182 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 183 }, 184 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 185 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 186 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 187 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 188 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 189 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 190 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 191 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 192 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 193 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 194 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 195 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 196 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 197 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 198 }, 199 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 200 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 201 }, 202 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 203 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 204 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 205 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 206 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 207 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 208 }, 209 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 210 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 211 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 212 }, 213 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 214 }, 215 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 216 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 217 42, 218 ], 219 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 220 }, 221 }, 222}</pre> 223</div> 224 225<div class="method"> 226 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 227 <pre>Inserts a new site. 228 229Args: 230 profileId: string, User profile ID associated with this request. (required) 231 body: object, The request body. 232 The object takes the form of: 233 234{ # Contains properties of a site. 235 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 236 "approved": True or False, # Whether this site is approved. 237 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 238 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 239 "dimensionName": "A String", # The name of the dimension. 240 "etag": "A String", # The eTag of this response for caching purposes. 241 "id": "A String", # The ID associated with the value if available. 242 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 243 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 244 "value": "A String", # The value of the dimension. 245 }, 246 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 247 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 248 "dimensionName": "A String", # The name of the dimension. 249 "etag": "A String", # The eTag of this response for caching purposes. 250 "id": "A String", # The ID associated with the value if available. 251 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 252 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 253 "value": "A String", # The value of the dimension. 254 }, 255 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 256 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 257 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 258 "siteContacts": [ # Site contacts. 259 { # Site Contact 260 "address": "A String", # Address of this site contact. 261 "contactType": "A String", # Site contact type. 262 "email": "A String", # Email address of this site contact. This is a required field. 263 "firstName": "A String", # First name of this site contact. 264 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 265 "lastName": "A String", # Last name of this site contact. 266 "phone": "A String", # Primary phone number of this site contact. 267 "title": "A String", # Title or designation of this site contact. 268 }, 269 ], 270 "siteSettings": { # Site Settings # Site-wide settings. 271 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 272 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 273 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 274 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 275 "additionalKeyValues": "A 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. 276 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 277 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 278 "keywordOption": "A String", # 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. 279 }, 280 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 281 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 282 }, 283 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 284 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 285 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 286 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 287 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 288 { # Represents the dimensions of ads, placements, creatives, or creative assets. 289 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 290 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 291 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 292 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 293 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 294 }, 295 ], 296 "imageOnly": True or False, # Whether to serve only static images as companions. 297 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 298 }, 299 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 300 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 301 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 302 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 303 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 304 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 305 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 306 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 307 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 308 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 309 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 310 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 311 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 312 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 313 }, 314 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 315 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 316 }, 317 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 318 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 319 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 320 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 321 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 322 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 323 }, 324 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 325 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 326 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 327 }, 328 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 329 }, 330 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 331 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 332 42, 333 ], 334 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 335 }, 336 }, 337} 338 339 x__xgafv: string, V1 error format. 340 Allowed values 341 1 - v1 error format 342 2 - v2 error format 343 344Returns: 345 An object of the form: 346 347 { # Contains properties of a site. 348 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 349 "approved": True or False, # Whether this site is approved. 350 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 351 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 352 "dimensionName": "A String", # The name of the dimension. 353 "etag": "A String", # The eTag of this response for caching purposes. 354 "id": "A String", # The ID associated with the value if available. 355 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 356 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 357 "value": "A String", # The value of the dimension. 358 }, 359 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 360 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 361 "dimensionName": "A String", # The name of the dimension. 362 "etag": "A String", # The eTag of this response for caching purposes. 363 "id": "A String", # The ID associated with the value if available. 364 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 365 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 366 "value": "A String", # The value of the dimension. 367 }, 368 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 369 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 370 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 371 "siteContacts": [ # Site contacts. 372 { # Site Contact 373 "address": "A String", # Address of this site contact. 374 "contactType": "A String", # Site contact type. 375 "email": "A String", # Email address of this site contact. This is a required field. 376 "firstName": "A String", # First name of this site contact. 377 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 378 "lastName": "A String", # Last name of this site contact. 379 "phone": "A String", # Primary phone number of this site contact. 380 "title": "A String", # Title or designation of this site contact. 381 }, 382 ], 383 "siteSettings": { # Site Settings # Site-wide settings. 384 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 385 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 386 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 387 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 388 "additionalKeyValues": "A 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. 389 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 390 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 391 "keywordOption": "A String", # 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. 392 }, 393 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 394 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 395 }, 396 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 397 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 398 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 399 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 400 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 401 { # Represents the dimensions of ads, placements, creatives, or creative assets. 402 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 403 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 404 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 405 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 406 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 407 }, 408 ], 409 "imageOnly": True or False, # Whether to serve only static images as companions. 410 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 411 }, 412 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 413 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 414 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 415 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 416 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 417 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 418 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 419 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 420 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 421 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 422 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 423 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 424 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 425 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 426 }, 427 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 428 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 429 }, 430 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 431 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 432 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 433 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 434 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 435 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 436 }, 437 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 438 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 439 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 440 }, 441 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 442 }, 443 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 444 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 445 42, 446 ], 447 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 448 }, 449 }, 450}</pre> 451</div> 452 453<div class="method"> 454 <code class="details" id="list">list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, adWordsSite=None, approved=None, campaignIds=None, directorySiteIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, unmappedSite=None, x__xgafv=None)</code> 455 <pre>Retrieves a list of sites, possibly filtered. This method supports paging. 456 457Args: 458 profileId: string, User profile ID associated with this request. (required) 459 acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned. 460 acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned. 461 acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements. 462 adWordsSite: boolean, Select only AdWords sites. 463 approved: boolean, Select only approved sites. 464 campaignIds: string, Select only sites with these campaign IDs. (repeated) 465 directorySiteIds: string, Select only sites with these directory site IDs. (repeated) 466 ids: string, Select only sites with these IDs. (repeated) 467 maxResults: integer, Maximum number of results to return. 468 pageToken: string, Value of the nextPageToken from the previous result page. 469 searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". 470 sortField: string, Field by which to sort the list. 471 Allowed values 472 ID - 473 NAME - 474 sortOrder: string, Order of sorted results. 475 Allowed values 476 ASCENDING - 477 DESCENDING - 478 subaccountId: string, Select only sites with this subaccount ID. 479 unmappedSite: boolean, Select only sites that have not been mapped to a directory site. 480 x__xgafv: string, V1 error format. 481 Allowed values 482 1 - v1 error format 483 2 - v2 error format 484 485Returns: 486 An object of the form: 487 488 { # Site List Response 489 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". 490 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 491 "sites": [ # Site collection. 492 { # Contains properties of a site. 493 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 494 "approved": True or False, # Whether this site is approved. 495 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 496 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 497 "dimensionName": "A String", # The name of the dimension. 498 "etag": "A String", # The eTag of this response for caching purposes. 499 "id": "A String", # The ID associated with the value if available. 500 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 501 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 502 "value": "A String", # The value of the dimension. 503 }, 504 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 505 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 506 "dimensionName": "A String", # The name of the dimension. 507 "etag": "A String", # The eTag of this response for caching purposes. 508 "id": "A String", # The ID associated with the value if available. 509 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 510 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 511 "value": "A String", # The value of the dimension. 512 }, 513 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 514 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 515 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 516 "siteContacts": [ # Site contacts. 517 { # Site Contact 518 "address": "A String", # Address of this site contact. 519 "contactType": "A String", # Site contact type. 520 "email": "A String", # Email address of this site contact. This is a required field. 521 "firstName": "A String", # First name of this site contact. 522 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 523 "lastName": "A String", # Last name of this site contact. 524 "phone": "A String", # Primary phone number of this site contact. 525 "title": "A String", # Title or designation of this site contact. 526 }, 527 ], 528 "siteSettings": { # Site Settings # Site-wide settings. 529 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 530 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 531 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 532 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 533 "additionalKeyValues": "A 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. 534 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 535 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 536 "keywordOption": "A String", # 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. 537 }, 538 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 539 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 540 }, 541 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 542 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 543 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 544 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 545 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 546 { # Represents the dimensions of ads, placements, creatives, or creative assets. 547 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 548 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 549 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 550 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 551 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 552 }, 553 ], 554 "imageOnly": True or False, # Whether to serve only static images as companions. 555 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 556 }, 557 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 558 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 559 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 560 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 561 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 562 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 563 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 564 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 565 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 566 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 567 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 568 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 569 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 570 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 571 }, 572 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 573 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 574 }, 575 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 576 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 577 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 578 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 579 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 580 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 581 }, 582 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 583 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 584 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 585 }, 586 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 587 }, 588 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 589 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 590 42, 591 ], 592 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 593 }, 594 }, 595 }, 596 ], 597}</pre> 598</div> 599 600<div class="method"> 601 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 602 <pre>Retrieves the next page of results. 603 604Args: 605 previous_request: The request for the previous page. (required) 606 previous_response: The response from the request for the previous page. (required) 607 608Returns: 609 A request object that you can call 'execute()' on to request the next 610 page. Returns None if there are no more items in the collection. 611 </pre> 612</div> 613 614<div class="method"> 615 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 616 <pre>Updates an existing site. This method supports patch semantics. 617 618Args: 619 profileId: string, User profile ID associated with this request. (required) 620 id: string, Site ID. (required) 621 body: object, The request body. 622 The object takes the form of: 623 624{ # Contains properties of a site. 625 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 626 "approved": True or False, # Whether this site is approved. 627 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 628 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 629 "dimensionName": "A String", # The name of the dimension. 630 "etag": "A String", # The eTag of this response for caching purposes. 631 "id": "A String", # The ID associated with the value if available. 632 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 633 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 634 "value": "A String", # The value of the dimension. 635 }, 636 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 637 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 638 "dimensionName": "A String", # The name of the dimension. 639 "etag": "A String", # The eTag of this response for caching purposes. 640 "id": "A String", # The ID associated with the value if available. 641 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 642 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 643 "value": "A String", # The value of the dimension. 644 }, 645 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 646 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 647 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 648 "siteContacts": [ # Site contacts. 649 { # Site Contact 650 "address": "A String", # Address of this site contact. 651 "contactType": "A String", # Site contact type. 652 "email": "A String", # Email address of this site contact. This is a required field. 653 "firstName": "A String", # First name of this site contact. 654 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 655 "lastName": "A String", # Last name of this site contact. 656 "phone": "A String", # Primary phone number of this site contact. 657 "title": "A String", # Title or designation of this site contact. 658 }, 659 ], 660 "siteSettings": { # Site Settings # Site-wide settings. 661 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 662 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 663 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 664 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 665 "additionalKeyValues": "A 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. 666 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 667 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 668 "keywordOption": "A String", # 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. 669 }, 670 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 671 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 672 }, 673 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 674 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 675 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 676 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 677 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 678 { # Represents the dimensions of ads, placements, creatives, or creative assets. 679 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 680 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 681 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 682 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 683 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 684 }, 685 ], 686 "imageOnly": True or False, # Whether to serve only static images as companions. 687 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 688 }, 689 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 690 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 691 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 692 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 693 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 694 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 695 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 696 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 697 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 698 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 699 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 700 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 701 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 702 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 703 }, 704 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 705 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 706 }, 707 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 708 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 709 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 710 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 711 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 712 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 713 }, 714 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 715 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 716 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 717 }, 718 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 719 }, 720 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 721 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 722 42, 723 ], 724 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 725 }, 726 }, 727} 728 729 x__xgafv: string, V1 error format. 730 Allowed values 731 1 - v1 error format 732 2 - v2 error format 733 734Returns: 735 An object of the form: 736 737 { # Contains properties of a site. 738 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 739 "approved": True or False, # Whether this site is approved. 740 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 741 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 742 "dimensionName": "A String", # The name of the dimension. 743 "etag": "A String", # The eTag of this response for caching purposes. 744 "id": "A String", # The ID associated with the value if available. 745 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 746 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 747 "value": "A String", # The value of the dimension. 748 }, 749 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 750 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 751 "dimensionName": "A String", # The name of the dimension. 752 "etag": "A String", # The eTag of this response for caching purposes. 753 "id": "A String", # The ID associated with the value if available. 754 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 755 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 756 "value": "A String", # The value of the dimension. 757 }, 758 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 759 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 760 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 761 "siteContacts": [ # Site contacts. 762 { # Site Contact 763 "address": "A String", # Address of this site contact. 764 "contactType": "A String", # Site contact type. 765 "email": "A String", # Email address of this site contact. This is a required field. 766 "firstName": "A String", # First name of this site contact. 767 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 768 "lastName": "A String", # Last name of this site contact. 769 "phone": "A String", # Primary phone number of this site contact. 770 "title": "A String", # Title or designation of this site contact. 771 }, 772 ], 773 "siteSettings": { # Site Settings # Site-wide settings. 774 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 775 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 776 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 777 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 778 "additionalKeyValues": "A 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. 779 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 780 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 781 "keywordOption": "A String", # 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. 782 }, 783 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 784 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 785 }, 786 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 787 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 788 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 789 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 790 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 791 { # Represents the dimensions of ads, placements, creatives, or creative assets. 792 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 793 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 794 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 795 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 796 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 797 }, 798 ], 799 "imageOnly": True or False, # Whether to serve only static images as companions. 800 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 801 }, 802 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 803 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 804 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 805 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 806 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 807 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 808 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 809 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 810 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 811 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 812 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 813 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 814 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 815 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 816 }, 817 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 818 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 819 }, 820 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 821 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 822 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 823 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 824 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 825 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 826 }, 827 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 828 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 829 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 830 }, 831 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 832 }, 833 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 834 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 835 42, 836 ], 837 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 838 }, 839 }, 840}</pre> 841</div> 842 843<div class="method"> 844 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 845 <pre>Updates an existing site. 846 847Args: 848 profileId: string, User profile ID associated with this request. (required) 849 body: object, The request body. 850 The object takes the form of: 851 852{ # Contains properties of a site. 853 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 854 "approved": True or False, # Whether this site is approved. 855 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 856 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 857 "dimensionName": "A String", # The name of the dimension. 858 "etag": "A String", # The eTag of this response for caching purposes. 859 "id": "A String", # The ID associated with the value if available. 860 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 861 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 862 "value": "A String", # The value of the dimension. 863 }, 864 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 865 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 866 "dimensionName": "A String", # The name of the dimension. 867 "etag": "A String", # The eTag of this response for caching purposes. 868 "id": "A String", # The ID associated with the value if available. 869 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 870 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 871 "value": "A String", # The value of the dimension. 872 }, 873 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 874 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 875 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 876 "siteContacts": [ # Site contacts. 877 { # Site Contact 878 "address": "A String", # Address of this site contact. 879 "contactType": "A String", # Site contact type. 880 "email": "A String", # Email address of this site contact. This is a required field. 881 "firstName": "A String", # First name of this site contact. 882 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 883 "lastName": "A String", # Last name of this site contact. 884 "phone": "A String", # Primary phone number of this site contact. 885 "title": "A String", # Title or designation of this site contact. 886 }, 887 ], 888 "siteSettings": { # Site Settings # Site-wide settings. 889 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 890 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 891 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 892 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 893 "additionalKeyValues": "A 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. 894 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 895 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 896 "keywordOption": "A String", # 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. 897 }, 898 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 899 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 900 }, 901 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 902 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 903 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 904 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 905 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 906 { # Represents the dimensions of ads, placements, creatives, or creative assets. 907 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 908 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 909 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 910 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 911 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 912 }, 913 ], 914 "imageOnly": True or False, # Whether to serve only static images as companions. 915 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 916 }, 917 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 918 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 919 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 920 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 921 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 922 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 923 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 924 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 925 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 926 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 927 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 928 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 929 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 930 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 931 }, 932 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 933 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 934 }, 935 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 936 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 937 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 938 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 939 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 940 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 941 }, 942 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 943 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 944 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 945 }, 946 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 947 }, 948 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 949 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 950 42, 951 ], 952 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 953 }, 954 }, 955} 956 957 x__xgafv: string, V1 error format. 958 Allowed values 959 1 - v1 error format 960 2 - v2 error format 961 962Returns: 963 An object of the form: 964 965 { # Contains properties of a site. 966 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 967 "approved": True or False, # Whether this site is approved. 968 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 969 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 970 "dimensionName": "A String", # The name of the dimension. 971 "etag": "A String", # The eTag of this response for caching purposes. 972 "id": "A String", # The ID associated with the value if available. 973 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 974 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 975 "value": "A String", # The value of the dimension. 976 }, 977 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 978 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 979 "dimensionName": "A String", # The name of the dimension. 980 "etag": "A String", # The eTag of this response for caching purposes. 981 "id": "A String", # The ID associated with the value if available. 982 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 983 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 984 "value": "A String", # The value of the dimension. 985 }, 986 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 987 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 988 "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account. 989 "siteContacts": [ # Site contacts. 990 { # Site Contact 991 "address": "A String", # Address of this site contact. 992 "contactType": "A String", # Site contact type. 993 "email": "A String", # Email address of this site contact. This is a required field. 994 "firstName": "A String", # First name of this site contact. 995 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 996 "lastName": "A String", # Last name of this site contact. 997 "phone": "A String", # Primary phone number of this site contact. 998 "title": "A String", # Title or designation of this site contact. 999 }, 1000 ], 1001 "siteSettings": { # Site Settings # Site-wide settings. 1002 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 1003 "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect. 1004 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 1005 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 1006 "additionalKeyValues": "A 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. 1007 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 1008 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 1009 "keywordOption": "A String", # 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. 1010 }, 1011 "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement. 1012 "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. 1013 }, 1014 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 1015 "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement. 1016 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 1017 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 1018 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 1019 { # Represents the dimensions of ads, placements, creatives, or creative assets. 1020 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1021 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1022 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1023 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1024 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1025 }, 1026 ], 1027 "imageOnly": True or False, # Whether to serve only static images as companions. 1028 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 1029 }, 1030 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 1031 "obaEnabled": True or False, # Whether OBA icons are enabled for this placement. 1032 "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. 1033 "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked. 1034 "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked. 1035 "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked. 1036 "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices. 1037 "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more 1038 "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size. 1039 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 1040 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 1041 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 1042 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 1043 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 1044 }, 1045 "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right. 1046 "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom. 1047 }, 1048 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 1049 "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. 1050 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 1051 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 1052 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1053 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1054 }, 1055 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 1056 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 1057 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 1058 }, 1059 "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. 1060 }, 1061 "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. 1062 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 1063 42, 1064 ], 1065 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 1066 }, 1067 }, 1068}</pre> 1069</div> 1070 1071</body></html>