Reports

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

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

דוח של DoubleClick Search. האובייקט הזה מכיל את בקשת הדוח, מטא-נתונים מסוימים של הדוח, כמו קוד המטבע, ואת שורות הדוח או קובצי הדוח שנוצרו.

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "reportScope": {
      "agencyId": long,
      "advertiserId": long,
      "engineAccountId": long,
      "campaignId": long,
      "adGroupId": long,
      "keywordId": long,
      "adId": long
    },
    "reportType": string,
    "columns": [
      {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      }
    ],
    "timeRange": {
      "startDate": string,
      "endDate": string,
      "changedMetricsSinceTimestamp": datetime,
      "changedAttributesSinceTimestamp": datetime
    },
    "filters": [
      {
        "column": {
          "columnName": string,
          "savedColumnName": string,
          "customDimensionName": string,
          "customMetricName": string,
          "headerText": string,
          "startDate": string,
          "endDate": string,
          "groupByColumn": boolean,
          "platformSource": string,
          "productReportPerspective": string
        },
        "operator": string,
        "values": [
          (value)
        ]
      }
    ],
    "orderBy": [
      {
        "column": {
          "columnName": string,
          "savedColumnName": string,
          "customDimensionName": string,
          "customMetricName": string,
          "headerText": string,
          "startDate": string,
          "endDate": string,
          "groupByColumn": boolean,
          "platformSource": string,
          "productReportPerspective": string
        },
        "sortOrder": string
      }
    ],
    "includeDeletedEntities": boolean,
    "includeRemovedEntities": boolean,
    "verifySingleTimeZone": boolean,
    "downloadFormat": string,
    "statisticsCurrency": string,
    "startRow": integer,
    "rowCount": integer,
    "maxRowsPerFile": integer
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}
שם הנכס ערך תיאור הערות
files[] list דוח אסינכרוני בלבד. רשימה של קובצי הדוח שנוצרו אחרי שהדוח הושלם בהצלחה.
files[].byteCount long הגודל של קובץ הדוח הזה בבייטים.
files[].url string כדי להוריד את קובץ הדוח, צריך להשתמש בכתובת ה-URL הזו.
id string דוח אסינכרוני בלבד. המזהה של הדוח.
isReportReady boolean דוח אסינכרוני בלבד. הערך יהיה True רק אם הדוח הושלם בהצלחה וקובצי הדוח מוכנים להורדה.
kind string מזהה אותו בתור משאב דוח. ערך: המחרוזת הקבועה doubleclicksearch#report.
request nested object הבקשה שיצרה את הדוח. שדות אופציונליים שלא צוינו בבקשה המקורית ימולאו בערכי ברירת מחדל.
request.columns[] list העמודות שייכללו בדוח. הנתונים האלה כוללים גם את העמודות של DoubleClick Search וגם את העמודות השמורות. בעמודות של DoubleClick Search, רק הפרמטר columnName נדרש. בעמודות שמורות רק הפרמטר savedColumnName. אי אפשר להגדיר גם את columnName וגם את savedColumnName באותו בית.

אפשר לשלוח עד 300 עמודות לכל בקשה.
request.columns[].columnName string השם של עמודת DoubleClick Search שתיכלל בדוח.
request.columns[].customDimensionName string הפילוח של הדוח מתבצע לפי מאפיין מותאם אישית. היקף הדוח צריך להיות מפרסם או רמה נמוכה יותר, וחובה להגדיר את המאפיין המותאם אישית ב-DoubleClick Search. השם של המאפיין המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.

אם משתמשים במאפיין הזה בדוח המרות, הפונקציה מחזירה את הערך של המאפיין המותאם אישית שצוין לגבי ההמרה הנתונה, אם היא מוגדרת. העמודה הזו לא מפלחת את דוח ההמרות.
request.columns[].customMetricName string השם של מדד מותאם אישית שייכלל בדוח. היקף הדוח צריך להיות מפרסם או רמה נמוכה יותר, והמדד המותאם אישית כבר מוגדר ב-DoubleClick Search. שם המדד המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.
request.columns[].endDate string יום כולל בפורמט YYYY-MM-DD. אם השדה הזה מוגדר, ההגדרה הזאת מבטלת את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לספק אותו יחד עם startDate.
request.columns[].groupByColumn boolean דוח סינכרוני בלבד. צריך להגדיר את הערך true כדי לקבץ לפי העמודה הזו. ברירת המחדל היא false.
request.columns[].headerText string טקסט שמשמש לזיהוי העמודה הזו בפלט הדוח. אם הפרמטר לא מוגדר, ערך ברירת המחדל הוא columnName או savedColumnName. אפשר להשתמש באפשרות הזו כדי למנוע התנגשויות בין עמודות של DoubleClick Search לבין עמודות שמורות עם אותו שם.
request.columns[].platformSource string הפלטפורמה שבה משתמשים כדי לספק את הנתונים של המאפיין המותאם אישית. הערכים הקבילים הם 'Floodlight'.
request.columns[].productReportPerspective string מחזירה מדדים רק לגבי סוג ספציפי של פעילות במוצר. הערכים הקבילים הם:
  • "sold": מדדים של החזרת מוצרים רק לגבי מוצרים שנמכרו
  • "advertised": החזרת מדדים לגבי מוצרים שפורסמו רק בקמפיין שופינג, וכאלה שנמכרו או לא נמכרו
