GoogleAdsGoogleadsV25Services__MutateAdParametersResponse

{
  "$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-ad-parameters-response-schema.json",
  "title": "GoogleAdsGoogleadsV25Services__MutateAdParametersResponse",
  "description": "Response message for an ad parameter mutate.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-ads-customers-adparameters-api-openapi.yml#/components/schemas/GoogleAdsGoogleadsV25Services__MutateAdParametersResponse",
  "type": "object",
  "properties": {
    "partialFailureError": {
      "$ref": "#/$defs/GoogleRpc__Status",
      "description": "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."
    },
    "results": {
      "type": "array",
      "description": "All results for the mutate.",
      "items": {
        "$ref": "#/$defs/GoogleAdsGoogleadsV25Services__MutateAdParameterResult"
      }
    }
  },
  "$defs": {
    "GoogleAdsGoogleadsV25Resources__AdParameter": {
      "type": "object",
      "properties": {
        "adGroupCriterion": {
          "type": "string",
          "description": "Immutable. The ad group criterion that this ad parameter belongs to."
        },
        "resourceName": {
          "type": "string",
          "description": "Immutable. The resource name of the ad parameter. Ad parameter resource names have the form: `customers/{customer_id}/adParameters/{ad_group_id}~{criterion_id}~{parameter_index}`"
        },
        "parameterIndex": {
          "description": "Immutable. The unique index of this ad parameter. Must be either 1 or 2.",
          "type": "string",
          "format": "int64"
        },
        "insertionText": {
          "type": "string",
          "description": "Numeric value to insert into the ad text. The following restrictions apply: - Can use comma or period as a separator, with an optional period or comma (respectively) for fractional values. For example, 1,000,000.00 and 2.000.000,10 are valid. - Can be prepended or appended with a currency symbol. For example, $99.99 is valid. - Can be prepended or appended with a currency code. For example, 99.99USD and EUR200 are valid. - Can use '%'. For example, 1.0% and 1,0% are valid. - Can use plus or minus. For example, -10.99 and 25+ are valid. - Can use '/' between two numbers. For example 4/1 and 0.95/0.45 are valid."
        }
      },
      "description": "An ad parameter that is used to update numeric values (such as prices or inventory levels) in any text line of an ad (including URLs). There can be a maximum of two AdParameters per ad group criterion. (One with parameter_index = 1 and one with parameter_index = 2.) In the ad the parameters are referenced by a placeholder of the form \"{param#:value}\". For example, \"{param1:$17}\""
    },
    "GoogleAdsGoogleadsV25Services__MutateAdParameterResult": {
      "description": "The result for the ad parameter mutate.",
      "type": "object",
      "properties": {
        "adParameter": {
          "description": "The mutated AdParameter with only mutable fields after mutate. The field will only be returned when response_content_type is set to \"MUTABLE_RESOURCE\".",
          "$ref": "#/$defs/GoogleAdsGoogleadsV25Resources__AdParameter"
        },
        "resourceName": {
          "description": "The resource name returned for successful operations.",
          "type": "string"
        }
      }
    },
    "GoogleRpc__Status": {
      "description": "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).",
      "type": "object",
      "properties": {
        "message": {
          "description": "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.",
          "type": "string"
        },
        "code": {
          "type": "integer",
          "description": "The status code, which should be an enum value of google.rpc.Code.",
          "format": "int32"
        },
        "details": {
          "type": "array",
          "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
          "items": {
            "type": "object",
            "additionalProperties": {
              "description": "Properties of the object. Contains field @type with type URL."
            }
          }
        }
      }
    }
  }
}