GoogleAdsGoogleadsV25Services__MutateConversionCustomVariablesRequest

{
  "$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-conversion-custom-variables-request-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateConversionCustomVariablesRequest",
  "description": "Request message for ConversionCustomVariableService.MutateConversionCustomVariables.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-conversioncustomvariables-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateConversionCustomVariablesRequest",
  "type": "object",
  "properties": {
    "validateOnly": {
      "type": "boolean",
      "description": "If true, the request is validated but not executed. Only errors are returned, not results."
    },
    "responseContentType": {
      "type": "string",
      "description": "The response content type setting. Determines whether the mutable resource or just the resource name should be returned post mutation.",
      "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"
      ]
    },
    "operations": {
      "description": "Required. The list of operations to perform on individual conversion custom variables.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__ConversionCustomVariableOperation"
      },
      "type": "array"
    },
    "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."
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__ConversionCustomVariable": {
      "description": "A conversion custom variable See \"About custom variables for conversions\" at https://support.google.com/google-ads/answer/9964350",
      "type": "object",
      "properties": {
        "id": {
          "format": "int64",
          "type": "string",
          "description": "Output only. The ID of the conversion custom variable."
        },
        "status": {
          "x-enumDescriptions": [
            "Not specified.",
            "Used for return value only. Represents value unknown in this version.",
            "The conversion custom variable is pending activation and will not accrue stats until set to ENABLED. This status can't be used in CREATE and UPDATE requests.",
            "The conversion custom variable is enabled and will accrue stats.",
            "The conversion custom variable is paused and will not accrue stats until set to ENABLED again."
          ],
          "enum": [
            "UNSPECIFIED",
            "UNKNOWN",
            "ACTIVATION_NEEDED",
            "ENABLED",
            "PAUSED"
          ],
          "description": "The status of the conversion custom variable for conversion event accrual.",
          "type": "string"
        },
        "name": {
          "type": "string",
          "description": "Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after."
        },
        "resourceName": {
          "type": "string",
          "description": "Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form: `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`"
        },
        "tag": {
          "description": "Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet and sent to Google Ads along with conversion pings. For conversion uploads in Google Ads API, the resource name of the conversion custom variable is used. Tag should be unique. The maximum size of tag is 100 bytes. There should not be any extra spaces before and after. Currently only lowercase letters, numbers and underscores are allowed in the tag.",
          "type": "string"
        },
        "ownerCustomer": {
          "type": "string",
          "description": "Output only. The resource name of the customer that owns the conversion custom variable."
        }
      }
    },
    "GoogleAdsGoogleadsV25Services__ConversionCustomVariableOperation": {
      "description": "A single operation (create, update) on a conversion custom variable.",
      "type": "object",
      "properties": {
        "update": {
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__ConversionCustomVariable",
          "description": "Update operation: The conversion custom variable is expected to have a valid resource name."
        },
        "updateMask": {
          "format": "google-fieldmask",
          "description": "FieldMask that determines which resource fields are modified in an update.",
          "type": "string"
        },
        "create": {
          "description": "Create operation: No resource name is expected for the new conversion custom variable.",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__ConversionCustomVariable"
        }
      }
    }
  }
}