request.columns[].savedColumnName string השם של עמודה שמורה שתיכלל בדוח. היקף הדוח צריך להיות ברמת המפרסם או ברמה נמוכה יותר, ויש ליצור את העמודה השמורה הזו כבר בממשק המשתמש של DoubleClick Search.
request.columns[].startDate string תאריך כולל בפורמט YYYY-MM-DD. אם השדה הזה מוגדר, ההגדרה הזאת מבטלת את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לספק אותו יחד עם endDate.
request.downloadFormat string הפורמט שבו צריך להחזיר את הדוח. כרגע יש תמיכה ב-csv או ב-tsv.
request.filters[] list רשימת מסננים שיחולו על הדוח.

כל בקשה יכולה לכלול עד 300 מסננים.
request.filters[].column nested object עמודה שלפיה יש לבצע את הסינון. זו יכולה להיות עמודה של DoubleClick Search או עמודה שמורה.
request.filters[].column.columnName string השם של עמודת DoubleClick Search שתיכלל בדוח.
request.filters[].column.customDimensionName string הפילוח של הדוח מתבצע לפי מאפיין מותאם אישית. היקף הדוח צריך להיות מפרסם או רמה נמוכה יותר, וחובה להגדיר את המאפיין המותאם אישית ב-DoubleClick Search. השם של המאפיין המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.

אם משתמשים במאפיין הזה בדוח המרות, הפונקציה מחזירה את הערך של המאפיין המותאם אישית שצוין לגבי ההמרה הנתונה, אם היא מוגדרת. העמודה הזו לא מפלחת את דוח ההמרות.
request.filters[].column.customMetricName string השם של מדד מותאם אישית שייכלל בדוח. היקף הדוח צריך להיות מפרסם או רמה נמוכה יותר, והמדד המותאם אישית כבר מוגדר ב-DoubleClick Search. שם המדד המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.
request.filters[].column.endDate string יום כולל בפורמט YYYY-MM-DD. אם השדה הזה מוגדר, ההגדרה הזאת מבטלת את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לספק אותו יחד עם startDate.
request.filters[].column.groupByColumn boolean דוח סינכרוני בלבד. צריך להגדיר את הערך true כדי לקבץ לפי העמודה הזו. ברירת המחדל היא false.
request.filters[].column.headerText string טקסט שמשמש לזיהוי העמודה הזו בפלט הדוח. אם הפרמטר לא מוגדר, ערך ברירת המחדל הוא columnName או savedColumnName. אפשר להשתמש באפשרות הזו כדי למנוע התנגשויות בין עמודות של DoubleClick Search לבין עמודות שמורות עם אותו שם.
request.filters[].column.platformSource string הפלטפורמה שבה משתמשים כדי לספק את הנתונים של המאפיין המותאם אישית. הערכים הקבילים הם 'Floodlight'.
request.filters[].column.productReportPerspective string מחזירה מדדים רק לגבי סוג ספציפי של פעילות במוצר. הערכים הקבילים הם:
  • "sold": מדדים של החזרת מוצרים רק לגבי מוצרים שנמכרו
  • "advertised": החזרת מדדים לגבי מוצרים שפורסמו רק בקמפיין שופינג, וכאלה שנמכרו או לא נמכרו
request.filters[].column.savedColumnName string השם של עמודה שמורה שתיכלל בדוח. היקף הדוח צריך להיות ברמת המפרסם או ברמה נמוכה יותר, ויש ליצור את העמודה השמורה הזו כבר בממשק המשתמש של DoubleClick Search.
request.filters[].column.startDate string תאריך כולל בפורמט YYYY-MM-DD. אם השדה הזה מוגדר, ההגדרה הזאת מבטלת את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לספק אותו יחד עם endDate.
request.filters[].operator string אופרטור לשימוש במסנן. ניתן לעיין בחומר העזר בנושא מסננים כדי לראות רשימה של האופרטורים הזמינים.
request.filters[].values[] list רשימת ערכים שלפיהם יתבצע סינון של ערך העמודה.

