string

The resource name of the ad group. Ad group resource names have the form:

customers/{customerId}/adGroups/{ad_group_id}

enum (AdGroupStatus)

The status of the ad group.

enum (AdGroupType)

The type of the ad group.

enum (AdGroupAdRotationMode)

The ad rotation mode of the ad group.

string

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

object (TargetingSetting)

Setting for targeting related features.

string

The resource names of labels attached to this ad group.

string

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.

string

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 "adGroup.id" instead.

string

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

string

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

string

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

string

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.

string (int64 format)

The ID of the ad group.

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.

string

The URL template for constructing a tracking URL.

string (int64 format)

The maximum CPC (cost-per-click) bid.

enum (AdGroupEngineStatus)

The Engine Status for ad group.

string

URL template for appending params to Final URL.

The received value is not known in this version.

This is a response-only value.

The received value is not known in this version.

This is a response-only value.

The received value is not known in this version.

This is a response-only value.

Deprecated. Do not use.

object (TargetRestriction)

The per-targeting-dimension setting to restrict the reach of your campaign or ad group.

enum (TargetingDimension)

The targeting dimension that these settings apply to.

boolean

Indicates whether to restrict your ads to show only for the criteria you have selected for this targetingDimension, or to target all values for this targetingDimension and show ads based on your targeting in other TargetingDimensions. A value oftrue means that these criteria will only apply bid modifiers, and not affect targeting. A value offalse means that these criteria will restrict targeting as well as applying bid modifiers.

string

The resource name of the ad. Ad group ad resource names have the form:

customers/{customerId}/adGroupAds/{ad_group_id}~{adId}

enum (AdGroupAdStatus)

The status of the ad.

object (Ad)

The ad.

string

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

string

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

string

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

string

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

enum (AdGroupAdEngineStatus)

Additional status of the ad in the external engine account. Possible statuses (depending on the type of external account) include active, eligible, pending review, etc.

string

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

The received value is not known in this version.

This is a response-only value.

string

The resource name of the ad. Ad resource names have the form:

customers/{customerId}/ads/{adId}

string

The list of possible final URLs after all cross-domain redirects for the ad.

object (FinalAppUrl)

A list of final app URLs that will be used on mobile if the user has the specific app installed.

string

The list of possible final mobile URLs after all cross-domain redirects for the ad.

enum (AdType)

The type of ad.

string (int64 format)

The ID of the ad.

string

The URL template for constructing a tracking URL.

string

The suffix to use when constructing a final URL.

string

The URL that appears in the ad description for some ad formats.

string

The name of the ad. This is only used to be able to identify the ad. It does not need to be unique and does not affect the served ad.

object (SearchAds360TextAdInfo)

Details pertaining to a text ad.

object (SearchAds360ExpandedTextAdInfo)

Details pertaining to an expanded text ad.

object (SearchAds360ResponsiveSearchAdInfo)

Details pertaining to a responsive search ad.

object (SearchAds360ProductAdInfo)

Details pertaining to a product ad.

object (SearchAds360ExpandedDynamicSearchAdInfo)

Details pertaining to an expanded dynamic search ad.

enum (AppUrlOperatingSystemType)

The operating system targeted by this URL. Required.

string

The app deep link URL. Deep links specify a location in an app that corresponds to the content you'd like to show, and should be of the form {scheme}://{host_path} The scheme identifies which app to open. For your app, you can use a custom scheme that starts with the app's name. The host and path specify the unique location in the app where your content exists. Example: "exampleapp://productid_1234". Required.

The received value is not known in this version.

This is a response-only value.

string

The headline of the ad.

string

The first line of the ad's description.

string

The second line of the ad's description.

string

The displayed URL of the ad.

string

The displayed mobile URL of the ad.

string (int64 format)

The tracking id of the ad.

string

The headline of the ad.

string

The second headline of the ad.

string

The third headline of the ad.

string

The first line of the ad's description.

string

The second line of the ad's description.

string

Text appended to the auto-generated visible URL with a delimiter.

string

Text appended to path1 with a delimiter.

string (int64 format)

The tracking id of the ad.

object (AdTextAsset)

