Important: this documentation is not applicable to your currently selected format stories!

amp-auto-ads

Description

通过使用远程提供的配置文件，向 AMP 网页中动态投放广告。

Required Scripts

<script async custom-element="amp-auto-ads" src="https://cdn.ampproject.org/v0/amp-auto-ads-0.1.js"></script>

通过使用远程提供的配置文件，向 AMP 网页中动态投放广告

提供方式	实验性组件
必需的脚本	`<script async custom-element="amp-auto-ads" src="https://cdn.ampproject.org/v0/amp-auto-ads-0.1.js"></script>`
支持的布局	无

行为

在获得足够多的有效展示位置（在配置中提供）后，amp-auto-ads 会尝试植入更多广告，同时遵守相应广告联盟指定的一系列限制。这些限制会限制以下内容：

可植入的广告总数
任意相邻广告之间应保持的最短距离

除此之外，广告只能植入到网页上不会导致不可接受的重排（取决于 attemptChangeSize）的位置中。

<amp-auto-ads> 标记应作为 <body> 的第一个子级放置。

广告联盟类型和任何其他信息（广告联盟要求提供）都应在此标记中指定。

<amp-auto-ads
    type="adsense"
    data-ad-client="ca-pub-5439573510495356">
  </amp-auto-ads>

支持的广告联盟

属性

type（必需）	广告联盟的标识符。
data-foo-bar	大多数广告联盟都需要进行进一步配置，可使用 HTML `data-` 属性传递到联盟。参数名称需进行标准数据属性短划线到驼峰式大小写转换。例如，“data-foo-bar”会作为“fooBar”发送到广告以进行配置。如需了解可以使用的属性，请参阅广告联盟的文档。
常见属性	此元素包含扩展到 AMP 组件的常见属性。

配置规范

该配置定义 <amp-auto-ads> 可以在网页上的哪些位置放置广告。该配置可从位于 ad-network-config.js 中定义的网址中的第三方广告联盟获取。该配置应该是序列化 JSON 对象，与下文所述的 ConfigObj 定义相符。

配置示例

下面的示例指定广告应紧跟着放在网页上第三个 <DIV id='domId'> 中的所有 <P class='paragraph'> 元素的后面。在以上任意位置展示的广告的类型应该是 BANNER，上外边距为 4 像素，下外边距为 10 像素。

{
  "placements": [
    {
      "anchor": {
        "selector": "DIV#domId",
        "index": 2,
        "sub": {
          "selector": "P.paragraph",
          "all": true,
        },
      },
      "pos": 4,
      "type": 1,
      "style": {
        "top_m": 5,
        "bot_m": 10,
      },
    },
  ]
}

对象定义

ConfigObj

要在配置对象中指定的字段：

字段名称	类型	说明
`placements`	Array	必填字段，用于指示网页上可植入广告的可能展示位置。
`attributes`	Object<string, string>	可选字段，用于指定从属性名称到属性值的映射，以应用于使用此配置注入的所有 `<amp-ad>` 元素。仅支持以下属性名称： type layout data-*（即任何数据属性）
`adConstraints`	AdConstraintsObj	可选字段，用于指定在网页上放置广告时应施加的限制。如果未指定，则 `amp-auto-ads` 会尝试使用在 [ad-network-config.js](0.1/ad-network-config.js) 中指定的默认限制。

PlacementObj

要在 placements 配置对象中指定的字段：

字段名称	类型	说明
`anchor`	AnchorObj	必填字段，用于提供在展示位置锚定到的网页上查找元素所使用的信息。
`pos`	RelativePositionEnum	必填字段，用于指示展示位置相对于其锚定元素的位置。
`type`	PlacementTypeEnum	必填字段，用于指示展示位置类型。
`style`	PlacementStyleObj	可选字段，用于指示应该应用于在此展示位置植入的广告的任意样式。
`attributes`	Object<string, string>	可选字段，表示从属性名称到属性值的映射，以应用于使用此展示位置注入的所有 `<amp-ad>` 元素。此处指定的属性会替换在父 `ConfigObj` 上也指定的具有相同名称的任意属性。仅支持以下属性名称： type layout data-*（即任何数据属性）

AnchorObj

要在 anchor 配置对象中指定的字段：