כל בקשה יכולה לכלול עד 300 ערכי סינון.
request.includeDeletedEntities boolean המדיניות קובעת אם ישויות שהוסרו צריכות להיכלל בדוח. ברירת המחדל היא false. הוצא משימוש. במקומו צריך להשתמש ב-includeRemovedEntities.
request.includeRemovedEntities boolean המדיניות קובעת אם ישויות שהוסרו צריכות להיכלל בדוח. ברירת המחדל היא false.
request.maxRowsPerFile integer דוח אסינכרוני בלבד. מספר השורות המקסימלי לקובץ דוח. דוח גדול מחולק למספר קבצים על סמך השדה הזה. הערכים הקבילים הם 1000000 עד 100000000, כולל.
request.orderBy[] list דוח סינכרוני בלבד. רשימת עמודות ומסלולים המגדירות את המיון שיש לבצע על שורות הדוח.

מספר ההזמנות המקסימלי לכל בקשה הוא 300.
request.orderBy[].column nested object עמודה שלפיה רוצים לבצע מיון. זו יכולה להיות עמודה שהוגדרה ב-DoubleClick Search או עמודה שמורה.
request.orderBy[].column.columnName string השם של עמודת DoubleClick Search שתיכלל בדוח.
request.orderBy[].column.customDimensionName string הפילוח של הדוח מתבצע לפי מאפיין מותאם אישית. היקף הדוח צריך להיות מפרסם או רמה נמוכה יותר, וחובה להגדיר את המאפיין המותאם אישית ב-DoubleClick Search. השם של המאפיין המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.

אם משתמשים במאפיין הזה בדוח המרות, הפונקציה מחזירה את הערך של המאפיין המותאם אישית שצוין לגבי ההמרה הנתונה, אם היא מוגדרת. העמודה הזו לא מפלחת את דוח ההמרות.
request.orderBy[].column.customMetricName string השם של מדד מותאם אישית שייכלל בדוח. היקף הדוח צריך להיות מפרסם או רמה נמוכה יותר, והמדד המותאם אישית כבר מוגדר ב-DoubleClick Search. שם המדד המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.
request.orderBy[].column.endDate string יום כולל בפורמט YYYY-MM-DD. אם השדה הזה מוגדר, ההגדרה הזאת מבטלת את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לספק אותו יחד עם startDate.
request.orderBy[].column.groupByColumn boolean דוח סינכרוני בלבד. צריך להגדיר את הערך true כדי לקבץ לפי העמודה הזו. ברירת המחדל היא false.
request.orderBy[].column.headerText string טקסט שמשמש לזיהוי העמודה הזו בפלט הדוח. אם הפרמטר לא מוגדר, ערך ברירת המחדל הוא columnName או savedColumnName. אפשר להשתמש באפשרות הזו כדי למנוע התנגשויות בין עמודות של DoubleClick Search לבין עמודות שמורות עם אותו שם.
request.orderBy[].column.platformSource string הפלטפורמה שבה משתמשים כדי לספק את הנתונים של המאפיין המותאם אישית. הערכים הקבילים הם 'Floodlight'.
request.orderBy[].column.productReportPerspective string מחזירה מדדים רק לגבי סוג ספציפי של פעילות במוצר. הערכים הקבילים הם:
  • "sold": מדדים של החזרת מוצרים רק לגבי מוצרים שנמכרו
  • "advertised": החזרת מדדים לגבי מוצרים שפורסמו רק בקמפיין שופינג, וכאלה שנמכרו או לא נמכרו
