get(profileId, id, x__xgafv=None)

Gets one site by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Site ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a site.
  "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
  "approved": True or False, # Whether this site is approved.
  "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
  "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "id": "A String", # ID of this site. This is a read-only, auto-generated field.
  "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
  "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.
  "siteContacts": [ # Site contacts.
    { # Site Contact
      "address": "A String", # Address of this site contact.
      "contactType": "A String", # Site contact type.
      "email": "A String", # Email address of this site contact. This is a required field.
      "firstName": "A String", # First name of this site contact.
      "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      "lastName": "A String", # Last name of this site contact.
      "phone": "A String", # Primary phone number of this site contact.
      "title": "A String", # Title or designation of this site contact.
    },
  ],
  "siteSettings": { # Site Settings # Site-wide settings.
    "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
    "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.
    "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
    "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "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.
    },
    "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.
    "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.
  },
  "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
  "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.
    "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
      "companionsDisabled": True or False, # Whether companions are disabled for this site template.
      "enabledSizes": [ # Allowlist 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.
          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
          "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
        },
      ],
      "imageOnly": True or False, # Whether to serve only static images as companions.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
    },
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
    "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
    "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
      "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
      "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
      "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
      "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
      "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
        "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.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
      },
      "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
      "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
    },
    "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
    "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
    "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.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
      "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.
      },
      "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.
      },
      "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.
    },
    "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.
      "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
        42,
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
    },
  },
}

insert(profileId, body=None, x__xgafv=None)

Inserts a new site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a site.
  "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
  "approved": True or False, # Whether this site is approved.
  "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
  "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "id": "A String", # ID of this site. This is a read-only, auto-generated field.
  "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
  "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.
  "siteContacts": [ # Site contacts.
    { # Site Contact
      "address": "A String", # Address of this site contact.
      "contactType": "A String", # Site contact type.
      "email": "A String", # Email address of this site contact. This is a required field.
      "firstName": "A String", # First name of this site contact.
      "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      "lastName": "A String", # Last name of this site contact.
      "phone": "A String", # Primary phone number of this site contact.
      "title": "A String", # Title or designation of this site contact.
    },
  ],
  "siteSettings": { # Site Settings # Site-wide settings.
    "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
    "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.
    "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
    "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "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.
    },
    "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.
    "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.
  },
  "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
  "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.
    "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
      "companionsDisabled": True or False, # Whether companions are disabled for this site template.
      "enabledSizes": [ # Allowlist 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.
          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
          "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
        },
      ],
      "imageOnly": True or False, # Whether to serve only static images as companions.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
    },
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
    "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
    "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
      "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
      "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
      "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
      "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
      "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
        "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.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
      },
      "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
      "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
    },
    "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
    "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
    "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.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
      "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.
      },
      "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.
      },
      "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.
    },
    "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.
      "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
        42,
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a site.
  "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
  "approved": True or False, # Whether this site is approved.
  "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
  "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "id": "A String", # ID of this site. This is a read-only, auto-generated field.
  "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
  "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.
  "siteContacts": [ # Site contacts.
    { # Site Contact
      "address": "A String", # Address of this site contact.
      "contactType": "A String", # Site contact type.
      "email": "A String", # Email address of this site contact. This is a required field.
      "firstName": "A String", # First name of this site contact.
      "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      "lastName": "A String", # Last name of this site contact.
      "phone": "A String", # Primary phone number of this site contact.
      "title": "A String", # Title or designation of this site contact.
    },
  ],
  "siteSettings": { # Site Settings # Site-wide settings.
    "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
    "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.
    "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
    "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "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.
    },
    "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.
    "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.
  },
  "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
  "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.
    "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
      "companionsDisabled": True or False, # Whether companions are disabled for this site template.
      "enabledSizes": [ # Allowlist 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.
          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
          "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
        },
      ],
      "imageOnly": True or False, # Whether to serve only static images as companions.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
    },
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
    "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
    "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
      "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
      "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
      "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
      "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
      "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
        "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.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
      },
      "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
      "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
    },
    "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
    "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
    "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.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
      "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.
      },
      "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.
      },
      "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.
    },
    "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.
      "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
        42,
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
    },
  },
}

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)

