HomeComparisonCard

Required access

read_home access scope

Holds the contents of any card using the comparison layout view template.

Show definition
# Holds the contents of any card using the comparison layout view template.
type HomeComparisonCard implements HomeCard {
  # Specifies which badge applies to the card.
  badge: HomeBadge

  # A list of buttons displayed on the card.
  buttons: [HomeButton!]!

  # Specifies a time window that the contents of the card applies to.
  dateRange: FormattedString

  # 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(
    # Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
    maxWidth: Int

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

    # Converts image file type from SVG to PNG, or leaves as original SVG.
    contentType: HomeContentType = PNG
  ): Image

  # Semantic type of a Home Card image. These can be used to treat images differently in the UI.
  imageType: HomeImageType

  # 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!

  # Text for the header of the card.
  title: FormattedString!

  # Feedback information on the industry classification.
  industryFeedback: HomeComparisonCardIndustryFeedback

  # A list of metrics contained in the comparison card.
  metrics: [HomeComparisonMetric!]!
}

Implements

Fields

badge   (HomeBadge)

Specifies which badge applies to the card.

Required access

read_ access scope

buttons   ([HomeButton!]!)

A list of buttons displayed on the card.

Required access

read_ access scope

dateRange   (FormattedString)

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

Required access

read_ access scope

dismissMessage   (String!)

A message displayed when the user dismisses the card.

Required access

read_ access scope

dismissTitle   (String!)

A title displayed when the user dismisses the card.

Required access

read_ access scope

Specifies if this card should be considered to be featured inside of the feed theme header.

Required access

read_ access scope

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.

Required access

read_ access scope

id   (ID!)

ID of the card.

Required access

read_ access scope

image   (Image)

An image displayed on the card.

Required access

read_ access scope

Argument Type Default Description
contentType

HomeContentType

PNG

Converts image file type from SVG to PNG, or leaves as original SVG.

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.

imageType   (HomeImageType)

Semantic type of a Home Card image. These can be used to treat images differently in the UI.

Required access

read_ access scope

industryFeedback   (HomeComparisonCardIndustryFeedback)

Feedback information on the industry classification.

Required access

read_ access scope

layout   (HomeCardLayout!)

Specifies a view template to use when rendering the card.

Required access

read_ access scope

message   (FormattedString)

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

Required access

read_ access scope

metrics   ([HomeComparisonMetric!]!)

A list of metrics contained in the comparison card.

Required access

read_ access scope

showVote   (Boolean!)

Specifies if this card can be voted on.

Required access

read_ access scope

spotlight   (Boolean!)

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

Required access

read_ access scope

title   (FormattedString!)

Text for the header of the card.

Required access

read_ access scope

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

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up