Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes seasonality adjustments. Operation statuses are returned.
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates, or removes seasonality adjustments. Operation statuses are returned.
Args:
customerId: string, Required. ID of the customer whose seasonality adjustments are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BiddingSeasonalityAdjustmentService.MutateBiddingSeasonalityAdjustments.
"operations": [ # Required. The list of operations to perform on individual seasonality adjustments.
{ # A single operation (create, remove, update) on a seasonality adjustment.
"create": { # Represents a bidding seasonality adjustment. Cannot be used in manager accounts. See "About seasonality adjustments" at https://support.google.com/google-ads/answer/10369906. # Create operation: No resource name is expected for the new seasonality adjustment.
"advertisingChannelTypes": [ # The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"campaigns": [ # The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"conversionRateModifier": 3.14, # Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.
"description": "A String", # The description of the seasonality adjustment. The description can be at most 2048 characters.
"devices": [ # If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.
"A String",
],
"endDateTime": "A String", # Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
"name": "A String", # The name of the seasonality adjustment. The name can be at most 255 characters.
"resourceName": "A String", # Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form: `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
"scope": "A String", # The scope of the seasonality adjustment.
"seasonalityAdjustmentId": "A String", # Output only. The ID of the seasonality adjustment.
"startDateTime": "A String", # Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. A seasonality adjustment is forward looking and should be used for events that start and end in the future.
"status": "A String", # Output only. The status of the seasonality adjustment.
},
"remove": "A String", # Remove operation: A resource name for the removed seasonality adjustment is expected, in this format: `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
"update": { # Represents a bidding seasonality adjustment. Cannot be used in manager accounts. See "About seasonality adjustments" at https://support.google.com/google-ads/answer/10369906. # Update operation: The seasonality adjustment is expected to have a valid resource name.
"advertisingChannelTypes": [ # The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"campaigns": [ # The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"conversionRateModifier": 3.14, # Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.
"description": "A String", # The description of the seasonality adjustment. The description can be at most 2048 characters.
"devices": [ # If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.
"A String",
],
"endDateTime": "A String", # Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
"name": "A String", # The name of the seasonality adjustment. The name can be at most 255 characters.
"resourceName": "A String", # Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form: `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
"scope": "A String", # The scope of the seasonality adjustment.
"seasonalityAdjustmentId": "A String", # Output only. The ID of the seasonality adjustment.
"startDateTime": "A String", # Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. A seasonality adjustment is forward looking and should be used for events that start and end in the future.
"status": "A String", # Output only. The status of the seasonality adjustment.
},
"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 seasonality adjustments 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 seasonality adjustment mutate.
"biddingSeasonalityAdjustment": { # Represents a bidding seasonality adjustment. Cannot be used in manager accounts. See "About seasonality adjustments" at https://support.google.com/google-ads/answer/10369906. # The mutated bidding seasonality adjustment with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
"advertisingChannelTypes": [ # The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"campaigns": [ # The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.
"A String",
],
"conversionRateModifier": 3.14, # Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.
"description": "A String", # The description of the seasonality adjustment. The description can be at most 2048 characters.
"devices": [ # If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.
"A String",
],
"endDateTime": "A String", # Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days].
"name": "A String", # The name of the seasonality adjustment. The name can be at most 255 characters.
"resourceName": "A String", # Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form: `customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}`
"scope": "A String", # The scope of the seasonality adjustment.
"seasonalityAdjustmentId": "A String", # Output only. The ID of the seasonality adjustment.
"startDateTime": "A String", # Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format. A seasonality adjustment is forward looking and should be used for events that start and end in the future.
"status": "A String", # Output only. The status of the seasonality adjustment.
},
"resourceName": "A String", # Returned for successful operations.
},
],
}