Reports

לקבלת רשימה של שיטות עבור המשאב הזה, אפשר לעיין בסוף הדף.

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

דוח 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	דוח אסינכרוני בלבד. הערך חל רק אם הדוח הושלם בהצלחה וקובצי הדוח מוכנים להורדה.
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	הפלטפורמה שמשמשת לספק נתונים עבור המאפיין המותאם אישית. הערכים המקובלים הם "Flightlight".
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	הפלטפורמה שמשמשת לספק נתונים עבור המאפיין המותאם אישית. הערכים המקובלים הם "Flightlight".
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	הפלטפורמה שמשמשת לספק נתונים עבור המאפיין המותאם אישית. הערכים המקובלים הם "Flightlight".
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	אם כל הנתונים הסטטיסטיים בדוח מגיעים מאותו אזור זמן, זה יהיה המקרה. אחרת השדה לא יהיה מוגדר.

שיטות

create

המערכת יוצרת ומחזירה דוח באופן מיידי.

הורדה

סקרים על הסטטוס של בקשת דוח.

getFile

מתבצעת הורדה של קובץ דוח בקידוד UTF-8.

getIdmappingFile

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

בקשה

הוספה של בקשת דוח למערכת הדיווח.