Method: issueresolution.renderproductissues

Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.

HTTP request

POST https://merchantapi.googleapis.com/issueresolution/v1/{name=accounts/*/products/*}:renderproductissues

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the product to fetch issues for. Format: accounts/{account}/products/{product}

Query parameters

Parameters
languageCode

string

Optional. The IETF BCP-47 language code used to localize an issue resolution content. If not set, the result will be in default language en-US.
timeZone

string

Optional. The IANA timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.
productIdBase64UrlEncoded

boolean

Optional. If true, the {product} in the name field of the request will be interpreted as unpadded base64url-encoded and decoded during request processing to match the decoded value. Default value is false. Use this if your {product} contains special characters, such as forward slash / or other characters that are unpadded base64url-encoded (as per RFC 7515: https://datatracker.ietf.org/doc/html/rfc7515#section-2).

Note that future versions of the API will only accept unpadded base64url-encoded product ids, so we strongly recommend proactively setting this to true and encoding the product ids.

Request body

The request body contains an instance of RenderIssuesRequestPayload.

Response body

Response containing an issue resolution content and actions for listed product issues.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "renderedIssues": [
    {
      object (RenderedIssue)
    }
  ]
}
Fields
renderedIssues[]

object (RenderedIssue)

List of issues for a given product.

This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.