Queries

רשימה של ה-methods במשאב הזה מופיעה בסוף הדף.

ייצוגי משאבים

מייצג שאילתה.

{
  "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 Drive לדוח העדכני.
metadata.latestReportRunTimeMs long השעה שבה התחילה הרצת הדוח האחרון.
metadata.locale string

הלוקאל של הדוחות שנוצרים. הערכים הקבילים הם:

  • cs לצ'כיה (CZECH)
  • de לגרמנית
  • en לאנגלית
  • es לספרדית
  • fr לצרפתית
  • it לאיטלקית
  • ja ליפנית
  • ko לקוריאנית
  • pl עבור POLISH
  • pt-BR עבור BRAZILIAN_PORTUGUESE
  • ru לרוסית
  • tr לטורקיה
  • uk לבריטניה
  • 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 מזהה השאילתה.
reportDataEndTimeMs long מועד הסיום של הנתונים שמוצגים בדוח. הערה: הפרמטר reportDataEndTimeMs נדרש אם הערך של metadata.dataRange הוא CUSTOM_DATES, והמערכת תתעלם ממנו אחרת.
reportDataStartTimeMs long שעת ההתחלה של הנתונים שמוצגים בדוח. הערה: הפרמטר reportDataStartTimeMs נדרש אם הערך של metadata.dataRange הוא CUSTOM_DATES, והמערכת תתעלם ממנו אחרת.
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
מריץ שאילתה שמורה כדי ליצור דוח.