GoogleAdsGoogleadsV25Services__MutateAdGroupBidModifiersRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-ads/json-schema/google-ads-google-ads-googleads-v25-services-mutate-ad-group-bid-modifiers-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateAdGroupBidModifiersRequest",
  "description": "Request message for AdGroupBidModifierService.MutateAdGroupBidModifiers.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-adgroupbidmodifiers-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateAdGroupBidModifiersRequest",
  "type": "object",
  "properties": {
    "partialFailure": {
      "type": "boolean",
      "description": "If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false."
    },
    "validateOnly": {
      "type": "boolean",
      "description": "If true, the request is validated but not executed. Only errors are returned, not results."
    },
    "responseContentType": {
      "x-enumDescriptions": [
        "Not specified. Will return the resource name only in the response.",
        "The mutate response will be the resource name.",
        "The mutate response will contain the resource name and the resource with mutable fields if possible. Otherwise, only the resource name will be returned."
      ],
      "enum": [
        "UNSPECIFIED",
        "RESOURCE_NAME_ONLY",
        "MUTABLE_RESOURCE"
      ],
      "description": "The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.",
      "type": "string"
    },
    "operations": {
      "type": "array",
      "description": "Required. The list of operations to perform on individual ad group bid modifiers.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__AdGroupBidModifierOperation"
      }
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Common__DeviceInfo": {
      "description": "A device criterion.",
      "type": "object",
      "properties": {
        "type": {
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "Mobile devices with full browsers.",
            "Tablets with full browsers.",
            "Computers.",
            "Smart TVs and game consoles.",
            "Other device types."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "MOBILE",
            "TABLET",
            "DESKTOP",
            "CONNECTED_TV",
            "OTHER"
          ],
          "description": "Type of the device.",
          "type": "string"
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__HotelAdvanceBookingWindowInfo": {
      "description": "Criterion for number of days prior to the stay the booking is being made.",
      "type": "object",
      "properties": {
        "minDays": {
          "format": "int64",
          "type": "string",
          "description": "Low end of the number of days prior to the stay."
        },
        "maxDays": {
          "description": "High end of the number of days prior to the stay.",
          "type": "string",
          "format": "int64"
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__HotelCheckInDateRangeInfo": {
      "type": "object",
      "properties": {
        "startDate": {
          "description": "Start date in the YYYY-MM-DD format.",
          "type": "string"
        },
        "endDate": {
          "description": "End date in the YYYY-MM-DD format.",
          "type": "string"
        }
      },
      "description": "Criterion for a check-in date range."
    },
    "GoogleAdsGoogleadsV25Common__HotelCheckInDayInfo": {
      "description": "Criterion for day of the week the booking is for.",
      "type": "object",
      "properties": {
        "dayOfWeek": {
          "type": "string",
          "description": "The day of the week.",
          "x-enumDescriptions": [
            "Not specified.",
            "The value is unknown in this version.",
            "Monday.",
            "Tuesday.",
            "Wednesday.",
            "Thursday.",
            "Friday.",
            "Saturday.",
            "Sunday."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY",
            "SATURDAY",
            "SUNDAY"
          ]
        }
      }
    },
    "GoogleAdsGoogleadsV25Common__HotelDateSelectionTypeInfo": {
      "type": "object",
      "properties": {
        "type": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "Dates selected by default.",
            "Dates selected by the user."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "DEFAULT_SELECTION",
            "USER_SELECTED"
          ],
          "description": "Type of the hotel date selection",
          "type": "string"
        }
      },
      "description": "Criterion for hotel date selection (default dates versus user selected)."
    },
    "GoogleAdsGoogleadsV25Common__HotelLengthOfStayInfo": {
      "description": "Criterion for length of hotel stay in nights.",
      "type": "object",
      "properties": {
        "minNights": {
          "type": "string",
          "description": "Low end of the number of nights in the stay.",
          "format": "int64"
        },
        "maxNights": {
          "type": "string",
          "description": "High end of the number of nights in the stay.",
          "format": "int64"
        }
      }
    },
    "GoogleAdsGoogleadsV25Resources__AdGroupBidModifier": {
      "type": "object",
      "properties": {
        "bidModifierSource": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "The bid modifier is specified at the campaign level, on the campaign level criterion.",
            "The bid modifier is specified (overridden) at the ad group level."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "CAMPAIGN",
            "AD_GROUP"
          ],
          "description": "Output only. Bid modifier source.",
          "type": "string"
        },
        "adGroup": {
          "description": "Immutable. The ad group to which this criterion belongs.",
          "type": "string"
        },
        "resourceName": {
          "description": "Immutable. The resource name of the ad group bid modifier. Ad group bid modifier resource names have the form: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`",
          "type": "string"
        },
        "hotelDateSelectionType": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__HotelDateSelectionTypeInfo",
          "description": "Immutable. Criterion for hotel date selection (default dates versus user selected)."
        },
        "bidModifier": {
          "description": "The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Use 0 to opt out of a Device type.",
          "type": "number",
          "format": "double"
        },
        "baseAdGroup": {
          "description": "Output only. The base ad group from which this draft/trial adgroup bid modifier was created. If ad_group is a base ad group then this field will be equal to ad_group. 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.",
          "type": "string"
        },
        "hotelCheckInDateRange": {
          "description": "Immutable. Criterion for a hotel check-in date range.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__HotelCheckInDateRangeInfo"
        },
        "hotelCheckInDay": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__HotelCheckInDayInfo",
          "description": "Immutable. Criterion for day of the week the booking is for."
        },
        "criterionId": {
          "description": "Output only. The ID of the criterion to bid modify. This field is ignored for mutates.",
          "type": "string",
          "format": "int64"
        },
        "hotelAdvanceBookingWindow": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__HotelAdvanceBookingWindowInfo",
          "description": "Immutable. Criterion for number of days prior to the stay the booking is being made."
        },
        "hotelLengthOfStay": {
          "description": "Immutable. Criterion for length of hotel stay in nights.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__HotelLengthOfStayInfo"
        },
        "device": {
          "description": "Immutable. A device criterion.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Common__DeviceInfo"
        }
      },
      "description": "Represents an ad group bid modifier."
    },
    "GoogleAdsGoogleadsV25Services__AdGroupBidModifierOperation": {
      "description": "A single operation (create, remove, update) on an ad group bid modifier.",
      "type": "object",
      "properties": {
        "remove": {
          "type": "string",
          "description": "Remove operation: A resource name for the removed ad group bid modifier is expected, in this format: `customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}`"
        },
        "update": {
          "description": "Update operation: The ad group bid modifier is expected to have a valid resource name.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__AdGroupBidModifier"
        },
        "updateMask": {
          "description": "FieldMask that determines which resource fields are modified in an update.",
          "type": "string",
          "format": "google-fieldmask"
        },
        "create": {
          "description": "Create operation: No resource name is expected for the new ad group bid modifier.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__AdGroupBidModifier"
        }
      }
    }
  }
}