--- title: "POST /v23/customers/{customersId}/adGroupBidModifiers:mutate" method: POST path: "/v23/customers/{customersId}/adGroupBidModifiers:mutate" tags: ["customers"] --- # POST /v23/customers/{customersId}/adGroupBidModifiers:mutate `POST /v23/customers/{customersId}/adGroupBidModifiers:mutate` ## Request - Base URL: `https://searchads360.googleapis.com` - URL: `https://searchads360.googleapis.com/v23/customers/{customersId}/adGroupBidModifiers:mutate` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/doubleclicksearch` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/doubleclicksearch` - TypeScript: (a function with typed inputs; its response is checked against the schema) Creates, updates, or removes ad group bid modifiers. Operation statuses are returned. List of thrown errors: [AdGroupBidModifierError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() ## Path parameters - `customersId` string, required ## Request body - GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifiersRequest: Request message for AdGroupBidModifierService.MutateAdGroupBidModifiers. - `operations` GoogleAdsSearchads360V23ServicesAdGroupBidModifierOperation[]: Required. The list of operations to perform on individual ad group bid modifiers. - `create` GoogleAdsSearchads360V23ResourcesAdGroupBidModifier: Represents an ad group bid modifier. - `adGroup` string: Immutable. The ad group to which this criterion belongs. - `baseAdGroup` string: 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. - `bidModifier` number, double: 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. - `bidModifierSource` 'UNSPECIFIED' | 'UNKNOWN' | 'CAMPAIGN' | 'AD_GROUP': Output only. Bid modifier source. - `criterionId` string, int64: Output only. The ID of the criterion to bid modify. This field is ignored for mutates. - `device` GoogleAdsSearchads360V23CommonDeviceInfo: A device criterion. - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'MOBILE' | 'TABLET' | 'DESKTOP' | 'CONNECTED_TV' | 'OTHER': Type of the device. - `hotelAdvanceBookingWindow` GoogleAdsSearchads360V23CommonHotelAdvanceBookingWindowInfo: Criterion for number of days prior to the stay the booking is being made. - `maxDays` string, int64: High end of the number of days prior to the stay. - `minDays` string, int64: Low end of the number of days prior to the stay. - `hotelCheckInDateRange` GoogleAdsSearchads360V23CommonHotelCheckInDateRangeInfo: Criterion for a check-in date range. - `endDate` string: End date in the YYYY-MM-DD format. - `startDate` string: Start date in the YYYY-MM-DD format. - `hotelCheckInDay` GoogleAdsSearchads360V23CommonHotelCheckInDayInfo: Criterion for day of the week the booking is for. - `dayOfWeek` 'UNSPECIFIED' | 'UNKNOWN' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY': The day of the week. - `hotelDateSelectionType` GoogleAdsSearchads360V23CommonHotelDateSelectionTypeInfo: Criterion for hotel date selection (default dates versus user selected). - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'DEFAULT_SELECTION' | 'USER_SELECTED': Type of the hotel date selection - `hotelLengthOfStay` GoogleAdsSearchads360V23CommonHotelLengthOfStayInfo: Criterion for length of hotel stay in nights. - `maxNights` string, int64: High end of the number of nights in the stay. - `minNights` string, int64: Low end of the number of nights in the stay. - `resourceName` string: 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}` - `remove` string: 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` GoogleAdsSearchads360V23ResourcesAdGroupBidModifier: Represents an ad group bid modifier. - `adGroup` string: Immutable. The ad group to which this criterion belongs. - `baseAdGroup` string: 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. - `bidModifier` number, double: 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. - `bidModifierSource` 'UNSPECIFIED' | 'UNKNOWN' | 'CAMPAIGN' | 'AD_GROUP': Output only. Bid modifier source. - `criterionId` string, int64: Output only. The ID of the criterion to bid modify. This field is ignored for mutates. - `device` GoogleAdsSearchads360V23CommonDeviceInfo: A device criterion. - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'MOBILE' | 'TABLET' | 'DESKTOP' | 'CONNECTED_TV' | 'OTHER': Type of the device. - `hotelAdvanceBookingWindow` GoogleAdsSearchads360V23CommonHotelAdvanceBookingWindowInfo: Criterion for number of days prior to the stay the booking is being made. - `maxDays` string, int64: High end of the number of days prior to the stay. - `minDays` string, int64: Low end of the number of days prior to the stay. - `hotelCheckInDateRange` GoogleAdsSearchads360V23CommonHotelCheckInDateRangeInfo: Criterion for a check-in date range. - `endDate` string: End date in the YYYY-MM-DD format. - `startDate` string: Start date in the YYYY-MM-DD format. - `hotelCheckInDay` GoogleAdsSearchads360V23CommonHotelCheckInDayInfo: Criterion for day of the week the booking is for. - `dayOfWeek` 'UNSPECIFIED' | 'UNKNOWN' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY': The day of the week. - `hotelDateSelectionType` GoogleAdsSearchads360V23CommonHotelDateSelectionTypeInfo: Criterion for hotel date selection (default dates versus user selected). - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'DEFAULT_SELECTION' | 'USER_SELECTED': Type of the hotel date selection - `hotelLengthOfStay` GoogleAdsSearchads360V23CommonHotelLengthOfStayInfo: Criterion for length of hotel stay in nights. - `maxNights` string, int64: High end of the number of nights in the stay. - `minNights` string, int64: Low end of the number of nights in the stay. - `resourceName` string: 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}` - `updateMask` string, google-fieldmask: FieldMask that determines which resource fields are modified in an update. - `partialFailure` boolean: 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. - `responseContentType` 'UNSPECIFIED' | 'RESOURCE_NAME_ONLY' | 'MUTABLE_RESOURCE': The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation. - `validateOnly` boolean: If true, the request is validated but not executed. Only errors are returned, not results. ## Response `200` Successful response - GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifiersResponse: Response message for ad group bid modifiers mutate. - `partialFailureError` GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer: The status code, which should be an enum value of google.rpc.Code. - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use. - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `results` GoogleAdsSearchads360V23ServicesMutateAdGroupBidModifierResult[]: All results for the mutate. - `adGroupBidModifier` GoogleAdsSearchads360V23ResourcesAdGroupBidModifier: Represents an ad group bid modifier. - `adGroup` string: Immutable. The ad group to which this criterion belongs. - `baseAdGroup` string: 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. - `bidModifier` number, double: 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. - `bidModifierSource` 'UNSPECIFIED' | 'UNKNOWN' | 'CAMPAIGN' | 'AD_GROUP': Output only. Bid modifier source. - `criterionId` string, int64: Output only. The ID of the criterion to bid modify. This field is ignored for mutates. - `device` GoogleAdsSearchads360V23CommonDeviceInfo: A device criterion. - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'MOBILE' | 'TABLET' | 'DESKTOP' | 'CONNECTED_TV' | 'OTHER': Type of the device. - `hotelAdvanceBookingWindow` GoogleAdsSearchads360V23CommonHotelAdvanceBookingWindowInfo: Criterion for number of days prior to the stay the booking is being made. - `maxDays` string, int64: High end of the number of days prior to the stay. - `minDays` string, int64: Low end of the number of days prior to the stay. - `hotelCheckInDateRange` GoogleAdsSearchads360V23CommonHotelCheckInDateRangeInfo: Criterion for a check-in date range. - `endDate` string: End date in the YYYY-MM-DD format. - `startDate` string: Start date in the YYYY-MM-DD format. - `hotelCheckInDay` GoogleAdsSearchads360V23CommonHotelCheckInDayInfo: Criterion for day of the week the booking is for. - `dayOfWeek` 'UNSPECIFIED' | 'UNKNOWN' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY': The day of the week. - `hotelDateSelectionType` GoogleAdsSearchads360V23CommonHotelDateSelectionTypeInfo: Criterion for hotel date selection (default dates versus user selected). - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'DEFAULT_SELECTION' | 'USER_SELECTED': Type of the hotel date selection - `hotelLengthOfStay` GoogleAdsSearchads360V23CommonHotelLengthOfStayInfo: Criterion for length of hotel stay in nights. - `maxNights` string, int64: High end of the number of nights in the stay. - `minNights` string, int64: Low end of the number of nights in the stay. - `resourceName` string: 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}` - `resourceName` string: Returned for successful operations. --- [API](https://skmtc.dev/google/apis/searchads360.md) - [All operations](https://skmtc.dev/google/apis/searchads360/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/searchads360/revisions/4a4511f84b18?raw)