GoogleAdsSearchads360V0Resources__AdGroupCriterion

import type { GoogleAdsSearchads360V0Resources__AdGroupCriterion } from "https://googleapis.deno.dev/v1/searchads360:v0.ts";

An ad group criterion. The ad_group_criterion report only returns criteria that were explicitly added to the ad group.

interface GoogleAdsSearchads360V0Resources__AdGroupCriterion {

adGroup?: string;

ageRange?: GoogleAdsSearchads360V0Common__AgeRangeInfo;

bidModifier?: number;

cpcBidMicros?: bigint;

readonly creationTime?: string;

readonly criterionId?: bigint;

readonly effectiveCpcBidMicros?: bigint;

readonly engineId?: string;

readonly engineStatus?:

| "UNSPECIFIED"

| "UNKNOWN"

| "AD_GROUP_CRITERION_ELIGIBLE"

| "AD_GROUP_CRITERION_INAPPROPRIATE_FOR_CAMPAIGN"

| "AD_GROUP_CRITERION_INVALID_MOBILE_SEARCH"

| "AD_GROUP_CRITERION_INVALID_PC_SEARCH"

| "AD_GROUP_CRITERION_INVALID_SEARCH"

| "AD_GROUP_CRITERION_LOW_SEARCH_VOLUME"

| "AD_GROUP_CRITERION_MOBILE_URL_UNDER_REVIEW"

| "AD_GROUP_CRITERION_PARTIALLY_INVALID"

| "AD_GROUP_CRITERION_TO_BE_ACTIVATED"

| "AD_GROUP_CRITERION_UNDER_REVIEW"

| "AD_GROUP_CRITERION_NOT_REVIEWED"

| "AD_GROUP_CRITERION_ON_HOLD"

| "AD_GROUP_CRITERION_PENDING_REVIEW"

| "AD_GROUP_CRITERION_PAUSED"

| "AD_GROUP_CRITERION_REMOVED"

| "AD_GROUP_CRITERION_APPROVED"

| "AD_GROUP_CRITERION_DISAPPROVED"

| "AD_GROUP_CRITERION_SERVING"

| "AD_GROUP_CRITERION_ACCOUNT_PAUSED";

finalUrls?: string[];

finalUrlSuffix?: string;

gender?: GoogleAdsSearchads360V0Common__GenderInfo;

keyword?: GoogleAdsSearchads360V0Common__KeywordInfo;

readonly labels?: string[];

readonly lastModifiedTime?: string;

listingGroup?: GoogleAdsSearchads360V0Common__ListingGroupInfo;

location?: GoogleAdsSearchads360V0Common__LocationInfo;

negative?: boolean;

readonly positionEstimates?: GoogleAdsSearchads360V0Resources_AdGroupCriterion_PositionEstimates;

readonly qualityInfo?: GoogleAdsSearchads360V0Resources_AdGroupCriterion_QualityInfo;

resourceName?: string;

status?:

| "UNSPECIFIED"

| "UNKNOWN"

| "ENABLED"

| "PAUSED"

| "REMOVED";

trackingUrlTemplate?: string;

readonly type?:

| "UNSPECIFIED"

| "UNKNOWN"

| "KEYWORD"

| "PLACEMENT"

| "MOBILE_APP_CATEGORY"

| "MOBILE_APPLICATION"

| "DEVICE"

| "LOCATION"

| "LISTING_GROUP"

| "AD_SCHEDULE"

| "AGE_RANGE"

| "GENDER"

| "INCOME_RANGE"

| "PARENTAL_STATUS"

| "YOUTUBE_VIDEO"

| "YOUTUBE_CHANNEL"

| "USER_LIST"

| "PROXIMITY"

| "TOPIC"

| "LISTING_SCOPE"

| "LANGUAGE"

| "IP_BLOCK"

| "CONTENT_LABEL"

| "CARRIER"

| "USER_INTEREST"

| "WEBPAGE"

| "OPERATING_SYSTEM_VERSION"

| "APP_PAYMENT_MODEL"

| "MOBILE_DEVICE"

| "CUSTOM_AFFINITY"

| "CUSTOM_INTENT"

| "LOCATION_GROUP"

| "CUSTOM_AUDIENCE"

| "COMBINED_AUDIENCE"

| "KEYWORD_THEME"

| "AUDIENCE"

| "LOCAL_SERVICE_ID"

| "BRAND"

| "BRAND_LIST"

| "LIFE_EVENT";

userList?: GoogleAdsSearchads360V0Common__UserListInfo;

webpage?: GoogleAdsSearchads360V0Common__WebpageInfo;

}

§Properties

adGroup?: string

[src]

Immutable. The ad group to which the criterion belongs.

ageRange?: GoogleAdsSearchads360V0Common__AgeRangeInfo

[src]

Immutable. Age range.

bidModifier?: number

[src]

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.

cpcBidMicros?: bigint

[src]

The CPC (cost-per-click) bid.

readonly creationTime?: string

[src]

Output only. 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.

readonly criterionId?: bigint

[src]

Output only. The ID of the criterion.

readonly effectiveCpcBidMicros?: bigint

[src]

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

readonly engineId?: string

[src]

Output only. 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 "ad_group_criterion.criterion_id" instead.

[src]

Output only. The Engine Status for ad group criterion.

finalUrls?: string[]

[src]

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

finalUrlSuffix?: string

[src]

URL template for appending params to final URL.

gender?: GoogleAdsSearchads360V0Common__GenderInfo

[src]

Immutable. Gender.

keyword?: GoogleAdsSearchads360V0Common__KeywordInfo

[src]

Immutable. Keyword.

readonly labels?: string[]

[src]

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

readonly lastModifiedTime?: string

[src]

Output only. 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.

listingGroup?: GoogleAdsSearchads360V0Common__ListingGroupInfo

[src]

Immutable. Listing group.

location?: GoogleAdsSearchads360V0Common__LocationInfo

[src]

Immutable. Location.

negative?: boolean

[src]

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

readonly positionEstimates?: GoogleAdsSearchads360V0Resources_AdGroupCriterion_PositionEstimates

[src]

Output only. Estimates for criterion bids at various positions.

readonly qualityInfo?: GoogleAdsSearchads360V0Resources_AdGroupCriterion_QualityInfo

[src]

Output only. Information regarding the quality of the criterion.

resourceName?: string

[src]

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

status?: "UNSPECIFIED" | "UNKNOWN" | "ENABLED" | "PAUSED" | "REMOVED"

[src]

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.

trackingUrlTemplate?: string

[src]

The URL template for constructing a tracking URL.

[src]

Output only. The type of the criterion.

userList?: GoogleAdsSearchads360V0Common__UserListInfo

[src]

Immutable. User List.

webpage?: GoogleAdsSearchads360V0Common__WebpageInfo

[src]

Immutable. Webpage