RequestMetadata

  • Requests require metadata, including a unique requestId, an issuerId, and the API version.

  • The requestId is a unique identifier for each request, crucial for debugging and tracking failures.

  • The version field specifies the API version in use and consists of major and minor version numbers.

  • The issuerId field indicates the issuer associated with the request, used for filtering traffic during debugging.

The metadata about the request, required in all requests.

JSON representation 
{
  "requestId": string,
  "version": {
    object (Version)
  },
  "issuerId": string
}
Fields
requestId

string

An id used to identify this specific request, and should be different for every retry.

This is used for debugging purposes, such as identifying requests that failed. No idempotency requirements are attached to this

Ex: UUID
version

object (Version)

The version of the API being used.

This should be checked against the version of the API implemented by the server, and the request should be rejected if they do not match.
issuerId

string

The id of the issuer Google is communicating with.

This can be used to quickly filter on the specific issuer's traffic while debugging.

Ex: FreeFormState_ISO2Country_MDL

Version

An object representing the version of the API.

JSON representation 
{
  "major": integer,
  "minor": integer
}
Fields
major

integer

The major version number of the API.

Ex: for version 1.2, this would be 1
minor

integer

The minor version number of the API.

Ex: for version 1.2, this would be 2