Queries

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

表示查询。

{
  "kind": "doubleclickbidmanager#query",
  "queryId": long,
  "metadata": {
    "title": string,
    "dataRange": string,
    "format": string,
    "running": boolean,
    "reportCount": integer,
    "googleCloudStoragePathForLatestReport": string,
    "latestReportRunTimeMs": long,
    "googleDrivePathForLatestReport": string,
    "sendNotification": boolean,
    "shareEmailAddress": [
      string
    ],
    "locale": string
  },
  "params": {
    "type": string,
    "groupBys": [
      string
    ],
    "filters": [
      {
        "type": string,
        "value": string
      }
    ],
    "metrics": [
      string
    ],
    "includeInviteData": boolean
  },
  "schedule": {
    "frequency": string,
    "endTimeMs": long,
    "nextRunMinuteOfDay": integer,
    "nextRunTimezoneCode": string
  },
  "reportDataStartTimeMs": long,
  "reportDataEndTimeMs": long,
  "timezoneCode": string
}
属性名称 说明 备注
kind string 标识资源类型。值:固定字符串 "doubleclickbidmanager#query"
metadata nested object 查询元数据。
metadata.dataRange string 报告数据范围。

可接受的值:
  • ALL_TIME
  • CURRENT_DAY
  • CUSTOM_DATES
  • LAST_14_DAYS
  • LAST_30_DAYS
  • LAST_365_DAYS
  • LAST_7_DAYS
  • LAST_90_DAYS
  • MONTH_TO_DATE
  • PREVIOUS_DAY
  • PREVIOUS_HALF_MONTH
  • PREVIOUS_MONTH
  • PREVIOUS_QUARTER
  • PREVIOUS_WEEK
  • PREVIOUS_YEAR
  • QUARTER_TO_DATE
  • TYPE_NOT_SUPPORTED
  • WEEK_TO_DATE
  • YEAR_TO_DATE
metadata.format string 生成的报告的格式。

可接受的值:
  • CSV
  • EXCEL_CSV
  • XLSX
metadata.googleCloudStoragePathForLatestReport string 指向存储最新报告的 Google Cloud Storage 位置的路径。
metadata.googleDrivePathForLatestReport string Google 云端硬盘中的最新报告的路径。
metadata.latestReportRunTimeMs long 最新报表开始生成的时间。
metadata.locale string

所生成的报告的语言区域。可接受的值包括:

  • cs”(针对 CZECH)
  • 用于“GERMAN”的“de
  • en”的简体中文
  • “SPAN”的“es
  • fr”代表法语
  • it”- 意大利语
  • "ja"(日语)
  • ko”(面向韩国)
  • pl”的 POLISH
  • pt-BR”(针对巴西)
  • ru”(俄语)
  • tr”(土耳其)
  • uk”(针对 UKRAINIAN)
  • zh-CN”(来自 CHINA_CHINESE)
  • zh-TW”的 TAIWAN_CHINESE

未在以上列表中的语言区域字符串将生成英文报告。

metadata.reportCount integer 为相应查询生成的报告的数量。
metadata.running boolean 最新报告是否当前正在生成。
metadata.sendNotification boolean 报告准备就绪后是否发送电子邮件通知。默认为 false。
metadata.shareEmailAddress[] list 报告完成时用于发送电子邮件通知的电子邮件地址列表。与 sendNotification 分开。
metadata.title string 查询标题。它用于命名通过此查询生成的报告。
params nested object 查询参数。
params.filters[] list 用于匹配报告中的流量数据的过滤条件
params.filters[].type string 过滤器类型。

