type AdGroup (v201809)

Represents an ad group.


Namespace
https://adwords.google.com/api/adwords/cm/v201809

Field

id

xsd:long

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.

campaignId

xsd:long

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.

campaignName

xsd:string

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.

name

xsd:string

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 '[^\x00\x0A\x0D]*'.

status

AdGroup.Status

Status of this ad group.


Enumerations
UNKNOWN
ENABLED
Active.
PAUSED
Paused.
REMOVED
Removed.

This field can be selected using the value "Status".
This field can be filtered on.

settings

  1. Setting[]
    1. ExplorerAutoOptimizerSetting
    2. TargetingSetting

List of settings for the AdGroup.

This field can be selected using the value "Settings".

labels

  1. Label[]
    1. TextLabel

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.

forwardCompatibilityMap

String_StringMapEntry[]

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.

biddingStrategyConfiguration

BiddingStrategyConfiguration

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.

contentBidCriterionTypeGroup

CriterionTypeGroup

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.


Enumerations
KEYWORD
Criteria for targeting keywords. e.g. 'mars cruise' KEYWORD may be used as a content bid dimension. Keywords are always a targeting dimension, so may not be set as a target "ALL" dimension with TargetRestriction.
USER_INTEREST_AND_LIST
Criteria for targeting lists of users. Lists may represent users with particular interests, or they may represent users who have interacted with an advertiser's site in particular ways.
VERTICAL
Criteria for targeting similar categories of placements, e.g. 'category::Animals>Pets' Used only for content network targeting.
GENDER
Criteria for targeting gender.
AGE_RANGE
Criteria for targeting age ranges.
PLACEMENT
Criteria for targeting placements. aka Website. e.g. 'www.flowers4sale.com' This group also includes mobile applications and mobile app categories.
PARENT
Criteria for parental status targeting.
INCOME_RANGE
Criteria for income range targeting.
NONE
Special criteria type group used to reset the existing value of AdGroup's contentBidCriterionTypeGroup.
UNKNOWN

This field can be selected using the value "ContentBidCriterionTypeGroup".
This field can be filtered on.

baseCampaignId

xsd:long

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.

baseAdGroupId

xsd:long

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".

trackingUrlTemplate

xsd:string

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.

finalUrlSuffix

xsd:string

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.

urlCustomParameters

CustomParameters

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.

adGroupType

AdGroupType


Enumerations
UNKNOWN
SEARCH_STANDARD
Default AdGroup type for Search Campaigns
SEARCH_DYNAMIC_ADS
AdGroup type for Dynamic Search Ads campaigns.
DISPLAY_STANDARD
Default AdGroup type for Display Campaigns
SHOPPING_PRODUCT_ADS
Default AdGroup type for Shopping Campaigns serving standard products ads.
SHOPPING_SHOWCASE_ADS
AdGroups limited to serving Showcase/Merchant ads in shopping results.
SHOPPING_GOAL_OPTIMIZED_ADS
Ad group type for Smart Shopping Campaigns.

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.

adGroupAdRotationMode

AdGroupAdRotationMode

The ad rotation mode to specify how often the ads in the ad group will be served relative to one another.

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。