request.orderBy[].column.savedColumnName string השם של עמודה שמורה שתיכלל בדוח. היקף הדוח צריך להיות ברמת המפרסם או ברמה נמוכה יותר, ויש ליצור את העמודה השמורה הזו כבר בממשק המשתמש של DoubleClick Search.
request.orderBy[].column.startDate string תאריך כולל בפורמט YYYY-MM-DD. אם השדה הזה מוגדר, ההגדרה הזאת מבטלת את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לספק אותו יחד עם endDate.
request.orderBy[].sortOrder string כיוון המיון, שהוא ascending או descending.
request.reportScope object reportScope הוא קבוצה של מזהים שמשמשת כדי לקבוע איזו קבוצת משנה של ישויות יוחזרו בדוח. צריך לציין את השושלת המלאה של מזהים מהרמה הנמוכה ביותר הרצויה דרך הסוכנות.
request.reportScope.adGroupId long מזהה קבוצת מודעות ב-DS.
request.reportScope.adId long מזהה מודעה ב-DS.
request.reportScope.advertiserId long מזהה המפרסם ב-DS.
request.reportScope.agencyId long מזהה הסוכנות ב-DS.
request.reportScope.campaignId long מזהה הקמפיין ב-DS.
request.reportScope.engineAccountId long מספר חשבון מנוע החיפוש ב-DS.
request.reportScope.keywordId long מזהה מילת מפתח ב-DS.
request.reportType string קובע את סוג השורות שמוחזרות בדוח. לדוגמה, אם מציינים reportType: keyword, כל שורה בדוח תכיל נתונים לגבי מילת מפתח. בחומר העזר בנושא סוגי דוחות תוכלו לראות אילו עמודות זמינות לכל סוג.
request.rowCount integer דוח סינכרוני בלבד. מספר השורות המקסימלי שצריך להחזיר. שורות נוספות מושמטות. הערכים הקבילים הם 0 עד 10000, כולל. ברירת המחדל היא 10000.
request.startRow integer דוח סינכרוני בלבד. אינדקס מבוסס אפס של השורה הראשונה שצריך להחזיר. הערכים הקבילים הם 0 עד 50000, כולל. ברירת המחדל היא 0.
request.statisticsCurrency string מציינת את המטבע שבו יוחזר הסכום. הערכים האפשריים הם: usd, agency (תקף אם הדוח בהיקף של סוכנות או היקף נמוך יותר), advertiser (תקף אם הדוח כולל היקף * של המפרסם או קבוצה נמוכה יותר) או account (תקף אם הדוח נכלל ברמת חשבון מנוע חיפוש או רמה נמוכה יותר).
request.timeRange object אם יש בקשה למדדים בדוח, הארגומנט הזה ישמש להגבלת המדדים לטווח זמן ספציפי.
request.timeRange.changedAttributesSinceTimestamp datetime חותמת זמן כוללת לפי שעון UTC בפורמט RFC, לדוגמה: 2013-07-16T10:16:23.555Z. כאן תוכלו לקרוא הסבר נוסף על האופן שבו פועלים דוחות המאפיינים שהשתנו.
request.timeRange.changedMetricsSinceTimestamp datetime חותמת זמן כוללת לפי שעון UTC בפורמט RFC, לדוגמה: 2013-07-16T10:16:23.555Z. כאן תוכלו לקרוא הסבר נוסף על אופן הפעולה של דוחות המדדים שהשתנו.
request.timeRange.endDate string תאריך כולל בפורמט YYYY-MM-DD.
request.timeRange.startDate string תאריך כולל בפורמט YYYY-MM-DD.
request.verifySingleTimeZone boolean אם הערך הוא true, הדוח ייווצר רק אם כל הנתונים הסטטיסטיים המבוקשים מגיעים מאזור זמן אחד. ברירת המחדל היא false.
rowCount integer מספר שורות הדוח שנוצרו על ידי הדוח, לא כולל הכותרות.
rows[] list דוח סינכרוני בלבד. שורות דוח שנוצרו.
rows[].(key) any value מציינת את העמודות שמיוצגות בשורה הזו. כלומר, כל מפתח תואם לעמודה שמכילה תא שאינו ריק בשורה הזו.
statisticsCurrencyCode string קוד המטבע של כל הערכים הכספיים שמופקים בדוח, כולל הערכים שנקבעו על ידי המשתמשים (למשל, הגדרות של הצעות מחיר למילות מפתח) והמדדים (למשל, עלות והכנסה). קוד המטבע של הדוח נקבע לפי השדה statisticsCurrency של בקשת הדוח.
statisticsTimeZone string אם כל הנתונים הסטטיסטיים של הדוח מגיעים מאותו אזור זמן, זה יהיה. אחרת, השדה לא הוגדר.

שיטות

יצירה
המערכת יוצרת ומחזירה דוח באופן מיידי.
הורדה
סקרים לסטטוס של בקשת דיווח.
getFile
הורדת קובץ דוח בקידוד UTF-8.
getIdMappingFile
מתבצעת הורדה של קובץ CSV (בקידוד UTF-8) שמכיל מיפויי מזהים בין הממשק הקודם של Search Ads 360 לבין הממשק החדש של Search Ads 360. לגבי המפרסם המבוקש, הקובץ כולל את כל ישויות הצאצא (למשל, חשבונות מנוע חיפוש, קמפיינים, קבוצות של מודעות וכו') שקיימות בממשק הקודם של Search Ads 360 וגם בממשק החדש של Search Ads 360.
בקשה
מכניסה בקשת דיווח למערכת הדיווח.