可接受的值:
  • FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY
  • FILTER_ACTIVITY_ID
  • FILTER_ADVERTISER
  • FILTER_ADVERTISER_CURRENCY
  • FILTER_ADVERTISER_TIMEZONE
  • FILTER_AD_POSITION
  • FILTER_AGE
  • FILTER_AUTHORIZED_SELLER_STATE_ID
  • FILTER_BRANDSAFE_CHANNEL_ID
  • FILTER_BROWSER
  • FILTER_BUDGET_SEGMENT_DESCRIPTION
  • FILTER_CAMPAIGN_DAILY_FREQUENCY
  • FILTER_CARRIER
  • FILTER_CHANNEL_ID
  • FILTER_CITY
  • FILTER_COMPANION_CREATIVE_ID
  • FILTER_CONVERSION_DELAY
  • FILTER_COUNTRY
  • FILTER_CREATIVE_ATTRIBUTE
  • FILTER_CREATIVE_HEIGHT
  • FILTER_CREATIVE_ID
  • FILTER_CREATIVE_SIZE
  • FILTER_CREATIVE_TYPE
  • FILTER_CREATIVE_WIDTH
  • FILTER_DATA_PROVIDER
  • FILTER_DATE
  • FILTER_DAY_OF_WEEK
  • FILTER_DEVICE_MAKE
  • FILTER_DEVICE_MODEL
  • FILTER_DEVICE_TYPE
  • FILTER_DFP_ORDER_ID
  • FILTER_DMA
  • FILTER_DV360_ACTIVITY_ID
  • FILTER_EXCHANGE_ID
  • FILTER_FLOODLIGHT_ACTIVITY_ID
  • FILTER_FLOODLIGHT_PIXEL_ID
  • FILTER_GENDER
  • FILTER_INSERTION_ORDER
  • FILTER_INVENTORY_COMMITMENT_TYPE
  • FILTER_INVENTORY_DELIVERY_METHOD
  • FILTER_INVENTORY_FORMAT
  • FILTER_INVENTORY_RATE_TYPE
  • FILTER_INVENTORY_SOURCE
  • FILTER_INVENTORY_SOURCE_TYPE
  • FILTER_KEYWORD
  • FILTER_LINE_ITEM
  • FILTER_LINE_ITEM_DAILY_FREQUENCY
  • FILTER_LINE_ITEM_LIFETIME_FREQUENCY
  • FILTER_LINE_ITEM_TYPE
  • FILTER_MEDIA_PLAN
  • FILTER_MOBILE_DEVICE_MAKE
  • FILTER_MOBILE_DEVICE_MAKE_MODEL
  • FILTER_MOBILE_DEVICE_TYPE
  • FILTER_MOBILE_GEO
  • FILTER_MONTH
  • FILTER_MRAID_SUPPORT
  • FILTER_NIELSEN_AGE
  • FILTER_NIELSEN_COUNTRY_CODE
  • FILTER_NIELSEN_DEVICE_ID
  • FILTER_NIELSEN_GENDER
  • FILTER_NOT_SUPPORTED
  • FILTER_ORDER_ID
  • FILTER_OS
  • FILTER_PAGE_CATEGORY
  • FILTER_PAGE_LAYOUT
  • FILTER_PARTNER
  • FILTER_PARTNER_CURRENCY
  • FILTER_PUBLIC_INVENTORY
  • FILTER_QUARTER
  • FILTER_REGION
  • FILTER_REGULAR_CHANNEL_ID
  • FILTER_SITE_ID
  • FILTER_SITE_LANGUAGE
  • FILTER_SKIPPABLE_SUPPORT
  • FILTER_TARGETED_USER_LIST
  • FILTER_TIME_OF_DAY
  • FILTER_TRUEVIEW_AD_GROUP_AD_ID
  • FILTER_TRUEVIEW_AD_GROUP_ID
  • FILTER_TRUEVIEW_AGE
  • FILTER_TRUEVIEW_CATEGORY
  • FILTER_TRUEVIEW_CITY
  • FILTER_TRUEVIEW_CONVERSION_TYPE
  • FILTER_TRUEVIEW_COUNTRY
  • FILTER_TRUEVIEW_CUSTOM_AFFINITY
  • FILTER_TRUEVIEW_DMA
  • FILTER_TRUEVIEW_GENDER
  • FILTER_TRUEVIEW_IAR_AGE
  • FILTER_TRUEVIEW_IAR_CATEGORY
  • FILTER_TRUEVIEW_IAR_CITY
  • FILTER_TRUEVIEW_IAR_COUNTRY
  • FILTER_TRUEVIEW_IAR_GENDER
  • FILTER_TRUEVIEW_IAR_INTEREST
  • FILTER_TRUEVIEW_IAR_LANGUAGE
  • FILTER_TRUEVIEW_IAR_PARENTAL_STATUS
  • FILTER_TRUEVIEW_IAR_REGION
  • FILTER_TRUEVIEW_IAR_REMARKETING_LIST
  • FILTER_TRUEVIEW_IAR_TIME_OF_DAY
  • FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL
  • FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO
  • FILTER_TRUEVIEW_IAR_ZIPCODE
  • FILTER_TRUEVIEW_INTEREST
  • FILTER_TRUEVIEW_KEYWORD
  • FILTER_TRUEVIEW_PARENTAL_STATUS
  • FILTER_TRUEVIEW_PLACEMENT
  • FILTER_TRUEVIEW_REGION
  • FILTER_TRUEVIEW_REMARKETING_LIST
  • FILTER_TRUEVIEW_URL
  • FILTER_TRUEVIEW_ZIPCODE
  • FILTER_UNKNOWN
  • FILTER_USER_LIST
  • FILTER_USER_LIST_FIRST_PARTY
  • FILTER_USER_LIST_THIRD_PARTY
  • FILTER_VIDEO_AD_POSITION_IN_STREAM
  • FILTER_VIDEO_COMPANION_SIZE
  • FILTER_VIDEO_COMPANION_TYPE
  • FILTER_VIDEO_CREATIVE_DURATION
  • FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE
  • FILTER_VIDEO_DURATION_SECONDS
  • FILTER_VIDEO_FORMAT_SUPPORT
  • FILTER_VIDEO_INVENTORY_TYPE
  • FILTER_VIDEO_PLAYER_SIZE
  • FILTER_VIDEO_RATING_TIER
  • FILTER_VIDEO_SKIPPABLE_SUPPORT
  • FILTER_VIDEO_VPAID_SUPPORT
  • FILTER_WEEK
  • FILTER_YEAR
  • FILTER_YOUTUBE_VERTICAL
  • FILTER_ZIP_CODE