List of text assets for headlines. When the ad serves the headlines will be selected from this list.

object (AdTextAsset)

List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.

string

Text appended to the auto-generated visible URL with a delimiter.

string

Text appended to path1 with a delimiter.

string (int64 format)

The tracking id of the ad.

string

Asset text.

string

The first line of the ad's description.

string

The second line of the ad's description.

string (int64 format)

The tracking id of the ad.

Deprecated. Do not use.

Deprecated. Do not use. Previously used by Gemini

string

The resource name of the ad group ad effective label. Ad group ad effective label resource names have the form:customers/{ownerCustomerId}/adGroupAdEffectiveLabels/{ad_group_id}~{adId}~{label_id}

string

The ad group ad to which the effective label is attached.

string

The effective label assigned to the ad group ad.

string (int64 format)

The ID of the Customer which owns the effective label.

string

The resource name of the ad group ad label. Ad group ad label resource names have the form:customers/{ownerCustomerId}/adGroupAdLabels/{ad_group_id}~{adId}~{label_id}

string

The ad group ad to which the label is attached.

string

The label assigned to the ad group ad.

string (int64 format)

The ID of the Customer which owns the label.

string

The resource name of the ad group asset. AdGroupAsset resource names have the form:

customers/{customerId}/adGroupAssets/{ad_group_id}~{assetId}~{fieldType}

string

Required. The ad group to which the asset is linked.

string

Required. The asset which is linked to the ad group.

enum (AssetLinkStatus)

Status of the ad group asset.

string

The resource name of the ad group asset set. Ad group asset set resource names have the form:

customers/{customerId}/adGroupAssetSets/{ad_group_id}~{asset_set_id}

string

The ad group to which this asset set is linked.

string

The asset set which is linked to the ad group.

enum (AssetSetLinkStatus)

The status of the ad group asset set. Read-only.

string

The resource name of the ad group audience view. Ad group audience view resource names have the form:

customers/{customerId}/adGroupAudienceViews/{ad_group_id}~{criterionId}

string

The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form:

customers/{customerId}/adGroupBidModifiers/{ad_group_id}~{criterionId}

number

The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type.

Union fieldcriterion. The criterion of this ad group bid modifier.

Required in create operations starting in V5.criterion can be only one of the following:

object (DeviceInfo)

A device criterion.

enum (Device)

Type of the device.

string

The resource name of the ad group criterion. Ad group criterion resource names have the form:

customers/{customerId}/adGroupCriteria/{ad_group_id}~{criterionId}

string

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

enum (AdGroupCriterionStatus)

The status of the criterion.

This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added.

object (QualityInfo)

Information regarding the quality of the criterion.

enum (CriterionType)

The type of the criterion.

string

The resource names of labels attached to this ad group criterion.

string

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

object (PositionEstimates)

Estimates for criterion bids at various positions.

string

The list of possible final URLs after all cross-domain redirects for the ad.

string

The list of possible final mobile URLs after all cross-domain redirects.

object (CustomParameter)

The list of mappings used to substitute custom parameter tags in atrackingUrlTemplate,finalUrls, ormobile_final_urls.

string

ID of the ad group criterion 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 "adGroupCriterion.criterion_id" instead.

string

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

string (int64 format)

The ID of the criterion.

string

The ad group to which the criterion belongs.

boolean

Whether to target (false) or exclude (true) the criterion.

This field is immutable. To switch a criterion from positive to negative, remove then re-add it.

number

The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers.

string (int64 format)

The CPC (cost-per-click) bid.

string (int64 format)

The effective CPC (cost-per-click) bid.

enum (AdGroupCriterionEngineStatus)

The Engine Status for ad group criterion.

string

URL template for appending params to final URL.

string

The URL template for constructing a tracking URL.

Union fieldcriterion. The ad group criterion.

Exactly one must be set.criterion can be only one of the following:

object (KeywordInfo)

Keyword.

object (ListingGroupInfo)

Listing group.

object (AgeRangeInfo)

Age range.

object (GenderInfo)

Gender.

object (UserListInfo)

User List.

object (WebpageInfo)

Webpage

object (LocationInfo)

Location.

The received value is not known in this version.

This is a response-only value.