Retrieves a list of sites, possibly filtered. This method supports paging.

Args:
  profileId: string, User profile ID associated with this request. (required)
  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
  acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
  adWordsSite: boolean, Select only AdWords sites.
  approved: boolean, Select only approved sites.
  campaignIds: string, Select only sites with these campaign IDs. (repeated)
  directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
  ids: string, Select only sites with these IDs. (repeated)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Value of the nextPageToken from the previous result page.
  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".
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  subaccountId: string, Select only sites with this subaccount ID.
  unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Site List Response
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
  "nextPageToken": "A String", # Pagination token to be used for the next list operation.
  "sites": [ # Site collection.
    { # Contains properties of a site.
      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
      "approved": True or False, # Whether this site is approved.
      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "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.
        "value": "A String", # The value of the dimension.
      },
      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
        "dimensionName": "A String", # The name of the dimension.
        "etag": "A String", # The eTag of this response for caching purposes.
        "id": "A String", # The ID associated with the value if available.
        "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
        "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.
        "value": "A String", # The value of the dimension.
      },
      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
      "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.
      "siteContacts": [ # Site contacts.
        { # Site Contact
          "address": "A String", # Address of this site contact.
          "contactType": "A String", # Site contact type.
          "email": "A String", # Email address of this site contact. This is a required field.
          "firstName": "A String", # First name of this site contact.
          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
          "lastName": "A String", # Last name of this site contact.
          "phone": "A String", # Primary phone number of this site contact.
          "title": "A String", # Title or designation of this site contact.
        },
      ],
      "siteSettings": { # Site Settings # Site-wide settings.
        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
        "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.
        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
          "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.
        },
        "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.
        "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.
      },
      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
      "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.
        "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
          "companionsDisabled": True or False, # Whether companions are disabled for this site template.
          "enabledSizes": [ # Allowlist 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.
              "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
              "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.
              "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
              "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
            },
          ],
          "imageOnly": True or False, # Whether to serve only static images as companions.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
        },
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
        "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
        "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
          "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
          "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
          "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
          "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
          "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
            "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
            "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.
            "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
            "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
          },
          "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
          "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
        },
        "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
        "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
        "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
          "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.
          },
          "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.
          },
          "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.
        },
        "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.
          "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
            42,
          ],
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
        },
      },
    },
  ],
}

list_next()

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=None, x__xgafv=None)

Updates an existing site. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Required. Site ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a site.
  "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
  "approved": True or False, # Whether this site is approved.
  "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
  "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "id": "A String", # ID of this site. This is a read-only, auto-generated field.
  "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
  "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.
  "siteContacts": [ # Site contacts.
    { # Site Contact
      "address": "A String", # Address of this site contact.
      "contactType": "A String", # Site contact type.
      "email": "A String", # Email address of this site contact. This is a required field.
      "firstName": "A String", # First name of this site contact.
      "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      "lastName": "A String", # Last name of this site contact.
      "phone": "A String", # Primary phone number of this site contact.
      "title": "A String", # Title or designation of this site contact.
    },
  ],
  "siteSettings": { # Site Settings # Site-wide settings.
    "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
    "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.
    "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
    "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "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.
    },
    "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.
    "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.
  },
  "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
  "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.
    "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
      "companionsDisabled": True or False, # Whether companions are disabled for this site template.
      "enabledSizes": [ # Allowlist 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.
          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
          "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
        },
      ],
      "imageOnly": True or False, # Whether to serve only static images as companions.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
    },
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
    "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
    "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
      "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
      "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
      "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
      "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
      "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
        "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.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
      },
      "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
      "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
    },
    "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
    "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
    "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.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
      "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.
      },
      "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.
      },
      "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.
    },
    "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.
      "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
        42,
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a site.
  "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
  "approved": True or False, # Whether this site is approved.
  "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
  "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "id": "A String", # ID of this site. This is a read-only, auto-generated field.
  "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
  "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.
  "siteContacts": [ # Site contacts.
    { # Site Contact
      "address": "A String", # Address of this site contact.
      "contactType": "A String", # Site contact type.
      "email": "A String", # Email address of this site contact. This is a required field.
      "firstName": "A String", # First name of this site contact.
      "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      "lastName": "A String", # Last name of this site contact.
      "phone": "A String", # Primary phone number of this site contact.
      "title": "A String", # Title or designation of this site contact.
    },
  ],
  "siteSettings": { # Site Settings # Site-wide settings.
    "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
    "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.
    "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
    "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "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.
    },
    "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.
    "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.
  },
  "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
  "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.
    "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
      "companionsDisabled": True or False, # Whether companions are disabled for this site template.
      "enabledSizes": [ # Allowlist 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.
          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
          "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
        },
      ],
      "imageOnly": True or False, # Whether to serve only static images as companions.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
    },
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
    "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
    "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
      "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
      "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
      "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
      "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
      "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
        "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.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
      },
      "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
      "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
    },
    "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
    "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
    "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.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
      "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.
      },
      "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.
      },
      "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.
    },
    "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.
      "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
        42,
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
    },
  },
}

