- Resource: CampaignCriterion
- CampaignCriterionStatus
- LocationInfo
- ProximityInfo
- GeoPointInfo
- ProximityRadiusUnits
- AddressInfo
- ListingScopeInfo
- LanguageInfo
- IpBlockInfo
- CarrierInfo
- OperatingSystemVersionInfo
- MobileDeviceInfo
- LocationGroupInfo
- LocationGroupRadiusUnits
- KeywordThemeInfo
- Methods
Resource: CampaignCriterion
A campaign criterion.
JSON representation | |
---|---|
{ "resourceName": string, "displayName": string, "type": enum ( |
Fields | ||
---|---|---|
resourceName |
Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form:
|
|
displayName |
Output only. The display name of the criterion. This field is ignored for mutates. |
|
type |
Output only. The type of the criterion. |
|
status |
The status of the criterion. |
|
campaign |
Immutable. The campaign to which the criterion belongs. |
|
criterionId |
Output only. The ID of the criterion. This field is ignored during mutate. |
|
bidModifier |
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. |
|
negative |
Immutable. Whether to target ( |
|
Union field Exactly one must be set. |
||
keyword |
Immutable. Keyword. |
|
placement |
Immutable. Placement. |
|
mobileAppCategory |
Immutable. Mobile app category. |
|
mobileApplication |
Immutable. Mobile application. |
|
location |
Immutable. Location. |
|
device |
Immutable. Device. |
|
adSchedule |
Immutable. Ad Schedule. |
|
ageRange |
Immutable. Age range. |
|
gender |
Immutable. Gender. |
|
incomeRange |
Immutable. Income range. |
|
parentalStatus |
Immutable. Parental status. |
|
userList |
Immutable. User List. |
|
youtubeVideo |
Immutable. YouTube Video. |
|
youtubeChannel |
Immutable. YouTube Channel. |
|
proximity |
Immutable. Proximity. |
|
topic |
Immutable. Topic. |
|
listingScope |
Immutable. Listing scope. |
|
language |
Immutable. Language. |
|
ipBlock |
Immutable. IpBlock. |
|
contentLabel |
Immutable. ContentLabel. |
|
carrier |
Immutable. Carrier. |
|
userInterest |
Immutable. User Interest. |
|
webpage |
Immutable. Webpage. |
|
operatingSystemVersion |
Immutable. Operating system version. |
|
mobileDevice |
Immutable. Mobile Device. |
|
locationGroup |
Immutable. Location Group |
|
customAffinity |
Immutable. Custom Affinity. |
|
customAudience |
Immutable. Custom Audience |
|
combinedAudience |
Immutable. Combined Audience. |
|
keywordTheme |
Immutable. Smart Campaign Keyword Theme. |
CampaignCriterionStatus
The possible statuses of a CampaignCriterion.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
The received value is not known in this version. This is a response-only value. |
ENABLED |
The campaign criterion is enabled. |
PAUSED |
The campaign criterion is paused. |
REMOVED |
The campaign criterion is removed. |
LocationInfo
A location criterion.
JSON representation | |
---|---|
{ "geoTargetConstant": string } |
Fields | |
---|---|
geoTargetConstant |
The geo target constant resource name. |
ProximityInfo
A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving.
There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated.
JSON representation | |
---|---|
{ "geoPoint": { object ( |
Fields | |
---|---|
geoPoint |
Latitude and longitude. |
radiusUnits |
The unit of measurement of the radius. Default is KILOMETERS. |
address |
Full address. |
radius |
The radius of the proximity. |
GeoPointInfo
Geo point for proximity criterion.
JSON representation | |
---|---|
{ "longitudeInMicroDegrees": integer, "latitudeInMicroDegrees": integer } |
Fields | |
---|---|
longitudeInMicroDegrees |
Micro degrees for the longitude. |
latitudeInMicroDegrees |
Micro degrees for the latitude. |
ProximityRadiusUnits
The unit of radius distance in proximity (e.g. MILES)
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
MILES |
Miles |
KILOMETERS |
Kilometers |
AddressInfo
Address for proximity criterion.
JSON representation | |
---|---|
{ "postalCode": string, "provinceCode": string, "countryCode": string, "provinceName": string, "streetAddress": string, "streetAddress2": string, "cityName": string } |
Fields | |
---|---|
postalCode |
Postal code. |
provinceCode |
Province or state code. |
countryCode |
Country code. |
provinceName |
Province or state name. |
streetAddress |
Street address line 1. |
streetAddress2 |
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. |
cityName |
Name of the city. |
ListingScopeInfo
A listing scope criterion.
JSON representation | |
---|---|
{
"dimensions": [
{
object ( |
Fields | |
---|---|
dimensions[] |
Scope of the campaign criterion. |
LanguageInfo
A language criterion.
JSON representation | |
---|---|
{ "languageConstant": string } |
Fields | |
---|---|
languageConstant |
The language constant resource name. |
IpBlockInfo
An IpBlock criterion used for IP exclusions. We allow: - IPv4 and IPv6 addresses - individual addresses (192.168.0.1) - masks for individual addresses (192.168.0.1/32) - masks for Class C networks (192.168.0.1/24)
JSON representation | |
---|---|
{ "ipAddress": string } |
Fields | |
---|---|
ipAddress |
The IP address of this IP block. |
CarrierInfo
Represents a Carrier Criterion.
JSON representation | |
---|---|
{ "carrierConstant": string } |
Fields | |
---|---|
carrierConstant |
The Carrier constant resource name. |
OperatingSystemVersionInfo
Represents an operating system version to be targeted.
JSON representation | |
---|---|
{ "operatingSystemVersionConstant": string } |
Fields | |
---|---|
operatingSystemVersionConstant |
The operating system version constant resource name. |
MobileDeviceInfo
A mobile device criterion.
JSON representation | |
---|---|
{ "mobileDeviceConstant": string } |
Fields | |
---|---|
mobileDeviceConstant |
The mobile device constant resource name. |
LocationGroupInfo
A radius around a list of locations specified via a feed.
JSON representation | |
---|---|
{
"geoTargetConstants": [
string
],
"radiusUnits": enum ( |
Fields | |
---|---|
geoTargetConstants[] |
Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed. |
radiusUnits |
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. |
feedItemSets[] |
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. |
feed |
Feed specifying locations for targeting. This is required and must be set in CREATE operations. |
radius |
Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations. |
LocationGroupRadiusUnits
The unit of radius distance in location group (e.g. MILES)
Enums | |
---|---|
UNSPECIFIED |
Not specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
METERS |
Meters |
MILES |
Miles |
MILLI_MILES |
Milli Miles |
KeywordThemeInfo
A Smart Campaign keyword theme.
JSON representation | |
---|---|
{ // Union field |
Fields | ||
---|---|---|
Union field keyword_theme . Either a predefined keyword theme constant or free-form text may be specified. keyword_theme can be only one of the following: |
||
keywordThemeConstant |
The resource name of a Smart Campaign keyword theme constant. |
|
freeFormKeywordTheme |
Free-form text to be matched to a Smart Campaign keyword theme constant on a best-effort basis. |
Methods |
|
---|---|
|
Returns the requested criterion in full detail. |
|
Creates, updates, or removes criteria. |