Class GoogleAdsSearchads360V23ResourcesAdGroup

An ad group.

Inheritance
object
GoogleAdsSearchads360V23ResourcesAdGroup
Implements
Inherited Members
Namespace: Google.Apis.SA360.v23.Data
Assembly: Google.Apis.SA360.v23.dll
Syntax
public class GoogleAdsSearchads360V23ResourcesAdGroup : IDirectResponseSchema

Properties

AdRotationMode

The ad rotation mode of the ad group.

Declaration
[JsonProperty("adRotationMode")]
public virtual string AdRotationMode { get; set; }
Property Value
Type Description
string

AiMaxAdGroupSetting

Settings for AI Max feature in standard search adgroups.

Declaration
[JsonProperty("aiMaxAdGroupSetting")]
public virtual GoogleAdsSearchads360V23ResourcesAdGroupAiMaxAdGroupSetting AiMaxAdGroupSetting { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ResourcesAdGroupAiMaxAdGroupSetting

AudienceSetting

Immutable. Setting for audience related features.

Declaration
[JsonProperty("audienceSetting")]
public virtual GoogleAdsSearchads360V23ResourcesAdGroupAudienceSetting AudienceSetting { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ResourcesAdGroupAudienceSetting

BaseAdGroup

Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.

Declaration
[JsonProperty("baseAdGroup")]
public virtual string BaseAdGroup { get; set; }
Property Value
Type Description
string

Campaign

Immutable. The campaign to which the ad group belongs.

Declaration
[JsonProperty("campaign")]
public virtual string Campaign { get; set; }
Property Value
Type Description
string

CpcBidMicros

The maximum CPC (cost-per-click) bid. This field is used when the ad group's effective bidding strategy is Manual CPC. This field is not applicable and will be ignored if the ad group's campaign is using a portfolio bidding strategy.

Declaration
[JsonProperty("cpcBidMicros")]
public virtual long? CpcBidMicros { get; set; }
Property Value
Type Description
long?

CpmBidMicros

The maximum CPM (cost-per-thousand viewable impressions) bid.

Declaration
[JsonProperty("cpmBidMicros")]
public virtual long? CpmBidMicros { get; set; }
Property Value
Type Description
long?

CpvBidMicros

The CPV (cost-per-view) bid.

Declaration
[JsonProperty("cpvBidMicros")]
public virtual long? CpvBidMicros { get; set; }
Property Value
Type Description
long?

CreationTime

Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

Declaration
[JsonProperty("creationTime")]
public virtual string CreationTime { get; set; }
Property Value
Type Description
string

DemandGenAdGroupSettings

Settings for Demand Gen ad groups.

Declaration
[JsonProperty("demandGenAdGroupSettings")]
public virtual GoogleAdsSearchads360V23ResourcesAdGroupDemandGenAdGroupSettings DemandGenAdGroupSettings { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ResourcesAdGroupDemandGenAdGroupSettings

DisplayCustomBidDimension

Lets advertisers specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.

Declaration
[JsonProperty("displayCustomBidDimension")]
public virtual string DisplayCustomBidDimension { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EffectiveCpcBidMicros

Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.

Declaration
[JsonProperty("effectiveCpcBidMicros")]
public virtual long? EffectiveCpcBidMicros { get; set; }
Property Value
Type Description
long?

EffectiveLabels

Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group.

Declaration
[JsonProperty("effectiveLabels")]
public virtual IList<string> EffectiveLabels { get; set; }
Property Value
Type Description
IList<string>

EffectiveTargetCpaMicros

Output only. The effective target CPA (cost-per-acquisition). This field is read-only.

Declaration
[JsonProperty("effectiveTargetCpaMicros")]
public virtual long? EffectiveTargetCpaMicros { get; set; }
Property Value
Type Description
long?

EffectiveTargetCpaSource

Output only. Source of the effective target CPA. This field is read-only.

Declaration
[JsonProperty("effectiveTargetCpaSource")]
public virtual string EffectiveTargetCpaSource { get; set; }
Property Value
Type Description
string

EffectiveTargetCpc

Output only. The effective target CPC (cost-per-click). This field is read-only.

Declaration
[JsonProperty("effectiveTargetCpc")]
public virtual long? EffectiveTargetCpc { get; set; }
Property Value
Type Description
long?

EffectiveTargetCpcSource

Output only. Source of the effective target CPC. This field is read-only.

Declaration
[JsonProperty("effectiveTargetCpcSource")]
public virtual string EffectiveTargetCpcSource { get; set; }
Property Value
Type Description
string

EffectiveTargetRoas

Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.

Declaration
[JsonProperty("effectiveTargetRoas")]
public virtual double? EffectiveTargetRoas { get; set; }
Property Value
Type Description
double?

EffectiveTargetRoasSource

Output only. Source of the effective target ROAS. This field is read-only.

Declaration
[JsonProperty("effectiveTargetRoasSource")]
public virtual string EffectiveTargetRoasSource { get; set; }
Property Value
Type Description
string

EndDate

Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14

Declaration
[JsonProperty("endDate")]
public virtual string EndDate { get; set; }
Property Value
Type Description
string

EngineId

Output only. ID of the ad group in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group.id" instead.

Declaration
[JsonProperty("engineId")]
public virtual string EngineId { get; set; }
Property Value
Type Description
string

EngineStatus

Output only. The Engine Status for ad group.

Declaration
[JsonProperty("engineStatus")]
public virtual string EngineStatus { get; set; }
Property Value
Type Description
string

ExcludeDemographicExpansion

When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.

Declaration
[JsonProperty("excludeDemographicExpansion")]
public virtual bool? ExcludeDemographicExpansion { get; set; }
Property Value
Type Description
bool?

ExcludedParentAssetFieldTypes

The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.

Declaration
[JsonProperty("excludedParentAssetFieldTypes")]
public virtual IList<string> ExcludedParentAssetFieldTypes { get; set; }
Property Value
Type Description
IList<string>

ExcludedParentAssetSetTypes

The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.

Declaration
[JsonProperty("excludedParentAssetSetTypes")]
public virtual IList<string> ExcludedParentAssetSetTypes { get; set; }
Property Value
Type Description
IList<string>

FinalUrlSuffix

URL template for appending params to Final URL.

Declaration
[JsonProperty("finalUrlSuffix")]
public virtual string FinalUrlSuffix { get; set; }
Property Value
Type Description
string

FixedCpmMicros

The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.

Declaration
[JsonProperty("fixedCpmMicros")]
public virtual long? FixedCpmMicros { get; set; }
Property Value
Type Description
long?

Id

Output only. The ID of the ad group.

Declaration
[JsonProperty("id")]
public virtual long? Id { get; set; }
Property Value
Type Description
long?

Labels

Output only. The resource names of labels attached to this ad group.

Declaration
[JsonProperty("labels")]
public virtual IList<string> Labels { get; set; }
Property Value
Type Description
IList<string>

LanguageCode

Output only. The language of the ads and keywords in an ad group. This field is only available for Microsoft Advertising accounts. More details: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage

Declaration
[JsonProperty("languageCode")]
public virtual string LanguageCode { get; set; }
Property Value
Type Description
string

LastModifiedTime

Output only. The datetime when this ad group was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

Declaration
[JsonProperty("lastModifiedTime")]
public virtual string LastModifiedTime { get; set; }
Property Value
Type Description
string

Name

The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

OptimizedTargetingEnabled

True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.

Declaration
[JsonProperty("optimizedTargetingEnabled")]
public virtual bool? OptimizedTargetingEnabled { get; set; }
Property Value
Type Description
bool?

PercentCpcBidMicros

The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].

Declaration
[JsonProperty("percentCpcBidMicros")]
public virtual long? PercentCpcBidMicros { get; set; }
Property Value
Type Description
long?

PrimaryStatus

Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.

Declaration
[JsonProperty("primaryStatus")]
public virtual string PrimaryStatus { get; set; }
Property Value
Type Description
string

PrimaryStatusReasons

Output only. Provides reasons for why an ad group is not serving or not serving optimally.

Declaration
[JsonProperty("primaryStatusReasons")]
public virtual IList<string> PrimaryStatusReasons { get; set; }
Property Value
Type Description
IList<string>

ResourceName

Immutable. The resource name of the ad group. Ad group resource names have the form: customers/{customer_id}/adGroups/{ad_group_id}

Declaration
[JsonProperty("resourceName")]
public virtual string ResourceName { get; set; }
Property Value
Type Description
string

StartDate

Output only. Date when this ad group starts serving ads. By default, the ad group starts now or the ad group's start date, whichever is later. If this field is set, then the ad group starts at the beginning of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14

Declaration
[JsonProperty("startDate")]
public virtual string StartDate { get; set; }
Property Value
Type Description
string

Status

The status of the ad group.

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

TargetCpaMicros

The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.

Declaration
[JsonProperty("targetCpaMicros")]
public virtual long? TargetCpaMicros { get; set; }
Property Value
Type Description
long?

TargetCpcMicros

Average amount in micros that the advertiser is willing to pay for every ad click. Overrides the target CPC configured at the campaign level.

Declaration
[JsonProperty("targetCpcMicros")]
public virtual long? TargetCpcMicros { get; set; }
Property Value
Type Description
long?

TargetCpmMicros

Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.

Declaration
[JsonProperty("targetCpmMicros")]
public virtual long? TargetCpmMicros { get; set; }
Property Value
Type Description
long?

TargetCpvMicros

Average amount in micros that the advertiser is willing to pay for every ad view.

Declaration
[JsonProperty("targetCpvMicros")]
public virtual long? TargetCpvMicros { get; set; }
Property Value
Type Description
long?

TargetRoas

The target ROAS (return-on-ad-spend) for this ad group. This field lets you override the target ROAS specified in the campaign's bidding strategy, but only if the campaign is using a standard (not portfolio) TargetRoas strategy or a standard MaximizeConversionValue strategy with its target_roas field set. If the campaign is using a portfolio bidding strategy, this field cannot be set and attempting to do so will result in an error. For any other bidding strategies, this value is ignored. To see the actual target ROAS being used by the ad group, considering potential overrides, query the effective_target_roas and effective_target_roas_source fields.

Declaration
[JsonProperty("targetRoas")]
public virtual double? TargetRoas { get; set; }
Property Value
Type Description
double?

TargetingSetting

Setting for targeting related features.

Declaration
[JsonProperty("targetingSetting")]
public virtual GoogleAdsSearchads360V23CommonTargetingSetting TargetingSetting { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23CommonTargetingSetting

TrackingUrlTemplate

The URL template for constructing a tracking URL.

Declaration
[JsonProperty("trackingUrlTemplate")]
public virtual string TrackingUrlTemplate { get; set; }
Property Value
Type Description
string

Type

Immutable. The type of the ad group.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

UrlCustomParameters

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls.

Declaration
[JsonProperty("urlCustomParameters")]
public virtual IList<GoogleAdsSearchads360V23CommonCustomParameter> UrlCustomParameters { get; set; }
Property Value
Type Description
IList<GoogleAdsSearchads360V23CommonCustomParameter>

VerticalAdsFormatSetting

Vertical ads setting feature to enable/disable ad group format controls in search campaigns. This setting requires AiMaxAdGroupSetting to be enabled and a travel feed to be attached to the campaign.

Declaration
[JsonProperty("verticalAdsFormatSetting")]
public virtual GoogleAdsSearchads360V23ResourcesAdGroupVerticalAdsFormatSetting VerticalAdsFormatSetting { get; set; }
Property Value
Type Description
GoogleAdsSearchads360V23ResourcesAdGroupVerticalAdsFormatSetting

Implements