Method: customers.describeValidFrequencyLimitingEventMatchers

列出有效的事件匹配器及其元数据,用于为受众群体名单设置频次上限。例如,每个事件匹配器都有元数据,包括拥有的 AdsDataLink.Entity 以及相应广告系列或订单项的名称。

HTTP 请求

GET https://adsdatahub.googleapis.com/v1/{customer=customers/*}:describeValidFrequencyLimitingEventMatchers

网址采用 gRPC 转码语法。

路径参数

参数
customer

string

客户资源名称,例如 'customers/123'。

查询参数

参数
adsDataCustomerId

string (int64 format)

广告数据拥有的客户 ID,例如 456。

pageSize

integer

要返回的商品数量上限。如果为 0,服务器将决定要返回的关联客户的数量。

pageToken

string

上一个调用返回的页面令牌,用于请求下一页结果(如果有)。

filter

string

限制返回哪些事件匹配器。接受针对 eventMatcher、eventMatcherMetadata.entity 和 eventMatcherMetadata.parent_event_matcher 的所有子字段的过滤条件。155

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将包含结构如下的数据:

对 ExplainValidFrequencyLimitingEventMatchersRequest 请求的响应。

JSON 表示法
{
  "eventMatcherInfos": [
    {
      object (EventMatcherInfo)
    }
  ],
  "nextPageToken": string
}
字段
eventMatcherInfos[]

object (EventMatcherInfo)

单位列表,每个单位都包含一个事件匹配器及其元数据

nextPageToken

string

可用于请求下一个结果页面的令牌。如果没有其他结果,则此字段为空。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/adsdatahub

EventMatcherInfo

事件匹配器及其元数据。

JSON 表示法
{
  "eventMatcher": {
    object (EventMatcher)
  },
  "eventMatcherMetadata": {
    object (EventMatcherMetadata)
  }
}
字段
eventMatcher

object (EventMatcher)

包含约束条件类型和有效约束条件 ID 的事件匹配器。

eventMatcherMetadata

object (EventMatcherMetadata)

事件匹配器的元数据。

EventMatcherMetadata

事件匹配器的元数据。

JSON 表示法
{
  "entity": {
    object (Entity)
  },
  "displayName": string,
  "parentEventMatcher": {
    object (EventMatcher)
  }
}
字段
entity

object (Entity)

AdsDataLink 中的关联实体。

displayName

string

限制条件在底层数据存储区中的名称。这可以是广告系列名称、订单项名称等。

parentEventMatcher

object (EventMatcher)

相关父级 EventMatcher(如有)。如果 eventMatcher 是 DV360 订单项,那么此字段将引用该订单项所属的相应 DV360 广告订单的 EventMatcher。