Skip to main content

Module prelude

Module prelude 

Source
Expand description

Common presence primitive reexports.

Structs§

AggregateRating
Aggregate rating primitive.
AlternateUrl
An alternate URL with an optional hreflang tag.
Article
Article primitive.
AttributionCredit
Attribution credit represented as a 0.0..=1.0 share.
AttributionMedium
AttributionSource
AttributionWindow
Attribution window represented in days.
BotName
Bot name label used with robots directives.
Breadcrumb
Breadcrumb primitive.
BusinessLocation
A business location label or address string.
CampaignFlight
Campaign flight labels.
CampaignId
CampaignLabel
CampaignMedium
CampaignName
CanonicalGroup
A canonical URL with alternates and duplicate-surface hints.
CanonicalUrl
A canonical URL label.
Citation
A citation mention for a listing.
ConversionLabel
DirectTraffic
Direct traffic marker.
EmailTraffic
Email traffic label.
FAQ
FAQ structured-data primitive.
FAQEntry
FAQ entry primitive.
GeoPoint
A latitude/longitude point used as a presence targeting label.
GeoRegionCode
A compact region code used for discovery or targeting labels.
HreflangTag
A hreflang tag for alternate URLs.
LastModified
Last-modified label for sitemap entries.
ListingName
A business or directory listing name.
ListingProfile
A business listing profile descriptor.
ListingProvider
A directory, listing, or citation provider label.
ListingUrl
A listing profile URL.
LocalBusiness
Local business primitive.
LocalCategory
Local category label for external surfaces.
LocationRadius
A positive radius around a location, stored in meters.
MetaDescription
A validated meta description label.
MetadataDescription
Page metadata description.
MetadataTitle
Page metadata title.
NapConsistency
Consistency result for name/address/phone fields.
NapRecord
A name/address/phone record used for consistency checks.
OpenGraphImage
Open Graph image metadata.
OpeningHoursLabel
Human-readable opening-hours label.
OpeningHoursSpecification
Opening-hours specification primitive.
OrganicTraffic
Organic traffic label.
Organization
Organization primitive.
PageMetadata
Page metadata for external surfaces.
PaidTraffic
Paid traffic label.
PostalAddress
Postal address primitive for structured-data records.
Priority
Sitemap priority value in the inclusive 0.0..=1.0 range.
Product
Product primitive.
ReferralTraffic
Referral traffic label.
ReferrerHost
Referrer host label.
ReferrerUrl
Referrer URL label.
RobotsDirective
A robots directive set suitable for meta content formatting.
SearchSnippetMetadata
Search snippet metadata composed from focused SEO primitives.
SeoTitle
A validated SEO title label.
ServiceArea
A named service area used for local discovery and targeting.
ServiceAreaBusiness
A local service-area business record.
SitemapEntry
A sitemap URL entry.
SitemapIndexEntry
A sitemap index entry.
SitemapUrl
A validated sitemap URL.
SlugHint
A normalized slug hint for a page or entity.
SocialPreview
Social preview metadata.
SocialTraffic
Social traffic label.
Touchpoint
Attribution touchpoint primitive.
UtmCampaign
UtmContent
UtmMedium
UtmParameters
UTM parameter set.
UtmSource
UtmTerm
UtmUrl
A URL with UTM parameters attached.

Enums§

ArchiveDirective
Archive directive.
AttributionModelKind
Attribution model kind label.
BusinessPresenceKind
Local business presence shape.
CampaignChannel
Generic campaign channel label.
CampaignStatus
Campaign status label.
ChangeFrequency
Sitemap change frequency label.
DuplicateSurfaceHint
Duplicate surface hint for canonical grouping.
FollowDirective
Link-following directive.
GeoTarget
Geographic targeting shape for presence and discovery surfaces.
IndexDirective
Indexing directive.
IndexingHint
Search indexing intent for a page.
LinkRelationHint
Link relation hints used by external surfaces.
ListingStatus
Status label for a listing profile.
LocalVisibilityHint
Local visibility hint for external profiles.
OpenGraphType
Open Graph type label.
PageIntent
Page intent labels for search snippets and metadata.
RedirectKind
Redirect relationship kind.
ReferrerKind
Referrer classification label.
SnippetDirective
Snippet directive.
SourceKind
Source classification label.
TwitterCardKind
Twitter card kind label.

Functions§

classify_referrer_host
Classifies a referrer host.
classify_source_kind
Classifies a source label.
classify_source_medium
Classifies source and medium labels into a referrer kind.
escape_xml
Escapes the XML characters required by sitemap formatting helpers.
parse_utm_parameters
Parses UTM parameters from a query string or URL.