Resource: Site
Contains properties of a site.
JSON representation |
---|
{ "id": string, "keyName": string, "name": string, "accountId": string, "subaccountId": string, "approved": boolean, "siteSettings": { object ( |
Fields | |
---|---|
id |
ID of this site. This is a read-only, auto-generated field. |
keyName |
Key name of this site. This is a read-only, auto-generated field. |
name |
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. |
accountId |
Account ID of this site. This is a read-only field that can be left blank. |
subaccountId |
Subaccount ID of this site. This is a read-only field that can be left blank. |
approved |
Whether this site is approved. |
siteSettings |
Site-wide settings. |
siteContacts[] |
Site contacts. |
directorySiteId |
Directory site associated with this site. This is a required field that is read-only after insertion. |
idDimensionValue |
Dimension value for the ID of this site. This is a read-only, auto-generated field. |
directorySiteIdDimensionValue |
Dimension value for the ID of the directory site. This is a read-only, auto-generated field. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
videoSettings |
Default video settings for new placements created under this site. This value will be used to populate the
field, when no value is specified for the new placement. |
SiteSettings
Site Settings
JSON representation |
---|
{ "disableNewCookie": boolean, "tagSetting": { object ( |
Fields | |
---|---|
disableNewCookie |
Whether new cookies are disabled for this site. |
tagSetting |
Configuration settings for dynamic and image floodlight tags. |
activeViewOptOut |
Whether active view creatives are disabled for this site. |
adBlockingOptOut |
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. |
videoActiveViewOptOutTemplate |
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
field, when no value is specified for the new placement. |
vpaidAdapterChoiceTemplate |
Default VPAID adapter setting for new placements created under this site. This value will be used to populate the
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).
when the following values are provided:
,
. |
VpaidAdapterChoiceTemplate
Enums | |
---|---|
DEFAULT |
|
FLASH |
|
HTML5 |
|
BOTH |
SiteContact
Site Contact
JSON representation |
---|
{
"id": string,
"contactType": enum ( |
Fields | |
---|---|
id |
ID of this site contact. This is a read-only, auto-generated field. |
contactType |
Site contact type. |
email |
Email address of this site contact. This is a required field. |
firstName |
First name of this site contact. |
lastName |
Last name of this site contact. |
title |
Title or designation of this site contact. |
address |
Address of this site contact. |
phone |
Primary phone number of this site contact. |
ContactType
Enums | |
---|---|
SALES_PERSON |
|
TRAFFICKER |
SiteVideoSettings
Video Settings
JSON representation |
---|
{ "companionSettings": { object ( |
Fields | |
---|---|
companionSettings |
Settings for the companion creatives of video creatives served to this site. |
transcodeSettings |
Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site. |
skippableSettings |
Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site. |
orientation |
Orientation of a site template used for video. This will act as default for new placements created under this site. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
obaSettings |
Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site. |
obaEnabled |
Whether OBA icons are enabled for this placement. |
SiteCompanionSetting
Companion Settings
JSON representation |
---|
{
"companionsDisabled": boolean,
"enabledSizes": [
{
object ( |
Fields | |
---|---|
companionsDisabled |
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. |
imageOnly |
Whether to serve only static images as companions. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
SiteTranscodeSetting
Transcode Settings
JSON representation |
---|
{ "enabledVideoFormats": [ integer ], "kind": string } |
Fields | |
---|---|
enabledVideoFormats[] |
Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
SiteSkippableSetting
Skippable Settings
JSON representation |
---|
{ "skippable": boolean, "skipOffset": { object ( |
Fields | |
---|---|
skippable |
Whether the user can skip creatives served to this site. This will act as default for new placements created under this site. |
skipOffset |
Amount of time to play videos served to this site before the skip button should appear. Applicable when
is true. |
progressOffset |
Amount of time to play videos served to this site template before counting a view. Applicable when
is true. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
Orientation
Enums | |
---|---|
ANY |
|
LANDSCAPE |
|
PORTRAIT |
Methods |
|
---|---|
|
Gets one site by ID. |
|
Inserts a new site. |
|
Retrieves a list of sites, possibly filtered. |
|
Updates an existing site. |
|
Updates an existing site. |