Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202111.AdUnit Class Reference

An More...

Properties

string id [get, set]
 Uniquely identifies the More...
 
string parentId [get, set]
 The ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only. More...
 
bool hasChildren [get, set]
 This field is set to More...
 
bool hasChildrenSpecified [get, set]
 
AdUnitParent[] parentPath [get, set]
 The path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google. More...
 
string name [get, set]
 The name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique. More...
 
string description [get, set]
 A description of the ad unit. This value is optional and its maximum length is 65,535 characters. More...
 
AdUnitTargetWindow targetWindow [get, set]
 The value to use for the HTML link's More...
 
bool targetWindowSpecified [get, set]
 
InventoryStatus status [get, set]
 The status of this ad unit. It defaults to InventoryStatus::ACTIVE. This value cannot be updated directly using InventoryService::updateAdUnit. It can only be modified by performing actions via InventoryService::performAdUnitAction. More...
 
bool statusSpecified [get, set]
 
string adUnitCode [get, set]
 A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its More...
 
AdUnitSize[] adUnitSizes [get, set]
 The permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the More...
 
bool isInterstitial [get, set]
 Whether this is an interstitial ad unit. More...
 
bool isInterstitialSpecified [get, set]
 
bool isNative [get, set]
 Whether this is a native ad unit. More...
 
bool isNativeSpecified [get, set]
 
bool isFluid [get, set]
 Whether this is a fluid ad unit. More...
 
bool isFluidSpecified [get, set]
 
bool explicitlyTargeted [get, set]
 If this field is set to More...
 
bool explicitlyTargetedSpecified [get, set]
 
AdSenseSettings adSenseSettings [get, set]
 AdSense specific settings. To overwrite this, set the #adSenseSettingsSource to PropertySourceType::DIRECTLY_SPECIFIED when setting the value of this field. More...
 
ValueSourceType adSenseSettingsSource [get, set]
 Specifies the source of #adSenseSettings value. To revert an overridden value to its default, set this field to PropertySourceType::PARENT. More...
 
bool adSenseSettingsSourceSpecified [get, set]
 
LabelFrequencyCap[] appliedLabelFrequencyCaps [get, set]
 The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit. More...
 
LabelFrequencyCap[] effectiveLabelFrequencyCaps [get, set]
 Contains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google. More...
 
AppliedLabel[] appliedLabels [get, set]
 The set of labels applied directly to this ad unit. More...
 
AppliedLabel[] effectiveAppliedLabels [get, set]
 Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google. More...
 
long[] effectiveTeamIds [get, set]
 The IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google. More...
 
long[] appliedTeamIds [get, set]
 The IDs of all teams that this ad unit is on directly. More...
 
DateTime lastModifiedDateTime [get, set]
 The date and time this ad unit was last modified. More...
 
SmartSizeMode smartSizeMode [get, set]
 The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode::NONE for fixed sizes. More...
 
bool smartSizeModeSpecified [get, set]
 
int refreshRate [get, set]
 The interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh. More...
 
bool refreshRateSpecified [get, set]
 
string externalSetTopBoxChannelId [get, set]
 Specifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if #isSetTopBoxEnabled is More...
 
bool isSetTopBoxEnabled [get, set]
 Flag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only. More...
 
bool isSetTopBoxEnabledSpecified [get, set]
 

Detailed Description

An

AdUnit represents a chunk of identified inventory for the publisher. It contains all the settings that need to be associated with inventory in order to serve ads to it. An can also be the parent of other ad units in the inventory hierarchy.

Property Documentation

AdSenseSettings Google.Api.Ads.AdManager.v202111.AdUnit.adSenseSettings
getset

AdSense specific settings. To overwrite this, set the #adSenseSettingsSource to PropertySourceType::DIRECTLY_SPECIFIED when setting the value of this field.

ValueSourceType Google.Api.Ads.AdManager.v202111.AdUnit.adSenseSettingsSource
getset

Specifies the source of #adSenseSettings value. To revert an overridden value to its default, set this field to PropertySourceType::PARENT.

bool Google.Api.Ads.AdManager.v202111.AdUnit.adSenseSettingsSourceSpecified
getset

true, if a value is specified for adSenseSettingsSource, false otherwise.

string Google.Api.Ads.AdManager.v202111.AdUnit.adUnitCode
getset

A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based off of the inventory unit ID. Once an ad unit is created, its

adUnitCode cannot be changed.

AdUnitSize [] Google.Api.Ads.AdManager.v202111.AdUnit.adUnitSizes
getset

The permissible creative sizes that can be served inside this ad unit. This attribute is optional. This attribute replaces the

sizes attribute.

Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202111.CreatePlacements.Run(), and Google.Api.Ads.AdManager.Examples.CSharp.v202111.UpdateAdUnits.Run().

LabelFrequencyCap [] Google.Api.Ads.AdManager.v202111.AdUnit.appliedLabelFrequencyCaps
getset

The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

AppliedLabel [] Google.Api.Ads.AdManager.v202111.AdUnit.appliedLabels
getset

The set of labels applied directly to this ad unit.

long [] Google.Api.Ads.AdManager.v202111.AdUnit.appliedTeamIds
getset

The IDs of all teams that this ad unit is on directly.

string Google.Api.Ads.AdManager.v202111.AdUnit.description
getset

A description of the ad unit. This value is optional and its maximum length is 65,535 characters.

