REST Resource: curators.reports

资源:Report

Report 资源。

JSON 表示法
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
字段
name

string

标识符。报告的资源名称。报告资源名称采用以下格式:curators/{accountId}/reports/{reportId}

reportId

string (int64 format)

仅限输出。报告 ID。

reportDefinition

object (ReportDefinition)

必需。报告的报告定义。

displayName

string

可选。报告的显示名称。

updateTime

string (Timestamp format)

仅限输出。上次修改此报告的时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

createTime

string (Timestamp format)

仅限输出。此报告的创建时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

locale

string

仅限输出。此报告的语言区域。语言区域是根据用户在发出请求时的语言区域设置的。语言区域无法修改。

ReportDefinition

关于如何生成报告的定义。

JSON 表示法
{
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "timeZoneSource": enum (TimeZoneSource),
  "timeZone": string,
  "currencyCode": string,
  "dateRange": {
    object (DateRange)
  },
  "sorts": [
    {
      object (Sort)
    }
  ]
}
字段
dimensions[]

enum (Dimension)

必需。要生成报告的维度列表。如果留空,报告将不包含任何维度,并且所有指标都将是总计。

metrics[]

enum (Metric)

必需。要报告的指标列表。如果为空,则报告中不会包含任何指标。

filters[]

object (Filter)

可选。此报告的过滤条件。

timeZoneSource

enum (TimeZoneSource)

可选。从何处获取此报告的时区。默认使用太平洋时区 (PT)。如果来源为 PROVIDED,则报告定义中的 timeZone 字段也必须设置时区。

timeZone

string

可选。如果 timeZoneSource 为 PROVIDED,则这是此报告要使用的时区。对于任何其他时区来源,请留空。IANA 格式的时区。例如“America/New_York”。

currencyCode

string

可选。此报告的 ISO 4217 货币代码。如果未指定,则默认为账号币种代码。

dateRange

object (DateRange)

必需。此报告的主要日期范围。

sorts[]

object (Sort)

可选。要应用于此报告的默认排序。

维度

报告维度。

枚举
DIMENSION_UNSPECIFIED 默认值。此值未使用。
ADVERTISER_DOMAIN 广告客户的网域。
COUNTRY 国家/地区的显示名称。
CURATION_DATA_SEGMENT_ID 由甄选者创建的数据细分的 ID。
CURATION_DATA_SEGMENT_RESPONSE_STATUS 实时精选中的基于数据的细分受众群请求的响应状态。如需了解详情,请参阅 https://developers.google.com/authorized-buyers/curation/get-started/start。
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME 实时精选中的数据细分受众群请求的响应状态的本地化显示名称。如需了解详情,请参阅 https://developers.google.com/authorized-buyers/curation/get-started/start。
CURATOR_FEE_TYPE 甄选服务的类型(例如打包或基于数据的细分受众群)。
DATE 日期。
DEAL_ID 交易 ID。
DEAL_NAME 优惠名称。
DETECTED_ADVERTISER_NAME 检测到的广告客户的显示名称。
DSP_NAME DSP 的显示名称。
DSP_SEAT_ID DSP 账号 ID。
ENVIRONMENT 展示来源的用户设备和容器环境。支持的值为“app”和“web”。
ENVIRONMENT_NAME 展示来源的用户设备和容器环境的本地化显示名称。支持的值为“app”和“web”。
HOLDING_COMPANY_NAME 控股公司的显示名称。
HOUR 小时。
MOBILE_APP_ID 移动应用 ID。
MOBILE_APP_NAME 移动应用名称。
MOBILE_OS 移动操作系统。
MONTH 月。
PACKAGE_FEE_VISIBILITY 竞价包费用的公开程度(例如,公开或不公开)。
PLATFORM 平台,例如“桌面设备”与“移动设备”。
PUBLISHER_DOMAIN 发布商域名。
PUBLISHER_ID 发布商标识符。
PUBLISHER_NAME 发布商名称。
WEEK 周。

指标

报告指标。

枚举
METRIC_UNSPECIFIED 默认值。此值未使用。
ACTIVE_VIEW_MEASURABILITY_RATE Active View 衡量率。
ACTIVE_VIEW_MEASURABLE Active View 衡量率。
ACTIVE_VIEW_VIEWABILITY_RATE Active View 可见率。
ACTIVE_VIEW_VIEWABLE Active View 可见展示次数
AUCTIONS_WON 赢得的竞价数。
BIDS 出价。
BIDS_IN_AUCTION 参与竞价的出价数。
BID_REQUESTS 出价请求。
CLICKS Clicks.
CURATION_PARTNER_FEE 策展方费用。如果包裹的公开范围设置为“不公开”,此值将被隐去,显示为 0.00。使用 PACKAGE_FEE_VISIBILITY 维度可查看是否披露了套餐费用。
DATA_SEGMENT_REQUESTS 在实时精选过程中发送的数据细分请求数量。
IMPRESSIONS 展示次数。
SPEND 以请求中指定的收入报告所用币种表示的支出。默认值为 USD。

过滤条件

一个或多个字段的过滤条件。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of mutually exclusive fields.
}
字段
类型决定了底层过滤条件的组合方式。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
fieldFilter

object (FieldFilter)

针对单个字段的过滤条件。

notFilter

object (Filter)

结果被取反的过滤条件。

andFilter

object (FilterList)

过滤条件列表,其结果通过 AND 运算。

orFilter

object (FilterList)

过滤条件列表,其结果通过 OR 运算。

互斥字段结束。

FieldFilter

针对特定字段的过滤条件。

JSON 表示法
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
字段
field

object (Field)

必需。要过滤的字段。

operation

enum (Operation)

必需。此过滤器的操作。

values[]

object (ReportValue)

必需。要过滤到的值。

字段

报告中的维度或指标。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of mutually exclusive fields.
}
字段
维度或指标。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
dimension

enum (Dimension)

此字段表示的维度。

metric

enum (Metric)

此字段表示的指标。

互斥字段结束。

操作

支持的过滤操作。

枚举
IN

对于标量操作数,检查操作数是否在提供的过滤值集中。

对于列表操作数,检查操作数中的任何元素是否在提供的一组过滤值中。

默认值。

NOT_IN

对于标量操作数,检查操作数是否不在提供的一组过滤值中。

对于列表操作数,检查操作数中的所有元素是否都不在所提供的过滤条件值集中。

CONTAINS

对于标量字符串操作数,检查操作数是否包含任何提供的过滤条件子字符串。

对于字符串列表操作数,检查操作数中的任何字符串是否包含任何提供的过滤子字符串。

NOT_CONTAINS

对于标量字符串操作数,检查操作数是否不包含任何提供的过滤条件子字符串。

对于字符串列表操作数,检查操作数中的所有字符串是否都不包含任何提供的过滤条件子字符串。

LESS_THAN 操作数小于提供的过滤条件值。
LESS_THAN_EQUALS 操作数小于或等于提供的过滤条件值。
GREATER_THAN 操作数大于提供的过滤条件值。
GREATER_THAN_EQUALS 操作数大于或等于提供的过滤条件值。
BETWEEN 运算数介于提供的过滤条件值之间。
MATCHES 操作数与一个或一组正则表达式匹配(必须匹配一个)。
NOT_MATCHES 操作数与正则表达式或一组正则表达式否定匹配(必须都不匹配)。

ReportValue

表示报告中的单个值。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of mutually exclusive fields.
}
字段
字段的值,取决于字段的数据格式。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
intValue

string (int64 format)

对于整数值。

doubleValue

number

对于双精度值。

stringValue

string

对于字符串值。

boolValue

boolean

适用于布尔值。

intListValue

object (IntList)

适用于整数值列表。

stringListValue

object (StringList)

适用于字符串值列表。

doubleListValue

object (DoubleList)

适用于双精度值列表。

bytesValue

string (bytes format)

对于字节值。

使用 base64 编码的字符串。

互斥字段结束。

IntList

整数值列表。

JSON 表示法
{
  "values": [
    string
  ]
}
字段
values[]

string (int64 format)

这些值

StringList

字符串值列表。

JSON 表示法
{
  "values": [
    string
  ]
}
字段
values[]

string

这些值

DoubleList

双精度值列表。

JSON 表示法
{
  "values": [
    number
  ]
}
字段
values[]

number

这些值

FilterList

过滤器的列表。

JSON 表示法
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
字段
filters[]

object (Filter)

必需。过滤器的列表。

TimeZoneSource

用于确定报告时区的来源。

枚举
TIME_ZONE_SOURCE_UNSPECIFIED 未指定的默认值。
AD_EXCHANGE 使用太平洋时区(PT)。
UTC 使用世界协调时间 (UTC) 时区。
PROVIDED 使用 ReportDefinition.time_zone 字段中提供的时区。由于日期是在请求时动态计算的,因此报告可能需要更长时间才能生成。
CURATOR 使用策展人账号设置中的时区。

