Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
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]()
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
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]()
Args:
customerId: string, Required. ID of the customer whose ad group bid modifiers are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for AdGroupBidModifierService.MutateAdGroupBidModifiers.
"operations": [ # Required. The list of operations to perform on individual ad group bid modifiers.
{ # A single operation (create, remove, update) on an ad group bid modifier.
"create": { # Represents an ad group bid modifier. # Create operation: No resource name is expected for the new ad group bid modifier.
"adGroup": "A String", # Immutable. The ad group to which this criterion belongs.
"baseAdGroup": "A 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": 3.14, # 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": "A String", # Output only. Bid modifier source.
"criterionId": "A String", # Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
"device": { # A device criterion. # Immutable. A device criterion.
"type": "A String", # Type of the device.
},
"hotelAdvanceBookingWindow": { # Criterion for number of days prior to the stay the booking is being made. # Immutable. Criterion for number of days prior to the stay the booking is being made.
"maxDays": "A String", # High end of the number of days prior to the stay.
"minDays": "A String", # Low end of the number of days prior to the stay.
},
"hotelCheckInDateRange": { # Criterion for a check-in date range. # Immutable. Criterion for a hotel check-in date range.
"endDate": "A String", # End date in the YYYY-MM-DD format.
"startDate": "A String", # Start date in the YYYY-MM-DD format.
},
"hotelCheckInDay": { # Criterion for day of the week the booking is for. # Immutable. Criterion for day of the week the booking is for.
"dayOfWeek": "A String", # The day of the week.
},
"hotelDateSelectionType": { # Criterion for hotel date selection (default dates versus user selected). # Immutable. Criterion for hotel date selection (default dates versus user selected).
"type": "A String", # Type of the hotel date selection
},
"hotelLengthOfStay": { # Criterion for length of hotel stay in nights. # Immutable. Criterion for length of hotel stay in nights.
"maxNights": "A String", # High end of the number of nights in the stay.
"minNights": "A String", # Low end of the number of nights in the stay.
},
"resourceName": "A 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": "A 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": { # Represents an ad group bid modifier. # Update operation: The ad group bid modifier is expected to have a valid resource name.
"adGroup": "A String", # Immutable. The ad group to which this criterion belongs.
"baseAdGroup": "A 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": 3.14, # 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": "A String", # Output only. Bid modifier source.
"criterionId": "A String", # Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
"device": { # A device criterion. # Immutable. A device criterion.
"type": "A String", # Type of the device.
},
"hotelAdvanceBookingWindow": { # Criterion for number of days prior to the stay the booking is being made. # Immutable. Criterion for number of days prior to the stay the booking is being made.
"maxDays": "A String", # High end of the number of days prior to the stay.
"minDays": "A String", # Low end of the number of days prior to the stay.
},
"hotelCheckInDateRange": { # Criterion for a check-in date range. # Immutable. Criterion for a hotel check-in date range.
"endDate": "A String", # End date in the YYYY-MM-DD format.
"startDate": "A String", # Start date in the YYYY-MM-DD format.
},
"hotelCheckInDay": { # Criterion for day of the week the booking is for. # Immutable. Criterion for day of the week the booking is for.
"dayOfWeek": "A String", # The day of the week.
},
"hotelDateSelectionType": { # Criterion for hotel date selection (default dates versus user selected). # Immutable. Criterion for hotel date selection (default dates versus user selected).
"type": "A String", # Type of the hotel date selection
},
"hotelLengthOfStay": { # Criterion for length of hotel stay in nights. # Immutable. Criterion for length of hotel stay in nights.
"maxNights": "A String", # High end of the number of nights in the stay.
"minNights": "A String", # Low end of the number of nights in the stay.
},
"resourceName": "A 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": "A String", # FieldMask that determines which resource fields are modified in an update.
},
],
"partialFailure": True or False, # 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": "A String", # The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.
"validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ad group bid modifiers mutate.
"partialFailureError": { # 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). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A 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": [ # All results for the mutate.
{ # The result for the criterion mutate.
"adGroupBidModifier": { # Represents an ad group bid modifier. # The mutated ad group bid modifier with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"adGroup": "A String", # Immutable. The ad group to which this criterion belongs.
"baseAdGroup": "A 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": 3.14, # 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": "A String", # Output only. Bid modifier source.
"criterionId": "A String", # Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
"device": { # A device criterion. # Immutable. A device criterion.
"type": "A String", # Type of the device.
},
"hotelAdvanceBookingWindow": { # Criterion for number of days prior to the stay the booking is being made. # Immutable. Criterion for number of days prior to the stay the booking is being made.
"maxDays": "A String", # High end of the number of days prior to the stay.
"minDays": "A String", # Low end of the number of days prior to the stay.
},
"hotelCheckInDateRange": { # Criterion for a check-in date range. # Immutable. Criterion for a hotel check-in date range.
"endDate": "A String", # End date in the YYYY-MM-DD format.
"startDate": "A String", # Start date in the YYYY-MM-DD format.
},
"hotelCheckInDay": { # Criterion for day of the week the booking is for. # Immutable. Criterion for day of the week the booking is for.
"dayOfWeek": "A String", # The day of the week.
},
"hotelDateSelectionType": { # Criterion for hotel date selection (default dates versus user selected). # Immutable. Criterion for hotel date selection (default dates versus user selected).
"type": "A String", # Type of the hotel date selection
},
"hotelLengthOfStay": { # Criterion for length of hotel stay in nights. # Immutable. Criterion for length of hotel stay in nights.
"maxNights": "A String", # High end of the number of nights in the stay.
"minNights": "A String", # Low end of the number of nights in the stay.
},
"resourceName": "A 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": "A String", # Returned for successful operations.
},
],
}