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_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.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 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 186 "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. 187 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 188 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 189 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 190 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 191 }, 192 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 193 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 194 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 195 }, 196 "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. 197 }, 198 "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. 199 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 200 42, 201 ], 202 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 203 }, 204 }, 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 210 <pre>Inserts a new site. 211 212Args: 213 profileId: string, User profile ID associated with this request. (required) 214 body: object, The request body. 215 The object takes the form of: 216 217{ # Contains properties of a site. 218 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 219 "approved": True or False, # Whether this site is approved. 220 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 221 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 222 "dimensionName": "A String", # The name of the dimension. 223 "etag": "A String", # The eTag of this response for caching purposes. 224 "id": "A String", # The ID associated with the value if available. 225 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 226 "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. 227 "value": "A String", # The value of the dimension. 228 }, 229 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 230 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 231 "dimensionName": "A String", # The name of the dimension. 232 "etag": "A String", # The eTag of this response for caching purposes. 233 "id": "A String", # The ID associated with the value if available. 234 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 235 "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. 236 "value": "A String", # The value of the dimension. 237 }, 238 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 239 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 240 "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. 241 "siteContacts": [ # Site contacts. 242 { # Site Contact 243 "address": "A String", # Address of this site contact. 244 "contactType": "A String", # Site contact type. 245 "email": "A String", # Email address of this site contact. This is a required field. 246 "firstName": "A String", # First name of this site contact. 247 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 248 "lastName": "A String", # Last name of this site contact. 249 "phone": "A String", # Primary phone number of this site contact. 250 "title": "A String", # Title or designation of this site contact. 251 }, 252 ], 253 "siteSettings": { # Site Settings # Site-wide settings. 254 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 255 "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. 256 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 257 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 258 "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. 259 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 260 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 261 "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. 262 }, 263 "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. 264 "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. 265 }, 266 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 267 "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. 268 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 269 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 270 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 271 { # Represents the dimensions of ads, placements, creatives, or creative assets. 272 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 273 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 274 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 275 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 276 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 277 }, 278 ], 279 "imageOnly": True or False, # Whether to serve only static images as companions. 280 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 281 }, 282 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 283 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 284 "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. 285 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 286 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 287 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 288 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 289 }, 290 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 291 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 292 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 293 }, 294 "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. 295 }, 296 "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. 297 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 298 42, 299 ], 300 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 301 }, 302 }, 303} 304 305 x__xgafv: string, V1 error format. 306 Allowed values 307 1 - v1 error format 308 2 - v2 error format 309 310Returns: 311 An object of the form: 312 313 { # Contains properties of a site. 314 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 315 "approved": True or False, # Whether this site is approved. 316 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 317 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 318 "dimensionName": "A String", # The name of the dimension. 319 "etag": "A String", # The eTag of this response for caching purposes. 320 "id": "A String", # The ID associated with the value if available. 321 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 322 "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. 323 "value": "A String", # The value of the dimension. 324 }, 325 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 326 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 327 "dimensionName": "A String", # The name of the dimension. 328 "etag": "A String", # The eTag of this response for caching purposes. 329 "id": "A String", # The ID associated with the value if available. 330 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 331 "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. 332 "value": "A String", # The value of the dimension. 333 }, 334 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 335 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 336 "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. 337 "siteContacts": [ # Site contacts. 338 { # Site Contact 339 "address": "A String", # Address of this site contact. 340 "contactType": "A String", # Site contact type. 341 "email": "A String", # Email address of this site contact. This is a required field. 342 "firstName": "A String", # First name of this site contact. 343 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 344 "lastName": "A String", # Last name of this site contact. 345 "phone": "A String", # Primary phone number of this site contact. 346 "title": "A String", # Title or designation of this site contact. 347 }, 348 ], 349 "siteSettings": { # Site Settings # Site-wide settings. 350 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 351 "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. 352 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 353 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 354 "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. 355 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 356 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 357 "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. 358 }, 359 "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. 360 "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. 361 }, 362 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 363 "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. 364 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 365 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 366 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 367 { # Represents the dimensions of ads, placements, creatives, or creative assets. 368 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 369 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 370 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 371 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 372 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 373 }, 374 ], 375 "imageOnly": True or False, # Whether to serve only static images as companions. 376 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 377 }, 378 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 379 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 380 "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. 381 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 382 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 383 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 384 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 385 }, 386 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 387 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 388 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 389 }, 390 "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. 391 }, 392 "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. 393 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 394 42, 395 ], 396 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 397 }, 398 }, 399}</pre> 400</div> 401 402<div class="method"> 403 <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> 404 <pre>Retrieves a list of sites, possibly filtered. This method supports paging. 405 406Args: 407 profileId: string, User profile ID associated with this request. (required) 408 acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned. 409 acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned. 410 acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements. 411 adWordsSite: boolean, Select only AdWords sites. 412 approved: boolean, Select only approved sites. 413 campaignIds: string, Select only sites with these campaign IDs. (repeated) 414 directorySiteIds: string, Select only sites with these directory site IDs. (repeated) 415 ids: string, Select only sites with these IDs. (repeated) 416 maxResults: integer, Maximum number of results to return. 417 pageToken: string, Value of the nextPageToken from the previous result page. 418 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". 419 sortField: string, Field by which to sort the list. 420 Allowed values 421 ID - 422 NAME - 423 sortOrder: string, Order of sorted results. 424 Allowed values 425 ASCENDING - 426 DESCENDING - 427 subaccountId: string, Select only sites with this subaccount ID. 428 unmappedSite: boolean, Select only sites that have not been mapped to a directory site. 429 x__xgafv: string, V1 error format. 430 Allowed values 431 1 - v1 error format 432 2 - v2 error format 433 434Returns: 435 An object of the form: 436 437 { # Site List Response 438 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse". 439 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 440 "sites": [ # Site collection. 441 { # Contains properties of a site. 442 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 443 "approved": True or False, # Whether this site is approved. 444 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 445 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 446 "dimensionName": "A String", # The name of the dimension. 447 "etag": "A String", # The eTag of this response for caching purposes. 448 "id": "A String", # The ID associated with the value if available. 449 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 450 "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. 451 "value": "A String", # The value of the dimension. 452 }, 453 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 454 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 455 "dimensionName": "A String", # The name of the dimension. 456 "etag": "A String", # The eTag of this response for caching purposes. 457 "id": "A String", # The ID associated with the value if available. 458 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 459 "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. 460 "value": "A String", # The value of the dimension. 461 }, 462 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 463 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 464 "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. 465 "siteContacts": [ # Site contacts. 466 { # Site Contact 467 "address": "A String", # Address of this site contact. 468 "contactType": "A String", # Site contact type. 469 "email": "A String", # Email address of this site contact. This is a required field. 470 "firstName": "A String", # First name of this site contact. 471 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 472 "lastName": "A String", # Last name of this site contact. 473 "phone": "A String", # Primary phone number of this site contact. 474 "title": "A String", # Title or designation of this site contact. 475 }, 476 ], 477 "siteSettings": { # Site Settings # Site-wide settings. 478 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 479 "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. 480 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 481 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 482 "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. 483 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 484 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 485 "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. 486 }, 487 "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. 488 "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. 489 }, 490 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 491 "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. 492 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 493 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 494 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 495 { # Represents the dimensions of ads, placements, creatives, or creative assets. 496 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 497 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 498 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 499 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 500 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 501 }, 502 ], 503 "imageOnly": True or False, # Whether to serve only static images as companions. 504 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 505 }, 506 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 507 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 508 "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. 509 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 510 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 511 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 512 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 513 }, 514 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 515 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 516 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 517 }, 518 "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. 519 }, 520 "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. 521 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 522 42, 523 ], 524 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 525 }, 526 }, 527 }, 528 ], 529}</pre> 530</div> 531 532<div class="method"> 533 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 534 <pre>Retrieves the next page of results. 535 536Args: 537 previous_request: The request for the previous page. (required) 538 previous_response: The response from the request for the previous page. (required) 539 540Returns: 541 A request object that you can call 'execute()' on to request the next 542 page. Returns None if there are no more items in the collection. 543 </pre> 544</div> 545 546<div class="method"> 547 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 548 <pre>Updates an existing site. This method supports patch semantics. 549 550Args: 551 profileId: string, User profile ID associated with this request. (required) 552 id: string, Site ID. (required) 553 body: object, The request body. 554 The object takes the form of: 555 556{ # Contains properties of a site. 557 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 558 "approved": True or False, # Whether this site is approved. 559 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 560 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 561 "dimensionName": "A String", # The name of the dimension. 562 "etag": "A String", # The eTag of this response for caching purposes. 563 "id": "A String", # The ID associated with the value if available. 564 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 565 "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. 566 "value": "A String", # The value of the dimension. 567 }, 568 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 569 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 570 "dimensionName": "A String", # The name of the dimension. 571 "etag": "A String", # The eTag of this response for caching purposes. 572 "id": "A String", # The ID associated with the value if available. 573 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 574 "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. 575 "value": "A String", # The value of the dimension. 576 }, 577 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 578 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 579 "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. 580 "siteContacts": [ # Site contacts. 581 { # Site Contact 582 "address": "A String", # Address of this site contact. 583 "contactType": "A String", # Site contact type. 584 "email": "A String", # Email address of this site contact. This is a required field. 585 "firstName": "A String", # First name of this site contact. 586 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 587 "lastName": "A String", # Last name of this site contact. 588 "phone": "A String", # Primary phone number of this site contact. 589 "title": "A String", # Title or designation of this site contact. 590 }, 591 ], 592 "siteSettings": { # Site Settings # Site-wide settings. 593 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 594 "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. 595 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 596 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 597 "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. 598 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 599 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 600 "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. 601 }, 602 "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. 603 "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. 604 }, 605 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 606 "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. 607 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 608 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 609 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 610 { # Represents the dimensions of ads, placements, creatives, or creative assets. 611 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 612 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 613 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 614 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 615 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 616 }, 617 ], 618 "imageOnly": True or False, # Whether to serve only static images as companions. 619 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 620 }, 621 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 622 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 623 "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. 624 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 625 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 626 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 627 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 628 }, 629 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 630 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 631 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 632 }, 633 "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. 634 }, 635 "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. 636 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 637 42, 638 ], 639 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 640 }, 641 }, 642} 643 644 x__xgafv: string, V1 error format. 645 Allowed values 646 1 - v1 error format 647 2 - v2 error format 648 649Returns: 650 An object of the form: 651 652 { # Contains properties of a site. 653 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 654 "approved": True or False, # Whether this site is approved. 655 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 656 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 657 "dimensionName": "A String", # The name of the dimension. 658 "etag": "A String", # The eTag of this response for caching purposes. 659 "id": "A String", # The ID associated with the value if available. 660 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 661 "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. 662 "value": "A String", # The value of the dimension. 663 }, 664 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 665 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 666 "dimensionName": "A String", # The name of the dimension. 667 "etag": "A String", # The eTag of this response for caching purposes. 668 "id": "A String", # The ID associated with the value if available. 669 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 670 "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. 671 "value": "A String", # The value of the dimension. 672 }, 673 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 674 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 675 "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. 676 "siteContacts": [ # Site contacts. 677 { # Site Contact 678 "address": "A String", # Address of this site contact. 679 "contactType": "A String", # Site contact type. 680 "email": "A String", # Email address of this site contact. This is a required field. 681 "firstName": "A String", # First name of this site contact. 682 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 683 "lastName": "A String", # Last name of this site contact. 684 "phone": "A String", # Primary phone number of this site contact. 685 "title": "A String", # Title or designation of this site contact. 686 }, 687 ], 688 "siteSettings": { # Site Settings # Site-wide settings. 689 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 690 "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. 691 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 692 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 693 "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. 694 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 695 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 696 "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. 697 }, 698 "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. 699 "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. 700 }, 701 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 702 "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. 703 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 704 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 705 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 706 { # Represents the dimensions of ads, placements, creatives, or creative assets. 707 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 708 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 709 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 710 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 711 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 712 }, 713 ], 714 "imageOnly": True or False, # Whether to serve only static images as companions. 715 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 716 }, 717 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 718 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 719 "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. 720 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 721 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 722 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 723 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 724 }, 725 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 726 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 727 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 728 }, 729 "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. 730 }, 731 "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. 732 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 733 42, 734 ], 735 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 736 }, 737 }, 738}</pre> 739</div> 740 741<div class="method"> 742 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 743 <pre>Updates an existing site. 744 745Args: 746 profileId: string, User profile ID associated with this request. (required) 747 body: object, The request body. 748 The object takes the form of: 749 750{ # Contains properties of a site. 751 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 752 "approved": True or False, # Whether this site is approved. 753 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 754 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 755 "dimensionName": "A String", # The name of the dimension. 756 "etag": "A String", # The eTag of this response for caching purposes. 757 "id": "A String", # The ID associated with the value if available. 758 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 759 "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. 760 "value": "A String", # The value of the dimension. 761 }, 762 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 763 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 764 "dimensionName": "A String", # The name of the dimension. 765 "etag": "A String", # The eTag of this response for caching purposes. 766 "id": "A String", # The ID associated with the value if available. 767 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 768 "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. 769 "value": "A String", # The value of the dimension. 770 }, 771 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 772 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 773 "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. 774 "siteContacts": [ # Site contacts. 775 { # Site Contact 776 "address": "A String", # Address of this site contact. 777 "contactType": "A String", # Site contact type. 778 "email": "A String", # Email address of this site contact. This is a required field. 779 "firstName": "A String", # First name of this site contact. 780 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 781 "lastName": "A String", # Last name of this site contact. 782 "phone": "A String", # Primary phone number of this site contact. 783 "title": "A String", # Title or designation of this site contact. 784 }, 785 ], 786 "siteSettings": { # Site Settings # Site-wide settings. 787 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 788 "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. 789 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 790 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 791 "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. 792 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 793 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 794 "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. 795 }, 796 "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. 797 "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. 798 }, 799 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 800 "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. 801 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 802 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 803 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 804 { # Represents the dimensions of ads, placements, creatives, or creative assets. 805 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 806 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 807 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 808 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 809 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 810 }, 811 ], 812 "imageOnly": True or False, # Whether to serve only static images as companions. 813 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 814 }, 815 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 816 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 817 "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. 818 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 819 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 820 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 821 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 822 }, 823 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. 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 "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. 828 }, 829 "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. 830 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 831 42, 832 ], 833 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 834 }, 835 }, 836} 837 838 x__xgafv: string, V1 error format. 839 Allowed values 840 1 - v1 error format 841 2 - v2 error format 842 843Returns: 844 An object of the form: 845 846 { # Contains properties of a site. 847 "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank. 848 "approved": True or False, # Whether this site is approved. 849 "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion. 850 "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field. 851 "dimensionName": "A String", # The name of the dimension. 852 "etag": "A String", # The eTag of this response for caching purposes. 853 "id": "A String", # The ID associated with the value if available. 854 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 855 "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. 856 "value": "A String", # The value of the dimension. 857 }, 858 "id": "A String", # ID of this site. This is a read-only, auto-generated field. 859 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field. 860 "dimensionName": "A String", # The name of the dimension. 861 "etag": "A String", # The eTag of this response for caching purposes. 862 "id": "A String", # The ID associated with the value if available. 863 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 864 "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. 865 "value": "A String", # The value of the dimension. 866 }, 867 "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field. 868 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site". 869 "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. 870 "siteContacts": [ # Site contacts. 871 { # Site Contact 872 "address": "A String", # Address of this site contact. 873 "contactType": "A String", # Site contact type. 874 "email": "A String", # Email address of this site contact. This is a required field. 875 "firstName": "A String", # First name of this site contact. 876 "id": "A String", # ID of this site contact. This is a read-only, auto-generated field. 877 "lastName": "A String", # Last name of this site contact. 878 "phone": "A String", # Primary phone number of this site contact. 879 "title": "A String", # Title or designation of this site contact. 880 }, 881 ], 882 "siteSettings": { # Site Settings # Site-wide settings. 883 "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site. 884 "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. 885 "disableNewCookie": True or False, # Whether new cookies are disabled for this site. 886 "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags. 887 "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. 888 "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements. 889 "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags. 890 "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. 891 }, 892 "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. 893 "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. 894 }, 895 "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank. 896 "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. 897 "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site. 898 "companionsDisabled": True or False, # Whether companions are disabled for this site template. 899 "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes. 900 { # Represents the dimensions of ads, placements, creatives, or creative assets. 901 "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive. 902 "iab": True or False, # IAB standard size. This is a read-only, auto-generated field. 903 "id": "A String", # ID of this size. This is a read-only, auto-generated field. 904 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". 905 "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive. 906 }, 907 ], 908 "imageOnly": True or False, # Whether to serve only static images as companions. 909 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting". 910 }, 911 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings". 912 "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site. 913 "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. 914 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting". 915 "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true. 916 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 917 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 918 }, 919 "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true. 920 "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. 921 "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. 922 }, 923 "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. 924 }, 925 "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. 926 "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. 927 42, 928 ], 929 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting". 930 }, 931 }, 932}</pre> 933</div> 934 935</body></html>