Search Ads 360 Reporting API . customers . campaignBidModifiers

close()

Close httplib2 connections.

mutate(customerId, body=None, x__xgafv=None)

Creates, updates, or removes campaign bid modifiers. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

Args:
  customerId: string, Required. ID of the customer whose campaign bid modifiers are being modified. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for CampaignBidModifierService.MutateCampaignBidModifiers.
  "operations": [ # Required. The list of operations to perform on individual campaign bid modifiers.
    { # A single operation (create, remove, update) on a campaign bid modifier.
      "create": { # Represents a bid-modifiable only criterion at the campaign level. # Create operation: No resource name is expected for the new campaign bid modifier.
        "bidModifier": 3.14, # The modifier for the bid when the criterion matches.
        "campaign": "A String", # Output only. The campaign to which this criterion belongs.
        "criterionId": "A String", # Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
        "interactionType": { # Criterion for Interaction Type. # Immutable. Criterion for interaction type. Only supported for search campaigns.
          "type": "A String", # The interaction type.
        },
        "resourceName": "A String", # Immutable. The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: `customers/{customer_id}/campaignBidModifiers/{campaign_id}~{criterion_id}`
      },
      "remove": "A String", # Remove operation: A resource name for the removed campaign bid modifier is expected, in this format: `customers/{customer_id}/CampaignBidModifiers/{campaign_id}~{criterion_id}`
      "update": { # Represents a bid-modifiable only criterion at the campaign level. # Update operation: The campaign bid modifier is expected to have a valid resource name.
        "bidModifier": 3.14, # The modifier for the bid when the criterion matches.
        "campaign": "A String", # Output only. The campaign to which this criterion belongs.
        "criterionId": "A String", # Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
        "interactionType": { # Criterion for Interaction Type. # Immutable. Criterion for interaction type. Only supported for search campaigns.
          "type": "A String", # The interaction type.
        },
        "resourceName": "A String", # Immutable. The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: `customers/{customer_id}/campaignBidModifiers/{campaign_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 campaign 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.
      "campaignBidModifier": { # Represents a bid-modifiable only criterion at the campaign level. # The mutated campaign bid modifier with only mutable fields after mutate. The field will only be returned when response_content_type is set to "MUTABLE_RESOURCE".
        "bidModifier": 3.14, # The modifier for the bid when the criterion matches.
        "campaign": "A String", # Output only. The campaign to which this criterion belongs.
        "criterionId": "A String", # Output only. The ID of the criterion to bid modify. This field is ignored for mutates.
        "interactionType": { # Criterion for Interaction Type. # Immutable. Criterion for interaction type. Only supported for search campaigns.
          "type": "A String", # The interaction type.
        },
        "resourceName": "A String", # Immutable. The resource name of the campaign bid modifier. Campaign bid modifier resource names have the form: `customers/{customer_id}/campaignBidModifiers/{campaign_id}~{criterion_id}`
      },
      "resourceName": "A String", # Returned for successful operations.
    },
  ],
}