字段名称	类型	说明
`selector`	string	必填字段，用于定义 CSS 选择器，以在这种锚定定义级别选择元素。
`index`	number	可选字段，用于指定这种锚定定义级别应限定到的索引（选择器选择的元素的索引）。默认情况下，该值设置为 0（如果 `all` 字段为 false）。
`all`	boolean	如果已指定 `index` 字段，则忽略此字段。如果已设置为 `true`，则表示应包含选择器所选的全部元素；否则请设置为 `false`。
`min_c`	number	可选字段，用于指定元素要包含的 textContent 属性的长度下限。默认值为 0。
`sub`	AnchorObj	可选字段，用于指定在这种锚定定义级别选择的所有元素内选择元素的递归 `AnchorObj`。

PlacementStyleObj

要在 style 配置对象中指定的字段：

字段名称	类型	说明
`top_m`	number	可选字段，用于指定在此位置植入广告应留出的上外边距（以像素为单位）。默认值为 0。
`bot_m`	number	可选字段，用于指定在此位置植入广告应留出的下外边距（以像素为单位）。默认值为 0。

RelativePositionEnum

placements 配置对象中 pos 字段的枚举值：

名称	值	说明
BEFORE	1	广告应作为同级植入锚定广告的紧前方。
FIRST_CHILD	2	广告应作为锚定广告的第一个子级植入。
LAST_CHILD	3	广告应作为锚定广告的最后一个子级植入。
AFTER	4	广告应作为同级植入锚定广告的紧后面。

PlacementTypeEnum

placements 配置对象中 type 字段的枚举值：

名称	值	说明
BANNER	1	展示位置，用于描述横幅广告的位置。

AdConstraintsObj

要在 adConstraints 配置对象中指定的字段：

字段名称	类型	说明
`initialMinSpacing`	string	必填字段，用于指示广告植入时与网页上已有的任意广告（手动放置的广告或之前由 amp-auto-ads 放置的广告）之间的距离下限。值以带有单位前缀的数字表示。例如，“10px”表示 10 像素，“0.5vp”表示视口高度的一半。负值无效。支持的单位包括： px - 像素 vp - 视口高度的倍数此值仅适用于以下情况：当网页上已有广告的数量少于在 subsequentMinSpacing 字段中指定的任何 `adCount` 匹配器值时。
`subsequentMinSpacing`	Array<!SubsequentMinSpacingObj>	可选字段，用于指定根据植入时网页上已有广告的数量，应该应用的广告间距。
`maxAdCount`	number	必填字段，用于指定使用 `amp-auto-ads` 在网页上放置的广告的数量上限。手动放置的广告和由 `amp-auto-ads` 放置的广告均计入此总数。例如，如果此字段已设置为 5，并且网页上已有 3 个手动放置的广告，那么由 `amp-auto-ads` 放置的额外广告数量上限为 2。

SubsequentMinSpacingObj

要在 subsequentMinSpacing 配置对象中指定的字段。subsequentMinSpacing 条目可用于根据网页上已有广告的数量更改任何其他广告之间所需的间距。例如，请考虑以下情形：

网页上已有 2 个广告
subsequentMinSpacing 字段为： [ {adCount: 3, spacing: "500px"}, {adCount: 5, spacing: "1000px"}, ]

网页上一开始有 2 个广告，所以没有映射匹配。因此，最短间距默认为 AdConstraints 对象中的 initialMinSpacing。 amp-auto-ads 会尝试以递归方式放置广告，直到没有可用的展示位置（在不打破 adContraints 的情况下）。 amp-auto-ads 放置第一个广告后，网页上现在有 3 个广告，因为 subsequentMinSpacing 中存在与 3 个（或更多）广告对应的映射，所以间距下限现在为 500 像素。这条规则适用于 5 个广告，因此在网页上出现 5 个广告之前，它一直适用。如果要植入第 6 个广告，则需要清除其他广告，留出至少 1000 像素的距离。

字段名称	类型	说明
`adCount`	number	必填字段。应用此规则所需的网页上已有广告的数量下限（假设没有其他更匹配的规则）。如需详细了解相关说明，请参阅上述说明。
`spacing`	string	必填字段，用于指定此规则匹配（根据 `adCount`）时要应用的广告间距下限。值以带有单位前缀的数字表示。例如，“10px”表示 10 像素，“0.5vp”表示视口高度的一半。负值无效。支持的单位包括： px - 像素 vp - 视口高度的倍数

验证

请参阅 AMP 验证工具规范中的 amp-auto-ads 规则。

需要更多帮助？

您已多次阅读本文档，但它仍未能涵盖您的所有问题？也许其他人也这么觉得：在 Stack Overflow 上与他们联系。

前往 Stack Overflow

发现错误或缺少功能？

AMP 项目强烈鼓励您参与并做出贡献！我们希望您能成为我们开放源代码社区的持续参与者，但我们也欢迎您对所热衷问题做出一次性贡献。

前往 GitHub