Skip to content

Latest commit

 

History

History
93 lines (65 loc) · 3.28 KB

amp-pixel.md

File metadata and controls

93 lines (65 loc) · 3.28 KB
Raw

amp-pixel

[TOC]

Description Can be used as a typical tracking pixel to count pageviews.
Supported Layouts fixed, nodisplay
Examples See AMP By Example's amp-pixel example.

Behavior

The amp-pixel component behaves like a simple tracking pixel img. It takes a single URL, but provides variables that can be replaced by the component in the URL string when making the request. See the substitutions section for further details.

In this basic example, the amp-pixel issues a simple GET request to the given URL and ignores the result.

<amp-pixel src="https://foo.com/tracker/foo"
    layout="nodisplay"></amp-pixel>

Attributes

src (required)

A simple URL to a remote endpoint that must be https protocol.

referrerpolicy (optional)

This attribute is similar to the referrerpolicy attribute on <img>, however no-referrer is the only accepted value. If referrerpolicy=no-referrer is specified, the referrer header is removed from the HTTP request.

<amp-pixel src="https://foo.com/tracker/foo"
    layout="nodisplay"
    referrerpolicy="no-referrer"></amp-pixel>
allow-ssr-img (optional)

This attribute used in AMP4ADS creatives indicates that as part of post validation transformation, an img element may be placed directly within the amp-pixel element allowing the ping to be sent in parallel with AMP runtime fetch/execution. Note that it means that any macros within the url will NOT be expanded so only use if they are not present in the src.

common attributes

This element includes common attributes extended to AMP components.

Substitutions

The amp-pixel allows all standard URL variable substitutions. See the Substitutions Guide for more information.

In the following example, a request might be made to something like https://foo.com/pixel?0.8390278471201 where the RANDOM value is randomly generated upon each impression.

<amp-pixel src="https://foo.com/pixel?RANDOM"
    layout="nodisplay"></amp-pixel>

Styling

amp-pixel should not be styled.

Validation

See amp-pixel rules in the AMP validator specification.