AppliedLabel [] Google.Api.Ads.AdManager.v202111.AdUnit.effectiveAppliedLabels
getset

Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

LabelFrequencyCap [] Google.Api.Ads.AdManager.v202111.AdUnit.effectiveLabelFrequencyCaps
getset

Contains the set of labels applied directly to the ad unit as well as those inherited from parent ad units. This field is readonly and is assigned by Google.

long [] Google.Api.Ads.AdManager.v202111.AdUnit.effectiveTeamIds
getset

The IDs of all teams that this ad unit is on as well as those inherited from parent ad units. This value is read-only and is set by Google.

bool Google.Api.Ads.AdManager.v202111.AdUnit.explicitlyTargeted
getset

If this field is set to

true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an ad unit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.

bool Google.Api.Ads.AdManager.v202111.AdUnit.explicitlyTargetedSpecified
getset

true, if a value is specified for explicitlyTargeted, false otherwise.

string Google.Api.Ads.AdManager.v202111.AdUnit.externalSetTopBoxChannelId
getset

Specifies an ID for a channel in an external set-top box campaign management system. This attribute is only meaningful if #isSetTopBoxEnabled is

true. This attribute is read-only.

bool Google.Api.Ads.AdManager.v202111.AdUnit.hasChildren
getset

This field is set to

true if the ad unit has any children. This attribute is read-only and is populated by Google.

bool Google.Api.Ads.AdManager.v202111.AdUnit.hasChildrenSpecified
getset

true, if a value is specified for hasChildren, false otherwise.

string Google.Api.Ads.AdManager.v202111.AdUnit.id
getset

Uniquely identifies the

AdUnit. This value is read-only and is assigned by Google when an ad unit is created. This attribute is required for updates.

Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202111.CreatePlacements.Run().

bool Google.Api.Ads.AdManager.v202111.AdUnit.isFluid
getset

Whether this is a fluid ad unit.

bool Google.Api.Ads.AdManager.v202111.AdUnit.isFluidSpecified
getset

true, if a value is specified for isFluid, false otherwise.

bool Google.Api.Ads.AdManager.v202111.AdUnit.isInterstitial
getset

Whether this is an interstitial ad unit.

bool Google.Api.Ads.AdManager.v202111.AdUnit.isInterstitialSpecified
getset

true, if a value is specified for isInterstitial, false otherwise.

bool Google.Api.Ads.AdManager.v202111.AdUnit.isNative
getset

Whether this is a native ad unit.

bool Google.Api.Ads.AdManager.v202111.AdUnit.isNativeSpecified
getset

true, if a value is specified for isNative, false otherwise.

bool Google.Api.Ads.AdManager.v202111.AdUnit.isSetTopBoxEnabled
getset

Flag that specifies whether this ad unit represents an external set-top box channel. This attribute is read-only.

bool Google.Api.Ads.AdManager.v202111.AdUnit.isSetTopBoxEnabledSpecified
getset

true, if a value is specified for isSetTopBoxEnabled, false otherwise.

DateTime Google.Api.Ads.AdManager.v202111.AdUnit.lastModifiedDateTime
getset

The date and time this ad unit was last modified.

string Google.Api.Ads.AdManager.v202111.AdUnit.name
getset

The name of the ad unit. This attribute is required and its maximum length is 255 characters. This attribute must also be case-insensitive unique.

string Google.Api.Ads.AdManager.v202111.AdUnit.parentId
getset

The ID of the ad unit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. This attribute is required when creating the ad unit. Once the ad unit is created this value will be read-only.

Referenced by Google.Api.Ads.AdManager.Examples.CSharp.v202111.CreatePlacements.Run().

AdUnitParent [] Google.Api.Ads.AdManager.v202111.AdUnit.parentPath
getset

The path to this ad unit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty. This attribute is read-only and is populated by Google.

int Google.Api.Ads.AdManager.v202111.AdUnit.refreshRate
getset

The interval in seconds which ad units in mobile apps automatically refresh. Valid values are between 30 and 120 seconds. This attribute is optional and only applies to ad units in mobile apps. If this value is not set, then the mobile app ad will not refresh.

bool Google.Api.Ads.AdManager.v202111.AdUnit.refreshRateSpecified
getset

true, if a value is specified for refreshRate, false otherwise.

SmartSizeMode Google.Api.Ads.AdManager.v202111.AdUnit.smartSizeMode
getset

The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode::NONE for fixed sizes.

bool Google.Api.Ads.AdManager.v202111.AdUnit.smartSizeModeSpecified
getset

true, if a value is specified for smartSizeMode, false otherwise.

InventoryStatus Google.Api.Ads.AdManager.v202111.AdUnit.status
getset

The status of this ad unit. It defaults to InventoryStatus::ACTIVE. This value cannot be updated directly using InventoryService::updateAdUnit. It can only be modified by performing actions via InventoryService::performAdUnitAction.

bool Google.Api.Ads.AdManager.v202111.AdUnit.statusSpecified
getset

true, if a value is specified for status, false otherwise.

AdUnitTargetWindow Google.Api.Ads.AdManager.v202111.AdUnit.targetWindow
getset

The value to use for the HTML link's

target attribute. This value is optional and will be interpreted as TargetWindow::TOP if left blank.

bool Google.Api.Ads.AdManager.v202111.AdUnit.targetWindowSpecified
getset

true, if a value is specified for targetWindow, false otherwise.


The documentation for this class was generated from the following file: