Reference documentation and code samples for the Google API Common Protos Client class Decimal.
A representation of a decimal value, such as 2.5. Clients may convert values
into language-native decimal formats, such as Java's BigDecimal or
Python's decimal.Decimal.
Generated from protobuf message google.type.Decimal
Namespace
Google \ Type
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ value
string
The decimal value, as a string. The string representation consists of an optional sign, + (U+002B) or - (U+002D), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character e (U+0065) or E (U+0045) followed by one or more decimal digits. Services should normalize decimal values before storing them by: - Removing an explicitly-provided + sign (+2.5 -> 2.5). - Replacing a zero-length integer value with 0 (.5 -> 0.5). - Coercing the exponent character to lower-case (2.5E8 -> 2.5e8). - Removing an explicitly-provided zero exponent (2.5e0 -> 2.5). Services may perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: 2.5e-1 <-> 0.25). Additionally, services may preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the . character is supported to divide the integer and the fraction; ,should not be supported regardless of locale. Additionally, thousand separators should not be supported. If a service does support them, values must be normalized. The ENBF grammar is: DecimalString = [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services may choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and should round the value to fit the supported scale. Alternatively, the service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if precision would be lost. Services should error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if the service receives a value outside of the supported range.
getValue
The decimal value, as a string.
The string representation consists of an optional sign, + (U+002B)
or - (U+002D), followed by a sequence of zero or more decimal digits
("the integer"), optionally followed by a fraction, optionally followed
by an exponent.
The fraction consists of a decimal point followed by zero or more decimal
digits. The string must contain at least one digit in either the integer
or the fraction. The number formed by the sign, the integer and the
fraction is referred to as the significand.
The exponent consists of the character e (U+0065) or E (U+0045)
followed by one or more decimal digits.
Services should normalize decimal values before storing them by:
Removing an explicitly-provided + sign (+2.5 -> 2.5).
Replacing a zero-length integer value with 0 (.5 -> 0.5).
Coercing the exponent character to lower-case (2.5E8 -> 2.5e8).
Removing an explicitly-provided zero exponent (2.5e0 -> 2.5).
Services may perform additional normalization based on its own needs
and the internal decimal implementation selected, such as shifting the
decimal point and exponent value together (example: 2.5e-1 <-> 0.25).
Additionally, services may preserve trailing zeroes in the fraction
to indicate increased precision, but are not required to do so.
Note that only the . character is supported to divide the integer
and the fraction; ,should not be supported regardless of locale.
Additionally, thousand separators should not be supported. If a
service does support them, values must be normalized.
The ENBF grammar is:
DecimalString =
[Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits '.' | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services should clearly document the range of supported values, the
maximum supported precision (total number of digits), and, if applicable,
the scale (number of digits after the decimal point), as well as how it
behaves when receiving out-of-bounds values.
Services may choose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and
should round the value to fit the supported scale. Alternatively, the
service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC)
if precision would be lost.
Services should error with 400 Bad Request (INVALID_ARGUMENT in
gRPC) if the service receives a value outside of the supported range.
Returns
Type
Description
string
setValue
The decimal value, as a string.
The string representation consists of an optional sign, + (U+002B)
or - (U+002D), followed by a sequence of zero or more decimal digits
("the integer"), optionally followed by a fraction, optionally followed
by an exponent.
The fraction consists of a decimal point followed by zero or more decimal
digits. The string must contain at least one digit in either the integer
or the fraction. The number formed by the sign, the integer and the
fraction is referred to as the significand.
The exponent consists of the character e (U+0065) or E (U+0045)
followed by one or more decimal digits.
Services should normalize decimal values before storing them by:
Removing an explicitly-provided + sign (+2.5 -> 2.5).
Replacing a zero-length integer value with 0 (.5 -> 0.5).
Coercing the exponent character to lower-case (2.5E8 -> 2.5e8).
Removing an explicitly-provided zero exponent (2.5e0 -> 2.5).
Services may perform additional normalization based on its own needs
and the internal decimal implementation selected, such as shifting the
decimal point and exponent value together (example: 2.5e-1 <-> 0.25).
Additionally, services may preserve trailing zeroes in the fraction
to indicate increased precision, but are not required to do so.
Note that only the . character is supported to divide the integer
and the fraction; ,should not be supported regardless of locale.
Additionally, thousand separators should not be supported. If a
service does support them, values must be normalized.
The ENBF grammar is:
DecimalString =
[Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits '.' | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services should clearly document the range of supported values, the
maximum supported precision (total number of digits), and, if applicable,
the scale (number of digits after the decimal point), as well as how it
behaves when receiving out-of-bounds values.
Services may choose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and
should round the value to fit the supported scale. Alternatively, the
service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC)
if precision would be lost.
Services should error with 400 Bad Request (INVALID_ARGUMENT in
gRPC) if the service receives a value outside of the supported range.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google API Common Protos Client - Class Decimal (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Type.Decimal)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Type.Decimal)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Type.Decimal)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Type.Decimal)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Type.Decimal)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Type.Decimal) \nReference documentation and code samples for the Google API Common Protos Client class Decimal.\n\nA representation of a decimal value, such as 2.5. Clients may convert values\ninto language-native decimal formats, such as Java's BigDecimal or\nPython's decimal.Decimal.\n\n\\[BigDecimal\\]:\n\u003chttps://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html\u003e\n\nGenerated from protobuf message `google.type.Decimal`\n\nNamespace\n---------\n\nGoogle \\\\ Type\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getValue\n\nThe decimal value, as a string.\n\nThe string representation consists of an optional sign, `+` (`U+002B`)\nor `-` (`U+002D`), followed by a sequence of zero or more decimal digits\n(\"the integer\"), optionally followed by a fraction, optionally followed\nby an exponent.\nThe fraction consists of a decimal point followed by zero or more decimal\ndigits. The string must contain at least one digit in either the integer\nor the fraction. The number formed by the sign, the integer and the\nfraction is referred to as the significand.\nThe exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`)\nfollowed by one or more decimal digits.\nServices **should** normalize decimal values before storing them by:\n\n- Removing an explicitly-provided `+` sign (`+2.5` -\\\u003e `2.5`).\n- Replacing a zero-length integer value with `0` (`.5` -\\\u003e `0.5`).\n- Coercing the exponent character to lower-case (`2.5E8` -\\\u003e `2.5e8`).\n- Removing an explicitly-provided zero exponent (`2.5e0` -\\\u003e `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5e-1` \\\u003c-\\\u003e `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = \\[Sign\\] Significand \\[Exponent\\]; Sign = '+' \\| '-'; Significand = Digits '.' \\| \\[Digits\\] '.' Digits; Exponent = ('e' \\| 'E') \\[Sign\\] Digits; Digits = { '0' \\| '1' \\| '2' \\| '3' \\| '4' \\| '5' \\| '6' \\| '7' \\| '8' \\| '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.\n\n### setValue\n\nThe decimal value, as a string.\n\nThe string representation consists of an optional sign, `+` (`U+002B`)\nor `-` (`U+002D`), followed by a sequence of zero or more decimal digits\n(\"the integer\"), optionally followed by a fraction, optionally followed\nby an exponent.\nThe fraction consists of a decimal point followed by zero or more decimal\ndigits. The string must contain at least one digit in either the integer\nor the fraction. The number formed by the sign, the integer and the\nfraction is referred to as the significand.\nThe exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`)\nfollowed by one or more decimal digits.\nServices **should** normalize decimal values before storing them by:\n\n- Removing an explicitly-provided `+` sign (`+2.5` -\\\u003e `2.5`).\n- Replacing a zero-length integer value with `0` (`.5` -\\\u003e `0.5`).\n- Coercing the exponent character to lower-case (`2.5E8` -\\\u003e `2.5e8`).\n- Removing an explicitly-provided zero exponent (`2.5e0` -\\\u003e `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5e-1` \\\u003c-\\\u003e `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = \\[Sign\\] Significand \\[Exponent\\]; Sign = '+' \\| '-'; Significand = Digits '.' \\| \\[Digits\\] '.' Digits; Exponent = ('e' \\| 'E') \\[Sign\\] Digits; Digits = { '0' \\| '1' \\| '2' \\| '3' \\| '4' \\| '5' \\| '6' \\| '7' \\| '8' \\| '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range."]]