params.filters[].value string 过滤条件值。
params.groupBys[] list 数据按此字段中列出的过滤条件进行分组。
params.includeInviteData boolean 已弃用。此字段已不再使用。
params.metrics[] list 指标
params.type string 报告类型。

针对特定类型的限制:
  • TYPE_ORDER_ID最多支持过去 60 天内的日期范围。
  • TYPE_AUDIENCE_COMPOSITIONTYPE_INVENTORY_AVAILABILITYTYPE_TRUEVIEW_IAR支持的日期范围必须是过去最多 30 天。


可接受的值:
  • TYPE_ACTIVE_GRP
  • TYPE_AUDIENCE_COMPOSITION
  • TYPE_AUDIENCE_PERFORMANCE
  • TYPE_CLIENT_SAFE
  • TYPE_COMSCORE_VCE
  • TYPE_CROSS_FEE
  • TYPE_CROSS_PARTNER
  • TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
  • TYPE_ESTIMATED_CONVERSION
  • TYPE_FEE
  • TYPE_GENERAL
  • TYPE_INVENTORY_AVAILABILITY
  • TYPE_KEYWORD
  • TYPE_LINEAR_TV_SEARCH_LIFT
  • TYPE_NIELSEN_AUDIENCE_PROFILE
  • TYPE_NIELSEN_DAILY_REACH_BUILD
  • TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
  • TYPE_NIELSEN_SITE
  • TYPE_NOT_SUPPORTED
  • TYPE_ORDER_ID
  • TYPE_PAGE_CATEGORY
  • TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE
  • TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
  • TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
  • TYPE_PIXEL_LOAD
  • TYPE_REACH_AND_FREQUENCY
  • TYPE_REACH_AUDIENCE
  • TYPE_THIRD_PARTY_DATA_PROVIDER
  • TYPE_TRUEVIEW
  • TYPE_TRUEVIEW_IAR
  • TYPE_VERIFICATION
  • TYPE_YOUTUBE_VERTICAL
queryId long 查询 ID。
reportDataEndTimeMs long 报告中显示的数据的结束时间。请注意,如果 metadata.dataRangeCUSTOM_DATES,则 reportDataEndTimeMs 是必需的;否则,系统会忽略它。
reportDataStartTimeMs long 报告中显示的数据的开始时间。请注意,如果 metadata.dataRangeCUSTOM_DATES,则 reportDataStartTimeMs 是必需的;否则,系统会忽略它。
schedule nested object 有关运行查询的频率和时间的信息。
schedule.endTimeMs long 定期运行查询的时间。
schedule.frequency string 查询运行的频率。

可接受的值:
  • DAILY
  • MONTHLY
  • ONE_TIME
  • QUARTERLY
  • SEMI_MONTHLY
  • WEEKLY
schedule.nextRunMinuteOfDay integer 已弃用。此字段无效。
schedule.nextRunTimezoneCode string 报告生成时间的规范时区代码。默认为 America/New_York
timezoneCode string 报告数据时间的规范时区代码。默认为 America/New_York

方法

创建查询
创建查询。
删除查询
删除已存储的查询以及关联的已存储报告。
查询
检索存储的查询。
列表查询
检索存储的查询。
运行查询
运行已存储的查询以生成报告。