Gets one site by ID.
Inserts a new site.
Retrieves a list of sites, possibly filtered. This method supports paging.
list_next(previous_request, previous_response)
Retrieves the next page of results.
Updates an existing site. This method supports patch semantics.
Updates an existing site.
get(profileId, id)
Gets one site by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Site ID. (required)
Returns:
An object of the form:
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
}
insert(profileId, body)
Inserts a new site.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
}
Returns:
An object of the form:
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
}
list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)
Retrieves a list of sites, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
campaignIds: string, Select only sites with these campaign IDs. (repeated)
acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
pageToken: string, Value of the nextPageToken from the previous result page.
acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
maxResults: integer, Maximum number of results to return.
adWordsSite: boolean, Select only AdWords sites.
approved: boolean, Select only approved sites.
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".
subaccountId: string, Select only sites with this subaccount ID.
directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
ids: string, Select only sites with these IDs. (repeated)
Returns:
An object of the form:
{ # Site List Response
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
"sites": [ # Site collection.
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(profileId, id, body)
Updates an existing site. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Site ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
}
Returns:
An object of the form:
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
}
update(profileId, body)
Updates an existing site.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
}
Returns:
An object of the form:
{ # Contains properties of a site.
"kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"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.
"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.
"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.
"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.
"kind": "dfareporting#siteSkippableSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
},
"kind": "dfareporting#siteVideoSettings", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"kind": "dfareporting#siteCompanionSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"imageOnly": True or False, # Whether to serve only static images as companions.
"enabledSizes": [ # Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
"kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
},
],
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"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.
"kind": "dfareporting#siteTranscodeSetting", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
"enabledVideoFormats": [ # Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
},
},
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"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.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"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.
"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.
},
"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.
"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.
},
"approved": True or False, # Whether this site is approved.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"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.
"id": "A String", # The ID associated with the value if available.
},
"siteContacts": [ # Site contacts.
{ # Site Contact
"firstName": "A String", # First name of this site contact.
"title": "A String", # Title or designation of this site contact.
"lastName": "A String", # Last name of this site contact.
"address": "A String", # Address of this site contact.
"email": "A String", # Email address of this site contact. This is a required field.
"phone": "A String", # Primary phone number of this site contact.
"contactType": "A String", # Site contact type.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
},
],
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
}