REST Resource: projects.locations.brands.menuIssueClusters

• Resource: MenuIssueCluster
  • JSON representation
• ClusteredEntityIssue
  • JSON representation
• Methods

Resource: MenuIssueCluster

Represents a brand-level root-cause cluster of menu issues aggregated across one or more stores.

JSON representation
{ "name": string, "title": string, "description": string, "actionPlan": string, "issueCategories": [ string ], "entityTypes": [ enum (EntityType) ], "affectedStoreCount": integer, "affectedEntityCount": integer, "totalIssueCount": integer, "entityIssues": [ { object (ClusteredEntityIssue) } ], "createTime": string }

Fields
name	string Identifier. The resource name of the menu issue cluster. Format: projects/{project}/locations/{location}/brands/{brand}/menuIssueClusters/{menu_issue_cluster}
title	string Output only. A concise, human-readable title summarizing the shared root cause of the cluster.
description	string Output only. A detailed explanation of the shared root cause across all issues in the cluster.
actionPlan	string Output only. A free-text summary of the recommended operator action plan to resolve the shared root cause. Entity-specific remediation actions are available on entityIssues.
issueCategories[]	string Output only. Issue categories present in this cluster (e.g. MISSING_CATEGORY, MODIFIER_AS_PRIMARY_ITEM).
entityTypes[]	enum (EntityType) Output only. Entity types present in this cluster.
affectedStoreCount	integer Output only. The number of stores in the brand affected by this cluster.
affectedEntityCount	integer Output only. The number of unique menu entities affected in this cluster.
totalIssueCount	integer Output only. The total number of store-level menu issues grouped into this cluster.
entityIssues[]	object (ClusteredEntityIssue) Output only. The entity issues in this cluster, each with its own remediation actions. Only returned in MENU_ISSUE_CLUSTER_VIEW_FULL.
createTime	string (Timestamp format) Output only. The time this cluster was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

ClusteredEntityIssue

Represents a deduplicated menu entity issue within a brand-level MenuIssueCluster, aggregated across all stores where the entity exhibits the issue.

JSON representation
{ "entityId": string, "entityDisplayName": string, "entityType": enum (EntityType), "issueCategory": string, "explanation": string, "confidenceLevel": enum (ConfidenceLevel), "suggestedRemediationActions": [ { object (RemediationAction) } ], "affectedStoreCount": integer }

Fields
entityId	string Output only. The ID of the affected menu entity.
entityDisplayName	string Output only. Human-readable display name of the affected entity.
entityType	enum (EntityType) Output only. The type of the affected entity.
issueCategory	string Output only. The category of the issue flagged on this entity.
explanation	string Output only. A representative explanation of why the issue was flagged on this entity.
confidenceLevel	enum (ConfidenceLevel) Output only. The highest confidence level observed for this entity issue across stores.
suggestedRemediationActions[]	object (RemediationAction) Output only. Entity-specific remediation actions recommended to fix this issue (including entity-specific rename or category payloads).
affectedStoreCount	integer Output only. The number of stores where this entity issue was detected.

Methods
get	Gets a menu issue cluster.
list	Lists menu issue clusters for a brand.