OBJECT

MarketingText

Text that supports the marketing of a product, such as a review, short description, or table of contents

link GraphQL Schema definition

  • type MarketingText {
  • # An alternative version of the public marketing text
  • #
  • # Arguments
  • # stripHtml: When true, HTML is removed from the text (default is
  • # FALSE)
  • alternateExternalText(stripHtml: Boolean): String!
  • # An alternative version of the alternative public marketing text
  • alternateExternalTextMarkdown: String!
  • # The system or in-house approval status
  • approvalStatus: ApprovalStatus
  • approvalStatusName: String
  • # When the review was first published
  • datePublished: ISO8601Date
  • # When the review is embargoed until
  • dateReleased: ISO8601Date
  • # The marketing text destined for public viewing
  • #
  • # Arguments
  • # stripHtml: When true, HTML is removed from the text (default is
  • # FALSE)
  • externalText(stripHtml: Boolean): String!
  • # The marketing text destined for public viewing
  • externalTextMarkdown: String!
  • # The number of characters in the external text
  • externalTextNumberOfCharacters: Int!
  • # The format of the text, derived from the content itself
  • formatDescription: String
  • # The date from which a marketing text may be referenced or used. The content is
  • # intended to be embargoed by recipients until this date.
  • fromDate: ISO8601Date
  • htmlCharsCount: String
  • # The marketing text's unique Consonance identifier
  • id: Int
  • # The marketing text destined for internal viewing
  • #
  • # Arguments
  • # stripHtml: When true, HTML is removed from the text (default is
  • # FALSE)
  • internalText(stripHtml: Boolean): String!
  • # The marketing text for your own internal use
  • internalTextMarkdown: String!
  • # The number of characters in the internal text
  • internalTextNumberOfCharacters: Int!
  • # The language. A code from [ONIX code list
  • # 74](https://ns.editeur.org/onix/en/74), Language.
  • language: ONIXCode
  • onix2Only: Boolean
  • # The audiences for which the text is intended
  • onixContentAudienceCodes: [ONIXContentAudienceCode!]!
  • # The audiences for which the text is intended
  • onixContentAudiences: [ONIXCode!]!
  • # The language code
  • onixLanguageCode: ONIXLanguageCode
  • # The IDs of products linked to this marketing text
  • productIds: [Int!]!
  • # The products with which this marketing text is associated.
  • #
  • # Consider whether it might be more efficient or applicable for your use case to
  • # instead use the field "marketingTexts" on the Product type, especially if you
  • # are retrieving data for a single product and you want its specific marketing
  • # texts.
  • products: [Product!]!
  • # Where the review appeared e.g. The Guardian
  • publicationName: String
  • # The publisher of the review e.g. The Guardian
  • publisher: Contact
  • # The location of the review on the internet
  • reviewUrl: String
  • # The person who wrote the review
  • reviewer: Contact
  • # A number which specifies the sequence of contributions on the work
  • sequenceNumber: Int!
  • # The marketing text destined for public viewing
  • uncleanedExternalText: String!
  • # The date until which a marketing text may be referenced or used
  • untilDate: ISO8601Date
  • # The variant of the marketing text, such as short description
  • variant: MarketingTextVariant!
  • }