integer

The quality score.

This field may not be populated if Google does not have enough information to determine a value.

string (int64 format)

The estimate of the CPC bid required for ad to be displayed at the top of the first page of search results.

Deprecated. Do not use.

Deprecated. Do not use. Previously used by Gemini

string

The key matching the parameter tag name.

string

The value to be substituted.

enum (KeywordMatchType)

The match type of the keyword.

string

The text of the keyword (at most 80 characters and 10 words).

enum (ListingGroupType)

Type of the listing group.

enum (AgeRangeType)

Type of the age range.

enum (GenderType)

Type of the gender.

string

The User List resource name.

object (WebpageConditionInfo)

Conditions, or logical expressions, for webpage targeting. The list of webpage targeting conditions are and-ed together when evaluated for targeting. An empty list of conditions indicates all pages of the campaign's website are targeted.

This field is required for CREATE operations and is prohibited on UPDATE operations.

number

Website criteria coverage percentage. This is the computed percentage of website coverage based on the website target, negative website target and negative keywords in the ad group and campaign. For instance, when coverage returns as 1, it indicates it has 100% coverage. This field is read-only.

string

The name of the criterion that is defined by this parameter. The name value will be used for identifying, sorting and filtering criteria with this type of parameters.

This field is required for CREATE operations and is prohibited on UPDATE operations.

enum (WebpageConditionOperand)

Operand of webpage targeting condition.

enum (WebpageConditionOperator)

Operator of webpage targeting condition.

string

Argument of webpage targeting condition.

string

The geo target constant resource name.

string

The resource name of the ad group criterion effective label. Ad group criterion effective label resource names have the form:customers/{ownerCustomerId}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterionId}~{label_id}

string

The ad group criterion to which the effective label is attached.

string

The effective label assigned to the ad group criterion.

string (int64 format)

The ID of the Customer which owns the effective label.

string

The resource name of the ad group criterion label. Ad group criterion label resource names have the form:customers/{ownerCustomerId}/adGroupCriterionLabels/{ad_group_id}~{criterionId}~{label_id}

string

The ad group criterion to which the label is attached.

string

The label assigned to the ad group criterion.

string (int64 format)

The ID of the Customer which owns the label.

string

The resource name of the ad group effective label. Ad group effective label resource names have the form:customers/{ownerCustomerId}/adGroupEffectiveLabels/{ad_group_id}~{label_id}

string

The ad group to which the effective label is attached.

string

The effective label assigned to the ad group.

string (int64 format)

The ID of the Customer which owns the effective label.

string

The resource name of the ad group label. Ad group label resource names have the form:customers/{ownerCustomerId}/adGroupLabels/{ad_group_id}~{label_id}

string

The ad group to which the label is attached.

string

The label assigned to the ad group.

string (int64 format)

The ID of the Customer which owns the label.

string

The resource name of the age range view. Age range view resource names have the form:

customers/{customerId}/ageRangeViews/{ad_group_id}~{criterionId}

string

The resource name of the asset. Asset resource names have the form:

customers/{customerId}/assets/{assetId}

enum (AssetType)

Type of the asset.

string

A list of possible final URLs after all cross domain redirects.

string

A list of possible final mobile URLs after all cross domain redirects.

object (CustomParameter)

A list of mappings to be used for substituting URL custom parameter tags in the trackingUrlTemplate, finalUrls, and/or finalMobileUrls.

enum (AssetStatus)

The status of the asset.

string

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

string

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

string (int64 format)

The ID of the asset.

string

Optional name of the asset.

string

URL template for constructing a tracking URL.

string

URL template for appending params to landing page URLs served with parallel tracking.

enum (AssetEngineStatus)

The Engine Status for an asset.

object (YoutubeVideoAsset)

A YouTube video asset.

object (ImageAsset)

An image asset.

object (TextAsset)

A text asset.

object (UnifiedCalloutAsset)

A unified callout asset.

object (UnifiedSitelinkAsset)

A unified sitelink asset.

object (UnifiedPageFeedAsset)

A unified page feed asset.

object (MobileAppAsset)

A mobile app asset.

object (UnifiedCallAsset)

A unified call asset.

