Ads API .NET library
|
Represents an ad group. More...
Classes | |
class | Fields |
List of all supported fields for the AdGroup class. More... | |
class | FilterableFields |
List of all supported filterable fields for the AdGroup class. More... | |
class | SelectableFields |
List of all supported selectable fields for the AdGroup class. More... | |
Properties | |
long | id [get, set] |
ID of this ad group. This field can be selected using the value "Id".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD. This field is required and should not be More... | |
bool | idSpecified [get, set] |
long | campaignId [get, set] |
ID of the campaign with which this ad group is associated. This field can be selected using the value "CampaignId".This field can be filtered on. This field is required and should not be More... | |
bool | campaignIdSpecified [get, set] |
string | campaignName [get, set] |
Name of the campaign with which this ad group is associated. This field can be selected using the value "CampaignName".This field can be filtered on. This field is read only and will be ignored when sent to the API. More... | |
string | name [get, set] |
Name of this ad group (at most 255 UTF-8 full-width characters). This field is required and should not be More... | |
AdGroupStatus | status [get, set] |
Status of this ad group. This field can be selected using the value "Status".This field can be filtered on. More... | |
bool | statusSpecified [get, set] |
Setting[] | settings [get, set] |
List of settings for the AdGroup. This field can be selected using the value "Settings". More... | |
Label[] | labels [get, set] |
Labels that are attached to the AdGroup. To associate an existing Label to an existing AdGroup, use AdGroupService::mutateLabel with ADD operator. To remove an associated Label from the AdGroup, use AdGroupService::mutateLabel with REMOVE operator. To filter on Labels, use one of Predicate.Operator::CONTAINS_ALL, Predicate.Operator::CONTAINS_ANY, Predicate.Operator::CONTAINS_NONE operators with a list of Label ids. This field can be selected using the value "Labels".This field can be filtered on. This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET. More... | |
String_StringMapEntry[] | forwardCompatibilityMap [get, set] |
This Map provides a place to put new features and settings in older versions of the AdWords API in the rare instance we need to introduce a new feature in an older version. It is presently unused. Do not set a value. More... | |
BiddingStrategyConfiguration | biddingStrategyConfiguration [get, set] |
Bidding configuration for this ad group. To set the bids on the ad groups use BiddingStrategyConfiguration::bids. Multiple bids can be set on ad group at the same time. Only the bids that apply to the effective bidding strategy will be used. Effective bidding strategy is considered to be the directly attached strategy or inherited campaign level strategy when there?s no directly attached strategy. More... | |
CriterionTypeGroup | contentBidCriterionTypeGroup [get, set] |
Allows advertisers to specify a criteria dimension on which to place absolute bids. This is only applicable for campaigns that target only the content network and not search. This field can be selected using the value "ContentBidCriterionTypeGroup".This field can be filtered on. More... | |
bool | contentBidCriterionTypeGroupSpecified [get, set] |
long | baseCampaignId [get, set] |
ID of the base campaign from which this draft/trial adgroup was created. This field is only returned on get requests. This field can be selected using the value "BaseCampaignId". This field is read only and will be ignored when sent to the API. More... | |
bool | baseCampaignIdSpecified [get, set] |
long | baseAdGroupId [get, set] |
ID of the base adgroup from which this draft/trial adgroup was created. For base adgroups this is equal to the adgroup ID. If the adgroup was created in the draft or trial and has no corresponding base adgroup, this field is null. This field is readonly and will be ignored when sent to the API. This field can be selected using the value "BaseAdGroupId". More... | |
bool | baseAdGroupIdSpecified [get, set] |
string | trackingUrlTemplate [get, set] |
URL template for constructing a tracking URL. More... | |
string | finalUrlSuffix [get, set] |
URL template for appending params to Final URL. More... | |
CustomParameters | urlCustomParameters [get, set] |
A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. This field can be selected using the value "UrlCustomParameters". This field may not be set for campaign channel type MULTI_CHANNEL. More... | |
AdGroupType | adGroupType [get, set] |
This field can be selected using the value "AdGroupType".This field can be filtered on. This field may only be set to SHOPPING_GOAL_OPTIMIZED_ADS for campaign channel type SHOPPING with campaign channel subtype SHOPPING_GOAL_OPTIMIZED_ADS. This field is read only and will be ignored when sent to the API for the following Operators: SET. More... | |
bool | adGroupTypeSpecified [get, set] |
AdGroupAdRotationMode | adGroupAdRotationMode [get, set] |
The ad rotation mode to specify how often the ads in the ad group will be served relative to one another. More... | |
Represents an ad group.
|
getset |
The ad rotation mode to specify how often the ads in the ad group will be served relative to one another.
|
getset |
This field can be selected using the value "AdGroupType".This field can be filtered on. This field may only be set to SHOPPING_GOAL_OPTIMIZED_ADS for campaign channel type SHOPPING with campaign channel subtype SHOPPING_GOAL_OPTIMIZED_ADS. This field is read only and will be ignored when sent to the API for the following Operators: SET.
|
getset |
true
, if a value is specified for adGroupType, false
otherwise.
|
getset |
ID of the base adgroup from which this draft/trial adgroup was created. For base adgroups this is equal to the adgroup ID. If the adgroup was created in the draft or trial and has no corresponding base adgroup, this field is null. This field is readonly and will be ignored when sent to the API. This field can be selected using the value "BaseAdGroupId".
|
getset |
true
, if a value is specified for baseAdGroupId, false
otherwise.
|
getset |
ID of the base campaign from which this draft/trial adgroup was created. This field is only returned on get requests. This field can be selected using the value "BaseCampaignId". This field is read only and will be ignored when sent to the API.
|
getset |
true
, if a value is specified for baseCampaignId, false
otherwise.
|
getset |
Bidding configuration for this ad group. To set the bids on the ad groups use BiddingStrategyConfiguration::bids. Multiple bids can be set on ad group at the same time. Only the bids that apply to the effective bidding strategy will be used. Effective bidding strategy is considered to be the directly attached strategy or inherited campaign level strategy when there?s no directly attached strategy.
|
getset |
ID of the campaign with which this ad group is associated. This field can be selected using the value "CampaignId".This field can be filtered on. This field is required and should not be
null
when it is contained within Operators : ADD.
|
getset |
true
, if a value is specified for campaignId, false
otherwise.
|
getset |
Name of the campaign with which this ad group is associated. This field can be selected using the value "CampaignName".This field can be filtered on. This field is read only and will be ignored when sent to the API.
|
getset |
Allows advertisers to specify a criteria dimension on which to place absolute bids. This is only applicable for campaigns that target only the content network and not search. This field can be selected using the value "ContentBidCriterionTypeGroup".This field can be filtered on.
|
getset |
true
, if a value is specified for contentBidCriterionTypeGroup, false
otherwise.
|
getset |
URL template for appending params to Final URL.
On update, empty string ("") indicates to clear the field. This field can be selected using the value "FinalUrlSuffix".This field can be filtered on. This field may not be set for campaign channel type MULTI_CHANNEL.
|
getset |
This Map provides a place to put new features and settings in older versions of the AdWords API in the rare instance we need to introduce a new feature in an older version. It is presently unused. Do not set a value.
|
getset |
ID of this ad group. This field can be selected using the value "Id".This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: ADD. This field is required and should not be
null
when it is contained within Operators : SET.
Referenced by Google.Api.Ads.AdWords.Examples.CSharp.v201809.AddDynamicSearchAdsCampaign.Run(), Google.Api.Ads.AdWords.Examples.CSharp.v201809.AddSmartShoppingAd.Run(), Google.Api.Ads.AdWords.Examples.CSharp.v201809.AddCompleteCampaignsUsingBatchJob.Run(), and Google.Api.Ads.AdWords.Examples.CSharp.v201809.AddCompleteCampaignsUsingStreamingBatchJob.Run().
|
getset |
true
, if a value is specified for id, false
otherwise.
|
getset |
Labels that are attached to the AdGroup. To associate an existing Label to an existing AdGroup, use AdGroupService::mutateLabel with ADD operator. To remove an associated Label from the AdGroup, use AdGroupService::mutateLabel with REMOVE operator. To filter on Labels, use one of Predicate.Operator::CONTAINS_ALL, Predicate.Operator::CONTAINS_ANY, Predicate.Operator::CONTAINS_NONE operators with a list of Label ids. This field can be selected using the value "Labels".This field can be filtered on. This field may not be set for campaign channel subtype UNIVERSAL_APP_CAMPAIGN. This field is read only and will be ignored when sent to the API for the following Operators: REMOVE and SET.
|
getset |
Name of this ad group (at most 255 UTF-8 full-width characters). This field is required and should not be
null
for ADD operations from v201309 version. This field can be selected using the value "Name".This field can be filtered on. AdGroup names must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters. This is checked by the regular expression '[^]*'.
|
getset |
List of settings for the AdGroup. This field can be selected using the value "Settings".
|
getset |
Status of this ad group. This field can be selected using the value "Status".This field can be filtered on.
|
getset |
true
, if a value is specified for status, false
otherwise.
|
getset |
URL template for constructing a tracking URL.
On update, empty string ("") indicates to clear the field. This field can be selected using the value "TrackingUrlTemplate".This field can be filtered on. This field may not be set for campaign channel type MULTI_CHANNEL.
|
getset |
A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls. This field can be selected using the value "UrlCustomParameters". This field may not be set for campaign channel type MULTI_CHANNEL.