UTMParameters object

Version unstable

Represents a set of UTM parameters.

Fields

  • campaign (String)

    The name of a marketing campaign.

  • content (String)

    Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.

  • medium (String)

    The medium of a marketing campaign, such as a banner or email newsletter.

  • source (String)

    The source of traffic to the merchant's store, such as Google or an email newsletter.

  • term (String)

    Paid search terms used by a marketing campaign.

Types that return UTMParameters

Version 2021-10 (Release candidate)

Represents a set of UTM parameters.

Fields

  • campaign (String)

    The name of a marketing campaign.

  • content (String)

    Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.

  • medium (String)

    The medium of a marketing campaign, such as a banner or email newsletter.

  • source (String)

    The source of traffic to the merchant's store, such as Google or an email newsletter.

  • term (String)

    Paid search terms used by a marketing campaign.

Types that return UTMParameters

Version 2021-07 (Latest)

Represents a set of UTM parameters.

Fields

  • campaign (String)

    The name of a marketing campaign.

  • content (String)

    Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.