Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

AdGroupBidModifier

JSON representation
BidModifierSource
HotelDateSelectionTypeInfo
- JSON representation
HotelAdvanceBookingWindowInfo
- JSON representation
HotelLengthOfStayInfo
- JSON representation
HotelCheckInDayInfo
- JSON representation
HotelCheckInDateRangeInfo
- JSON representation

Represents an ad group bid modifier.

JSON representation

JSON representation
{ "resourceName": string, "bidModifierSource": enum (`BidModifierSource`), "adGroup": string, "criterionId": string, "bidModifier": number, "baseAdGroup": string, // Union field `criterion` can be only one of the following: "hotelDateSelectionType": { object (`HotelDateSelectionTypeInfo`) }, "hotelAdvanceBookingWindow": { object (`HotelAdvanceBookingWindowInfo`) }, "hotelLengthOfStay": { object (`HotelLengthOfStayInfo`) }, "hotelCheckInDay": { object (`HotelCheckInDayInfo`) }, "device": { object (`DeviceInfo`) }, "hotelCheckInDateRange": { object (`HotelCheckInDateRangeInfo`) } // End of list of possible types for union field `criterion`. }

{
  "resourceName": string,
  "bidModifierSource": enum (BidModifierSource),
  "adGroup": string,
  "criterionId": string,
  "bidModifier": number,
  "baseAdGroup": string,

  // Union field criterion can be only one of the following:
  "hotelDateSelectionType": {
    object (HotelDateSelectionTypeInfo)
  },
  "hotelAdvanceBookingWindow": {
    object (HotelAdvanceBookingWindowInfo)
  },
  "hotelLengthOfStay": {
    object (HotelLengthOfStayInfo)
  },
  "hotelCheckInDay": {
    object (HotelCheckInDayInfo)
  },
  "device": {
    object (DeviceInfo)
  },
  "hotelCheckInDateRange": {
    object (HotelCheckInDateRangeInfo)
  }
  // End of list of possible types for union field criterion.
}

Fields
`resourceName`	`string` Immutable. The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: `customers/{customerId}/adGroupBidModifiers/{adGroupId}~{criterionId}`
`bidModifierSource`	`enum (BidModifierSource)` Output only. Bid modifier source.
`adGroup`	`string` Immutable. The ad group to which this criterion belongs.
`criterionId`	`string (int64 format)` Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
`bidModifier`	`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.
`baseAdGroup`	`string` Output only. The base ad group from which this draft/trial adgroup bid modifier was created. If adGroup is a base ad group then this field will be equal to adGroup. If the ad group was created in the draft or trial and has no corresponding base ad group, then this field will be null. This field is readonly.
Union field `criterion`. The criterion of this ad group bid modifier. Required in create operations starting in V5. `criterion` can be only one of the following:
`hotelDateSelectionType`	`object (HotelDateSelectionTypeInfo)` Immutable. Criterion for hotel date selection (default dates versus user selected).
`hotelAdvanceBookingWindow`	`object (HotelAdvanceBookingWindowInfo)` Immutable. Criterion for number of days prior to the stay the booking is being made.
`hotelLengthOfStay`	`object (HotelLengthOfStayInfo)` Immutable. Criterion for length of hotel stay in nights.
`hotelCheckInDay`	`object (HotelCheckInDayInfo)` Immutable. Criterion for day of the week the booking is for.
`device`	`object (DeviceInfo)` Immutable. A device criterion.
`hotelCheckInDateRange`	`object (HotelCheckInDateRangeInfo)` Immutable. Criterion for a hotel check-in date range.

BidModifierSource

Enum describing possible bid modifier sources.

Enums
`UNSPECIFIED`	Not specified.
`UNKNOWN`	Used for return value only. Represents value unknown in this version.
`CAMPAIGN`	The bid modifier is specified at the campaign level, on the campaign level criterion.
`AD_GROUP`	The bid modifier is specified (overridden) at the ad group level.

HotelDateSelectionTypeInfo

Criterion for hotel date selection (default dates versus user selected).

JSON representation
{ "type": enum (`HotelDateSelectionType`) }

Fields

Fields
`type`	`enum (HotelDateSelectionType)` Type of the hotel date selection

type

enum (HotelDateSelectionType)

Type of the hotel date selection

HotelAdvanceBookingWindowInfo

Criterion for number of days prior to the stay the booking is being made.

JSON representation
{ "minDays": string, "maxDays": string }

Fields

Fields
`minDays`	`string (int64 format)` Low end of the number of days prior to the stay.
`maxDays`	`string (int64 format)` High end of the number of days prior to the stay.

minDays

string (int64 format)

Low end of the number of days prior to the stay.

maxDays

string (int64 format)

High end of the number of days prior to the stay.

HotelLengthOfStayInfo

Criterion for length of hotel stay in nights.

JSON representation
{ "minNights": string, "maxNights": string }

Fields

Fields
`minNights`	`string (int64 format)` Low end of the number of nights in the stay.
`maxNights`	`string (int64 format)` High end of the number of nights in the stay.

minNights

string (int64 format)

Low end of the number of nights in the stay.

maxNights

string (int64 format)

High end of the number of nights in the stay.

HotelCheckInDayInfo

Criterion for day of the week the booking is for.

JSON representation
{ "dayOfWeek": enum (`DayOfWeek`) }

Fields

Fields
`dayOfWeek`	`enum (DayOfWeek)` The day of the week.

dayOfWeek

enum (DayOfWeek)

The day of the week.

HotelCheckInDateRangeInfo

Criterion for a check-in date range.

JSON representation
{ "startDate": string, "endDate": string }

Fields

Fields
`startDate`	`string` Start date in the YYYY-MM-DD format.
`endDate`	`string` End date in the YYYY-MM-DD format.

startDate

string

Start date in the YYYY-MM-DD format.

endDate

string

End date in the YYYY-MM-DD format.