REST Resource: customers.campaignCriteria

{
  "resourceName": string,
  "displayName": string,
  "type": enum (CriterionType),
  "status": enum (CampaignCriterionStatus),
  "campaign": string,
  "criterionId": string,
  "bidModifier": number,
  "negative": boolean,

  // Union field criterion can be only one of the following:
  "keyword": {
    object (KeywordInfo)
  },
  "placement": {
    object (PlacementInfo)
  },
  "mobileAppCategory": {
    object (MobileAppCategoryInfo)
  },
  "mobileApplication": {
    object (MobileApplicationInfo)
  },
  "location": {
    object (LocationInfo)
  },
  "device": {
    object (DeviceInfo)
  },
  "adSchedule": {
    object (AdScheduleInfo)
  },
  "ageRange": {
    object (AgeRangeInfo)
  },
  "gender": {
    object (GenderInfo)
  },
  "incomeRange": {
    object (IncomeRangeInfo)
  },
  "parentalStatus": {
    object (ParentalStatusInfo)
  },
  "userList": {
    object (UserListInfo)
  },
  "youtubeVideo": {
    object (YouTubeVideoInfo)
  },
  "youtubeChannel": {
    object (YouTubeChannelInfo)
  },
  "proximity": {
    object (ProximityInfo)
  },
  "topic": {
    object (TopicInfo)
  },
  "listingScope": {
    object (ListingScopeInfo)
  },
  "language": {
    object (LanguageInfo)
  },
  "ipBlock": {
    object (IpBlockInfo)
  },
  "contentLabel": {
    object (ContentLabelInfo)
  },
  "carrier": {
    object (CarrierInfo)
  },
  "userInterest": {
    object (UserInterestInfo)
  },
  "webpage": {
    object (WebpageInfo)
  },
  "operatingSystemVersion": {
    object (OperatingSystemVersionInfo)
  },
  "mobileDevice": {
    object (MobileDeviceInfo)
  },
  "locationGroup": {
    object (LocationGroupInfo)
  },
  "customAffinity": {
    object (CustomAffinityInfo)
  },
  "customAudience": {
    object (CustomAudienceInfo)
  },
  "combinedAudience": {
    object (CombinedAudienceInfo)
  },
  "keywordTheme": {
    object (KeywordThemeInfo)
  }
  // End of list of possible types for union field criterion.
}

string

Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form:

customers/{customerId}/campaignCriteria/{campaignId}~{criterionId}

string

Output only. The display name of the criterion.

This field is ignored for mutates.

enum (CriterionType)

Output only. The type of the criterion.

enum (CampaignCriterionStatus)

The status of the criterion.

string

Immutable. The campaign to which the criterion belongs.

string (int64 format)

Output only. The ID of the criterion.

This field is ignored during mutate.

number

The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.

boolean

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

object (KeywordInfo)

Immutable. Keyword.

object (PlacementInfo)

Immutable. Placement.

object (MobileAppCategoryInfo)

Immutable. Mobile app category.

object (MobileApplicationInfo)

Immutable. Mobile application.

object (LocationInfo)

Immutable. Location.

object (DeviceInfo)

Immutable. Device.

object (AdScheduleInfo)

Immutable. Ad Schedule.

object (AgeRangeInfo)

Immutable. Age range.

object (GenderInfo)

Immutable. Gender.

object (IncomeRangeInfo)

Immutable. Income range.

object (ParentalStatusInfo)

Immutable. Parental status.

object (UserListInfo)

Immutable. User List.

object (YouTubeVideoInfo)

Immutable. YouTube Video.

object (YouTubeChannelInfo)

Immutable. YouTube Channel.

object (ProximityInfo)

Immutable. Proximity.

object (TopicInfo)

Immutable. Topic.

object (ListingScopeInfo)

Immutable. Listing scope.

object (LanguageInfo)

Immutable. Language.

object (IpBlockInfo)

Immutable. IpBlock.

object (ContentLabelInfo)

Immutable. ContentLabel.

object (CarrierInfo)

Immutable. Carrier.

object (UserInterestInfo)

Immutable. User Interest.

object (WebpageInfo)

Immutable. Webpage.

object (OperatingSystemVersionInfo)

Immutable. Operating system version.

object (MobileDeviceInfo)

Immutable. Mobile Device.

object (LocationGroupInfo)

Immutable. Location Group

object (CustomAffinityInfo)

Immutable. Custom Affinity.

object (CustomAudienceInfo)

Immutable. Custom Audience

object (CombinedAudienceInfo)

Immutable. Combined Audience.

object (KeywordThemeInfo)

Immutable. Smart Campaign Keyword Theme.

{
  "geoTargetConstant": string
}

string

The geo target constant resource name.

{
  "geoPoint": {
    object (GeoPointInfo)
  },
  "radiusUnits": enum (ProximityRadiusUnits),
  "address": {
    object (AddressInfo)
  },
  "radius": number
}

object (GeoPointInfo)

Latitude and longitude.

enum (ProximityRadiusUnits)

The unit of measurement of the radius. Default is KILOMETERS.

object (AddressInfo)

Full address.

number

The radius of the proximity.

{
  "longitudeInMicroDegrees": integer,
  "latitudeInMicroDegrees": integer
}

integer

Micro degrees for the longitude.

integer

Micro degrees for the latitude.

{
  "postalCode": string,
  "provinceCode": string,
  "countryCode": string,
  "provinceName": string,
  "streetAddress": string,
  "streetAddress2": string,
  "cityName": string
}

string

Postal code.

string

Province or state code.

string

Country code.

string

Province or state name.

string

Street address line 1.

string

Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geoPoint is empty.

string

Name of the city.

{
  "dimensions": [
    {
      object (ListingDimensionInfo)
    }
  ]
}

object (ListingDimensionInfo)

Scope of the campaign criterion.

{
  "languageConstant": string
}

string

The language constant resource name.

{
  "ipAddress": string
}

string

The IP address of this IP block.

{
  "carrierConstant": string
}

string

The Carrier constant resource name.

{
  "operatingSystemVersionConstant": string
}

string

The operating system version constant resource name.

{
  "mobileDeviceConstant": string
}

string

The mobile device constant resource name.

{
  "geoTargetConstants": [
    string
  ],
  "radiusUnits": enum (LocationGroupRadiusUnits),
  "feedItemSets": [
    string
  ],
  "feed": string,
  "radius": string
}

string

Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.

enum (LocationGroupRadiusUnits)

Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.

string

FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geoTargetConstants. This is optional and can only be set in CREATE operations.

string

Feed specifying locations for targeting. This is required and must be set in CREATE operations.

string (int64 format)

Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.

{

  // Union field keyword_theme can be only one of the following:
  "keywordThemeConstant": string,
  "freeFormKeywordTheme": string
  // End of list of possible types for union field keyword_theme.
}

string

The resource name of a Smart Campaign keyword theme constant. keywordThemeConstants/{keyword_theme_id}~{sub_keyword_theme_id}

string

Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis.