REST Resource: curators.reports

資源:報表

Report 資源。

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

string

ID。報表的資源名稱。報表資源名稱的格式如下:curators/{accountId}/reports/{reportId}

reportId

string (int64 format)

僅供輸出。報表 ID。

reportDefinition

object (ReportDefinition)

必填。報表的報表定義。

displayName

string

(選用步驟) 報表的顯示名稱。

updateTime

string (Timestamp format)

僅供輸出。上次修改這份報表的時間。

使用 RFC 3339,產生的輸出內容一律會經過 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 正規化,並使用 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 發布商 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 以要求中指定的報表帳面貨幣計算的支出。預設為美元。

篩選器

一或多個欄位的篩選器。

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 使用世界標準時間時區。
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

以非同步方式執行現有報表。