update(profileId, body=None, x__xgafv=None)

Updates an existing site.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a site.
  "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
  "approved": True or False, # Whether this site is approved.
  "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
  "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "id": "A String", # ID of this site. This is a read-only, auto-generated field.
  "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
  "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.
  "siteContacts": [ # Site contacts.
    { # Site Contact
      "address": "A String", # Address of this site contact.
      "contactType": "A String", # Site contact type.
      "email": "A String", # Email address of this site contact. This is a required field.
      "firstName": "A String", # First name of this site contact.
      "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      "lastName": "A String", # Last name of this site contact.
      "phone": "A String", # Primary phone number of this site contact.
      "title": "A String", # Title or designation of this site contact.
    },
  ],
  "siteSettings": { # Site Settings # Site-wide settings.
    "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
    "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.
    "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
    "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "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.
    },
    "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.
    "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.
  },
  "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
  "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.
    "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
      "companionsDisabled": True or False, # Whether companions are disabled for this site template.
      "enabledSizes": [ # Allowlist 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.
          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
          "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
        },
      ],
      "imageOnly": True or False, # Whether to serve only static images as companions.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
    },
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
    "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
    "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
      "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
      "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
      "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
      "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
      "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
        "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.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
      },
      "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
      "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
    },
    "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
    "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
    "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.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
      "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.
      },
      "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.
      },
      "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.
    },
    "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.
      "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
        42,
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a site.
  "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
  "approved": True or False, # Whether this site is approved.
  "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
  "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "id": "A String", # ID of this site. This is a read-only, auto-generated field.
  "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
    "dimensionName": "A String", # The name of the dimension.
    "etag": "A String", # The eTag of this response for caching purposes.
    "id": "A String", # The ID associated with the value if available.
    "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
    "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.
    "value": "A String", # The value of the dimension.
  },
  "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
  "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
  "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.
  "siteContacts": [ # Site contacts.
    { # Site Contact
      "address": "A String", # Address of this site contact.
      "contactType": "A String", # Site contact type.
      "email": "A String", # Email address of this site contact. This is a required field.
      "firstName": "A String", # First name of this site contact.
      "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
      "lastName": "A String", # Last name of this site contact.
      "phone": "A String", # Primary phone number of this site contact.
      "title": "A String", # Title or designation of this site contact.
    },
  ],
  "siteSettings": { # Site Settings # Site-wide settings.
    "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
    "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.
    "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
    "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight 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.
      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
      "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.
    },
    "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.
    "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.
  },
  "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
  "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.
    "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
      "companionsDisabled": True or False, # Whether companions are disabled for this site template.
      "enabledSizes": [ # Allowlist 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.
          "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
          "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.
          "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
          "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
        },
      ],
      "imageOnly": True or False, # Whether to serve only static images as companions.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
    },
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
    "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
    "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
      "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
      "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
      "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
      "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
      "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
        "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
        "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.
        "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
        "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
      },
      "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
      "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
    },
    "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
    "publisherSpecificationId": "A String", # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
    "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.
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
      "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.
      },
      "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.
      },
      "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.
    },
    "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.
      "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
        42,
      ],
      "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
    },
  },
}

Campaign Manager 360 API . sites

Instance Methods

Method Details