Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

AdGroup

JSON representation
AdGroupStatus
AdGroupAdRotationMode
AudienceSetting
- JSON representation
AdGroupPrimaryStatus
AdGroupPrimaryStatusReason

An ad group.

JSON representation

JSON representation
{ "resourceName": string, "status": enum (`AdGroupStatus`), "type": enum (`AdGroupType`), "adRotationMode": enum (`AdGroupAdRotationMode`), "urlCustomParameters": [ { object (`CustomParameter`) } ], "optimizedTargetingEnabled": boolean, "displayCustomBidDimension": enum (`TargetingDimension`), "targetingSetting": { object (`TargetingSetting`) }, "audienceSetting": { object (`AudienceSetting`) }, "effectiveTargetCpaSource": enum (`BiddingSource`), "effectiveTargetRoasSource": enum (`BiddingSource`), "labels": [ string ], "excludedParentAssetFieldTypes": [ enum (`AssetFieldType`) ], "excludedParentAssetSetTypes": [ enum (`AssetSetType`) ], "primaryStatus": enum (`AdGroupPrimaryStatus`), "primaryStatusReasons": [ enum (`AdGroupPrimaryStatusReason`) ], "id": string, "name": string, "baseAdGroup": string, "trackingUrlTemplate": string, "campaign": string, "cpcBidMicros": string, "effectiveCpcBidMicros": string, "cpmBidMicros": string, "targetCpaMicros": string, "cpvBidMicros": string, "targetCpmMicros": string, "targetRoas": number, "percentCpcBidMicros": string, "finalUrlSuffix": string, "effectiveTargetCpaMicros": string, "effectiveTargetRoas": number }

{
  "resourceName": string,
  "status": enum (AdGroupStatus),
  "type": enum (AdGroupType),
  "adRotationMode": enum (AdGroupAdRotationMode),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "optimizedTargetingEnabled": boolean,
  "displayCustomBidDimension": enum (TargetingDimension),
  "targetingSetting": {
    object (TargetingSetting)
  },
  "audienceSetting": {
    object (AudienceSetting)
  },
  "effectiveTargetCpaSource": enum (BiddingSource),
  "effectiveTargetRoasSource": enum (BiddingSource),
  "labels": [
    string
  ],
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "excludedParentAssetSetTypes": [
    enum (AssetSetType)
  ],
  "primaryStatus": enum (AdGroupPrimaryStatus),
  "primaryStatusReasons": [
    enum (AdGroupPrimaryStatusReason)
  ],
  "id": string,
  "name": string,
  "baseAdGroup": string,
  "trackingUrlTemplate": string,
  "campaign": string,
  "cpcBidMicros": string,
  "effectiveCpcBidMicros": string,
  "cpmBidMicros": string,
  "targetCpaMicros": string,
  "cpvBidMicros": string,
  "targetCpmMicros": string,
  "targetRoas": number,
  "percentCpcBidMicros": string,
  "finalUrlSuffix": string,
  "effectiveTargetCpaMicros": string,
  "effectiveTargetRoas": number
}