object (CallToActionAsset)

A call to action asset.

object (UnifiedLocationAsset)

A unified location asset.

string

YouTube video title.

string

YouTube video id. This is the 11 character string value used in the YouTube video URL.

enum (MimeType)

MIME type of the image asset.

object (ImageDimension)

Metadata for this image at its original size.

string (int64 format)

File size of the image asset in bytes.

The received value is not known in this version.

This is a response-only value.

string (int64 format)

Height of the image.

string (int64 format)

Width of the image.

string

A URL that returns the image with this height and width.

string

Text content of the text asset.

string

The callout text. The length of this string should be between 1 and 25, inclusive.

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

object (AdScheduleInfo)

List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.

boolean

Whether to show the asset in search user's time zone. Applies to Microsoft Ads.

enum (MinuteOfHour)

Minutes after the start hour at which this schedule starts.

This field is required for CREATE operations and is prohibited on UPDATE operations.

enum (MinuteOfHour)

Minutes after the end hour at which this schedule ends. The schedule is exclusive of the end minute.

This field is required for CREATE operations and is prohibited on UPDATE operations.

enum (DayOfWeek)

Day of the week the schedule applies to.

This field is required for CREATE operations and is prohibited on UPDATE operations.

integer

Starting hour in 24 hour time. This field must be between 0 and 23, inclusive.

This field is required for CREATE operations and is prohibited on UPDATE operations.

integer

Ending hour in 24 hour time; 24 signifies end of the day. This field must be between 0 and 24, inclusive.

This field is required for CREATE operations and is prohibited on UPDATE operations.

string

URL display text for the sitelink. The length of this string should be between 1 and 25, inclusive.

string

First line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description2 must also be set.

string

Second line of the description for the sitelink. If set, the length should be between 1 and 35, inclusive, and description1 must also be set.

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

object (AdScheduleInfo)

List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.

string (int64 format)

ID used for tracking clicks for the sitelink asset. This is a Yahoo! Japan only field.

boolean

Whether to show the sitelink asset in search user's time zone. Applies to Microsoft Ads.

boolean

Whether the preference is for the sitelink asset to be displayed on mobile devices. Applies to Microsoft Ads.

string

The webpage that advertisers want to target.

string

Labels used to group the page urls.

string

Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like "com.android.ebay" for Android or "12345689" for iOS.

enum (MobileAppVendor)

Required. The application store that distributes this specific app.

string

Two-letter country code of the phone number. Examples: 'US', 'us'.

string

The advertiser's raw phone number. Examples: '1234567890', '(123)456-7890'

enum (CallConversionReportingState)

Indicates whether this CallAsset should use its own call conversion setting, follow the account level setting, or disable call conversion.

string

The conversion action to attribute a call conversion to. If not set, the default conversion action is used. This field only has effect if callConversionReportingState is set to USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.

object (AdScheduleInfo)

List of non-overlapping schedules specifying all time intervals for which the asset may serve. There can be a maximum of 6 schedules per day, 42 in total.

boolean

Whether the call only shows the phone number without a link to the website. Applies to Microsoft Ads.

boolean

Whether the call should be enabled on call tracking. Applies to Microsoft Ads.

boolean

Whether to show the call extension in search user's time zone. Applies to Microsoft Ads.

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

enum (CallToActionType)

Call to action.

string

Place IDs uniquely identify a place in the Google Places database and on Google Maps. This field is unique for a given customer ID and asset type. Seehttps://developers.google.com/places/web-service/place-id to learn more about Place ID.

object (BusinessProfileLocation)

The list of business locations for the customer. This will only be returned if the Location Asset is syncing from the Business Profile account. It is possible to have multiple Business Profile listings under the same account that point to the same Place ID.

enum (LocationOwnershipType)

The type of location ownership. If the type is BUSINESS_OWNER, it will be served as a location extension. If the type is AFFILIATE, it will be served as an affiliate location.

string

Advertiser specified label for the location on the Business Profile account. This is synced from the Business Profile account.

string

Business Profile store code of this location. This is synced from the Business Profile account.

string (int64 format)

Listing ID of this Business Profile location. This is synced from the linked Business Profile account.