DateRange

报告的日期范围。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of mutually exclusive fields.
}
字段
固定或相对日期范围。以下是互斥字段的列表。在响应中,最多只能设置以下字段之一:
fixed

object (FixedDateRange)

固定日期范围。

relative

enum (RelativeDateRange)

相对日期范围。

互斥字段结束。

FixedDateRange

两个固定日期之间的日期范围(包含结束日期)。

JSON 表示法
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
字段
startDate

object (Date)

必需。此日期范围的开始日期。

endDate

object (Date)

必需。此日期范围的结束日期(含此日期)。

日期

表示整个或部分日历日期(例如生日)。一天中的时间和时区要么在别处指定,要么不重要。日期相对于公历。可以表示以下任一情况:

  • 包含非零年份、月份和天值的完整日期。
  • 月份和天,年份值为零(例如周年纪念日)。
  • 单独的年份,月份和天值为零。
  • 年份和月份,天值为零(例如,信用卡到期日期)。

相关类型:

JSON 表示法
{
  "year": integer,
  "month": integer,
  "day": integer
}
字段
year

integer

日期中的年份。必须介于 1 到 9999 之间,或为 0(即指定不含年份的日期)。

month

integer

一年中的第几个月。必须介于 1 到 12 之间,或为 0(即只指定年份,不指定月份和天值)。

day

integer

一个月中的第几天。必须介于 1 到 31 之间并且对年份和月份有效,或为 0(即天不重要,指定单独的年份或者年份和月份)。

RelativeDateRange

相对日期范围的选项。

枚举
RELATIVE_DATE_RANGE_UNSPECIFIED 默认值。此值未使用。
TODAY 报告的生成日期。
YESTERDAY 报告生成日期的前一天。
THIS_WEEK_TO_DATE 从报告运行当周的周一开始,到报告运行当天(含)为止。
THIS_WEEK_TO_YESTERDAY 从报告运行当周的第一天开始,到报告运行的前一天(含)结束。
THIS_MONTH_TO_DATE 从报告生成当月的月初到报告生成当天(含当天)。
THIS_MONTH_TO_YESTERDAY 从报告运行当月的月初开始,到报告运行的前一天(含)为止。
THIS_QUARTER_TO_DATE 从报告运行所在日历季度的开始日期,到报告运行当天(含当天)。
THIS_QUARTER_TO_YESTERDAY 从报告运行所在日历季度的第一天开始,到报告运行前一天(含)结束。
THIS_YEAR_TO_DATE 从报告生成年份的年初到报告生成当天(含当天)。
THIS_YEAR_TO_YESTERDAY 从报告运行所在日历年的年初,到报告运行前一天(含)。
LAST_WEEK 运行报告的自然周之前的整个自然周,即周一至周日(含)。
LAST_WEEK_STARTING_SUNDAY 报告运行前一个自然周的整个自然周,即周日到周六(含)。
LAST_MONTH 报告运行前一个日历月的整个上一个日历月。
LAST_QUARTER 报告运行前一个日历季度的整个季度。
LAST_YEAR 报告生成年份之前的整个上一个日历年。
LAST_7_DAYS 报告生成日之前的 7 天。
LAST_30_DAYS 报告生成日之前的 30 天。
LAST_60_DAYS 报告生成日之前 60 天。
LAST_90_DAYS 报告生成日之前 90 天。
LAST_93_DAYS 报表生成日之前 93 天。
LAST_180_DAYS 报告生成日之前 180 天。
LAST_360_DAYS 报告生成日之前 360 天。
LAST_365_DAYS 报告生成日之前 365 天。
LAST_3_MONTHS 报告运行前完整的 3 个自然月。
LAST_6_MONTHS 报告运行前完整的 6 个自然月。
LAST_12_MONTHS 报告运行前一个日历月之前的整个前 12 个日历月。
ALL_AVAILABLE 从报告生成日之前 3 年到报告生成日的前一天(含)。

排序

表示报告中的排序。

JSON 表示法
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
字段
field

object (Field)

必需。要排序的字段(维度或指标)。

descending

boolean

可选。排列顺序。如果为 true,则按降序排序。

方法

create

创建 Report 对象。

delete

删除 Report 对象。

get

检索 Report 对象。

list

列出 Report 对象。

patch

更新 Report 对象。

run

异步启动现有报告的执行。