Fields
`resourceName`	`string` Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customerId}/adGroups/{adGroupId}`
`status`	`enum (AdGroupStatus)` The status of the ad group.
`type`	`enum (AdGroupType)` Immutable. The type of the ad group.
`adRotationMode`	`enum (AdGroupAdRotationMode)` The ad rotation mode of the ad group.
`urlCustomParameters[]`	`object (CustomParameter)` The list of mappings used to substitute custom parameter tags in a `trackingUrlTemplate`, `finalUrls`, or `mobile_final_urls`.
`optimizedTargetingEnabled`	`boolean` True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
`displayCustomBidDimension`	`enum (TargetingDimension)` Allows advertisers to 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.
`targetingSetting`	`object (TargetingSetting)` Setting for targeting related features.
`audienceSetting`	`object (AudienceSetting)` Immutable. Setting for audience related features.
`effectiveTargetCpaSource`	`enum (BiddingSource)` Output only. Source of the effective target CPA. This field is read-only.
`effectiveTargetRoasSource`	`enum (BiddingSource)` Output only. Source of the effective target ROAS. This field is read-only.
`labels[]`	`string` Output only. The resource names of labels attached to this ad group.
`excludedParentAssetFieldTypes[]`	`enum (AssetFieldType)` 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.
`excludedParentAssetSetTypes[]`	`enum (AssetSetType)` 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.
`primaryStatus`	`enum (AdGroupPrimaryStatus)` Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
`primaryStatusReasons[]`	`enum (AdGroupPrimaryStatusReason)` Output only. Provides reasons for why an ad group is not serving or not serving optimally.
`id`	`string (int64 format)` Output only. The ID of the ad group.
`name`	`string` 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.
`baseAdGroup`	`string` 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.
`trackingUrlTemplate`	`string` The URL template for constructing a tracking URL.
`campaign`	`string` Immutable. The campaign to which the ad group belongs.
`cpcBidMicros`	`string (int64 format)` The maximum CPC (cost-per-click) bid.
`effectiveCpcBidMicros`	`string (int64 format)` 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.
`cpmBidMicros`	`string (int64 format)` The maximum CPM (cost-per-thousand viewable impressions) bid.
`targetCpaMicros`	`string (int64 format)` The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its targetCpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.
`cpvBidMicros`	`string (int64 format)` The CPV (cost-per-view) bid.
`targetCpmMicros`	`string (int64 format)` Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
`targetRoas`	`number` The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its targetRoas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.
`percentCpcBidMicros`	`string (int64 format)` 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].
`finalUrlSuffix`	`string` URL template for appending params to Final URL.
`effectiveTargetCpaMicros`	`string (int64 format)` Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
`effectiveTargetRoas`	`number` Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.

AdGroupStatus

The possible statuses of an ad group.

Enums
`UNSPECIFIED`	The status has not been specified.
`UNKNOWN`	The received value is not known in this version. This is a response-only value.
`ENABLED`	The ad group is enabled.
`PAUSED`	The ad group is paused.
`REMOVED`	The ad group is removed.

AdGroupAdRotationMode

The possible ad rotation modes of an ad group.

Enums
`UNSPECIFIED`	The ad rotation mode has not been specified.
`UNKNOWN`	The received value is not known in this version. This is a response-only value.
`OPTIMIZE`	Optimize ad group ads based on clicks or conversions.
`ROTATE_FOREVER`	Rotate evenly forever.

AudienceSetting

Settings for the audience targeting.

JSON representation
{ "useAudienceGrouped": boolean }

Fields

Fields
`useAudienceGrouped`	`boolean` Immutable. If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.

useAudienceGrouped

boolean

Immutable. If true, this ad group uses an Audience resource for audience targeting. If false, this ad group may use audience segment criteria instead.

AdGroupPrimaryStatus

The possible statuses of an AdGroup.

Enums
`UNSPECIFIED`	Not specified.
`UNKNOWN`	Used for return value only. Represents value unknown in this version.
`ELIGIBLE`	The ad group is eligible to serve.
`PAUSED`	The ad group is paused.
`REMOVED`	The ad group is removed.
`PENDING`	The ad group may serve in the future.
`NOT_ELIGIBLE`	The ad group is not eligible to serve.
`LIMITED`	The ad group has limited servability.

AdGroupPrimaryStatusReason

Possible ad group status reasons.

Enums
`UNSPECIFIED`	Not specified.
`UNKNOWN`	Used for return value only. Represents value unknown in this version.
`CAMPAIGN_REMOVED`	The user-specified campaign status is removed. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`CAMPAIGN_PAUSED`	The user-specified campaign status is paused. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`CAMPAIGN_PENDING`	The user-specified time for this campaign to start is in the future. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE
`CAMPAIGN_ENDED`	The user-specified time for this campaign to end has passed. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_PAUSED`	The user-specified ad group status is paused. Contributes to AdGroupPrimaryStatus.PAUSED.
`AD_GROUP_REMOVED`	The user-specified ad group status is removed. Contributes to AdGroupPrimaryStatus.REMOVED.
`AD_GROUP_INCOMPLETE`	The construction of this ad group is not yet complete. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`KEYWORDS_PAUSED`	The user-specified keyword statuses in this ad group are all paused. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`NO_KEYWORDS`	No eligible keywords exist in this ad group. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_ADS_PAUSED`	The user-specified ad group ads statuses in this ad group are all paused. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`NO_AD_GROUP_ADS`	No eligible ad group ads exist in this ad group. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`HAS_ADS_DISAPPROVED`	Policy status reason when at least one ad is disapproved. Contributes to multiple AdGroupPrimaryStatus.
`HAS_ADS_LIMITED_BY_POLICY`	Policy status reason when at least one ad is limited by policy. Contributes to multiple AdGroupPrimaryStatus.
`MOST_ADS_UNDER_REVIEW`	Policy status reason when most ads are pending review. Contributes to AdGroupPrimaryStatus.PENDING.
`CAMPAIGN_DRAFT`	The AdGroup belongs to a Draft campaign. Contributes to AdGroupPrimaryStatus.NOT_ELIGIBLE.
`AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY`	Ad group has been paused due to prolonged low activity in serving. Contributes to AdGroupPrimaryStatus.PAUSED.