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」捷克文
  • 「de」GERMAN 適用
  • 「en」英文版本
  • 「es」SPANISH 專用
  • 「fr」法語
  • 「it」義大利語
  • 「ja」日文
  • 「ko」韓國
  • 「pl」適用於 POLISH
  • 「pt-BR」代表 BRAZILIAN_PORTUGUESE
  • 「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_COMPOSITION、TYPE_INVENTORY_AVAILABILITY、TYPE_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.dataRange 是 CUSTOM_DATES，就必須提供 reportDataEndTimeMs，否則就忽略。
reportDataStartTimeMs long 報表所顯示資料的開始時間。請注意，如果 metadata.dataRange 是 CUSTOM_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。

方法

createquery
建立查詢。
deletequery
刪除已儲存的查詢和已儲存的報表。
getquery
擷取已儲存的查詢。
listqueries
擷取已儲存的查詢。
runquery
執行已儲存的查詢來產生報表。