HomeProgressCard

Version 2019-04 (latest)

Card showing progress towards a target.

Required access

read_home access scope

Show definition
"""
Card showing progress towards a target.
"""
type HomeProgressCard implements HomeCard {
  """
  Specifies which badge applies to the card.
  """
  badge: HomeBadge
  """
  The value currentValue is being compared to.
  """
  comparisonValue: Int!
  """
  The label for the comparisonValue metric.
  """
  comparisonValueLabel: String!
  """
  Current point of progress towards target. Cannot be more than the targetValue.
  """
  currentValue: Int!
  """
  The label for the currentValue metric.
  """
  currentValueLabel: String!
  """
  Specifies a time window that the contents of the card applies to.
  """
  dateRange: FormattedString
  """
  Details about the target being tracked.
  """
  description: String!
  """
  A message displayed when the user dismisses the card.
  """
  dismissMessage: String!
  """
  A title displayed when the user dismisses the card.
  """
  dismissTitle: String!
  """
  Specifies if this card should be considered to be featured inside of the feed theme header.
  """
  featured: Boolean!
  """
  A list of predefined messages and intents the user can select from when
  sending feedback about the card. Intent can be used to pre-filter feedback
  messages by their tone.
  """
  feedback: [HomeCardFeedback!]!
  """
  A list of predefined messages the user can select from when sending feedback about the card.
  """
  feedbackOptions: [String!]!
  """
  ID of the card.
  """
  id: ID!
  """
  An image displayed on the card.
  """
  image(
    """
    Converts image file type from SVG to PNG, or leaves as original SVG.
    """
    contentType: HomeContentType = PNG
    """
    Image height in pixels between 1 and 2048. This argument is deprecated: Use
    maxHeight on Image.transformedSrc instead.
    """
    maxHeight: Int
    """
    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    """
    maxWidth: Int
  ): Image
  """
  Specifies a view template to use when rendering the card.
  """
  layout: HomeCardLayout!
  """
  A more detailed description of the card, typically containing the actual messaging to the merchant.
  """
  message: FormattedString
  """
  Specifies if this card can be voted on.
  """
  showVote: Boolean!
  """
  Specifies if this card can be pulled up into a priority container on top of the feed.
  """
  spotlight: Boolean!
  """
  The value needed to meet the target.
  """
  targetValue: Int!
  """
  The label for the targetValue metric.
  """
  targetValueLabel: String!
  """
  Text for the header of the card.
  """
  title: FormattedString!
}

Implements

Fields

badge (HomeBadge)

Specifies which badge applies to the card.

comparisonValue (Int!)

The value currentValue is being compared to.

comparisonValueLabel (String!)

The label for the comparisonValue metric.

currentValue (Int!)

Current point of progress towards target. Cannot be more than the targetValue.

currentValueLabel (String!)

The label for the currentValue metric.

dateRange (FormattedString)

Specifies a time window that the contents of the card applies to.

description (String!)

Details about the target being tracked.

dismissMessage (String!)

A message displayed when the user dismisses the card.

dismissTitle (String!)

A title displayed when the user dismisses the card.

feedback ([HomeCardFeedback!]!)

A list of predefined messages and intents the user can select from when sending feedback about the card. Intent can be used to pre-filter feedback messages by their tone.

id (ID!)

ID of the card.

image (Image)

An image displayed on the card.

contentType ( HomeContentType )

Converts image file type from SVG to PNG, or leaves as original SVG.
Default value: true

maxHeight ( Int )

Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

maxWidth ( Int )

Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

layout (HomeCardLayout!)

Specifies a view template to use when rendering the card.

message (FormattedString)

A more detailed description of the card, typically containing the actual messaging to the merchant.

showVote (Boolean!)

Specifies if this card can be voted on.

spotlight (Boolean!)

Specifies if this card can be pulled up into a priority container on top of the feed.

targetValue (Int!)

The value needed to meet the target.

title (FormattedString!)

Text for the header of the card.

Deprecated fields

Show/Hide
feedbackOptions ([String!]!) deprecated

A list of predefined messages the user can select from when sending feedback about the card.

Deprecation warning

Use feedback instead

targetValueLabel (String!) deprecated

The label for the targetValue metric.

Deprecation warning

The targetValue metric no longer has an associated label. Please look at comparisonValueLabel instead. This field will return the same value as comparisonValueLabel.

Sign up for a Partner account to get started.

Sign up