Reports: generate

הערה: נדרשת הרשאה.

הסקריפט הזה יוצר ומחזיר דוח באופן מיידי. כדאי לנסות עכשיו.

שליחת בקשה

בקשת HTTP

POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate

הרשאה

בקשה זו מחייבת הרשאה בהיקף הבא:

היקף
https://www.googleapis.com/auth/doubleclicksearch

למידע נוסף, עיינו בדף אימות והרשאה.

גוף הבקשה

בגוף הבקשה, צריך לספק את הנתונים במבנה הבא:

{
  "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
}

שם הנכס	ערך	תיאור	הערות
reportScope	object	ReportScope הוא קבוצה של מזהים שמשמשים לקביעת קבוצת המשנה של הישויות שיוחזרו בדוח. נדרשת ההרשאה המלאה של המזהים מהרמה הנמוכה ביותר שהוגדרה על ידי הסוכנות.
reportScope.agencyId	long	מזהה סוכנות ב-DS.
reportScope.advertiserId	long	מזהה מפרסם ב-DS.
reportScope.engineAccountId	long	מספר חשבון מנוע חיפוש ב-DS.
reportScope.campaignId	long	מזהה קמפיין ב-DS.
reportScope.adGroupId	long	מזהה קבוצת מודעות ב-DS.
reportScope.keywordId	long	מזהה מילת מפתח ב-DS.
reportScope.adId	long	מזהה מודעה ב-DS.
reportType	string	קובע את סוג השורות שמוחזרות בדוח. לדוגמה, אם מציינים reportType: keyword, כל שורה בדוח תכיל נתונים על מילת מפתח. לקבלת מידע נוסף על העמודות הזמינות לכל סוג, עיינו בסוגי הדוחות.
columns[]	list	העמודות שייכללו בדוח. הערך כולל גם עמודות של DoubleClick Search וגם עמודות שמורות. בעמודות DoubleClick Search נדרש הפרמטר columnName בלבד. בעמודות שמורות חובה להשתמש רק בפרמטר savedColumnName. לא ניתן להגדיר את columnName ואת savedColumnName באותו בית. מספר העמודות המקסימלי לבקשה הוא 300.
columns[].columnName	string	השם של עמודה ב-DoubleClick Search שצריך לכלול בדוח.
columns[].savedColumnName	string	השם של עמודה שמורה שתיכלל בדוח. ההיקף של הדוח צריך להיות לכל מפרסם, או פחות, וצריך ליצור את העמודה השמורה הזו בממשק המשתמש של DoubleClick Search.
columns[].headerText	string	טקסט שמשמש לזיהוי העמודה הזו בפלט הדוח. ברירת המחדל היא columnName או savedColumnName כשלא מצוין. הפעולה הזו יכולה למנוע התנגשויות בין עמודות של DoubleClick Search לבין עמודות שמורות בעלות אותו שם.
columns[].startDate	string	תאריך כולל בפורמט YYYY-MM-DD. אם תספקו את המזהה הזה, הפעולה הזו תבטל את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לציין את המזהה הזה יחד עם endDate.
columns[].endDate	string	יום כולל בפורמט YYYY-MM-DD. אם תספקו את המזהה הזה, הפעולה הזו תבטל את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לציין את המזהה הזה יחד עם startDate.
columns[].groupByColumn	boolean	דוח סינכרוני בלבד. יש להגדיר את הערך true כדי לקבץ לפי העמודה הזו. ברירת המחדל היא false.
timeRange	object	אם מתבקשים מדדים בדוח, הארגומנט הזה ישמש להגבלת המדדים לטווח זמן מסוים.
timeRange.startDate	string	תאריך כולל בפורמט YYYY-MM-DD.
timeRange.endDate	string	תאריך כולל בפורמט YYYY-MM-DD.
timeRange.changedMetricsSinceTimestamp	datetime	חותמת זמן UTC מקיפה, בפורמט RFC, למשל, 2013-07-16T10:16:23.555Z. כדאי לעיין בחומר עזר נוסף על אופן הפעולה של דוחות מדדים שהשתנו.
timeRange.changedAttributesSinceTimestamp	datetime	חותמת זמן UTC מקיפה, בפורמט RFC, למשל, 2013-07-16T10:16:23.555Z. מידע נוסף על האופן שבו פועלים דוחות מאפיינים שהשתנו
filters[]	list	רשימת מסננים שיחולו על הדוח. מספר המסננים המרבי לכל בקשה הוא 300.
filters[].column	nested object	העמודה שברצונך לבצע בה את הסינון. העמודה יכולה להיות עמודה של DoubleClick Search או עמודה שמורה.
filters[].column.columnName	string	השם של עמודה ב-DoubleClick Search שצריך לכלול בדוח.
filters[].column.savedColumnName	string	השם של עמודה שמורה שתיכלל בדוח. ההיקף של הדוח צריך להיות לכל מפרסם, או פחות, וצריך ליצור את העמודה השמורה הזו בממשק המשתמש של DoubleClick Search.
filters[].operator	string	אופרטור לשימוש במסנן. כדי לקבל רשימה של אופרטורים זמינים, אפשר לעיין בחומר העזר בנושא סינון.
filters[].values[]	list	רשימת ערכים לסינון. המספר המקסימלי של ערכי מסנן לבקשה הוא 300.
orderBy[]	list	דוח סינכרוני בלבד. רשימה של עמודות ומסלולים המגדירה מיון לביצוע בשורות הדוח. מספר ההזמנות המקסימלי לכל בקשה הוא 300.
orderBy[].column	nested object	עמודה שבה יבוצע המיון. העמודה יכולה להיות עמודה שמוגדרת על ידי DoubleClick Search או עמודה שמורה.
orderBy[].column.columnName	string	השם של עמודה ב-DoubleClick Search שצריך לכלול בדוח.
orderBy[].column.savedColumnName	string	השם של עמודה שמורה שתיכלל בדוח. ההיקף של הדוח צריך להיות לכל מפרסם, או פחות, וצריך ליצור את העמודה השמורה הזו בממשק המשתמש של DoubleClick Search.
orderBy[].sortOrder	string	כיוון המיון: ascending או descending.
includeDeletedEntities	boolean	קובע אם לכלול בדוח יישויות שהוסרו. ברירת המחדל היא false. הוצאה משימוש, יש להשתמש ב-includeRemovedEntities במקום זאת.
verifySingleTimeZone	boolean	אם הדוח true ייווצר, הדוח ייווצר רק אם כל הנתונים הסטטיסטיים המבוקשים מגיעים מאזור זמן יחיד. ברירת המחדל היא false.
downloadFormat	string	הפורמט שבו יש להחזיר את הדוח. יש עכשיו תמיכה ב-csv או ב-tsv.
statisticsCurrency	string	המדיניות מציינת את המטבע שבו הכסף יוחזר. הערכים האפשריים הם: usd, agency (תקף אם הדוח נכלל ברמת הסוכנות או ברמת נמוכה יותר), advertiser (תקין אם הדוח נכלל בהיקף * של מפרסם או פחות), או account (תקף אם הדוח נכלל ברמת החשבון של מנוע חיפוש או נמוך יותר).
startRow	integer	דוח סינכרוני בלבד. אינדקס מבוסס אפס של השורה הראשונה להחזרה. הערכים הקבילים הם 0 עד 50000, כולל. ברירת המחדל היא 0.
rowCount	integer	דוח סינכרוני בלבד. מספר השורות המקסימלי להחזרה. שורות נוספות יושמטו. הערכים הקבילים הם 0 עד 10000, כולל. ברירת המחדל היא 10000.
maxRowsPerFile	integer	דוח אסינכרוני בלבד. מספר השורות המקסימלי לכל קובץ דוח. דוח גדול מחולק למספר קבצים על סמך השדה הזה. הערכים הקבילים הם 1000000 עד 100000000, כולל.
includeRemovedEntities	boolean	קובע אם לכלול בדוח יישויות שהוסרו. ברירת המחדל היא false.
columns[].customDimensionName	string	פילוח דוח לפי מאפיין מותאם אישית. צריך לכלול את הדוח כמפרסם או כמפרסם, ולהגדיר את המאפיין המותאם אישית ב-DoubleClick Search. השם של המאפיין המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות. אם הוא מופיע בדוח ההמרות, מוחזר הערך של המאפיין המותאם אישית שצוין עבור ההמרה הנתונה, אם היא מוגדרת. בעמודה זו לא מוצג פילוח בדוח ההמרות.
columns[].platformSource	string	הפלטפורמה שמשמשת לספק נתונים עבור המאפיין המותאם אישית. הערכים המקובלים הם "Flightlight".
filters[].column.customDimensionName	string	פילוח דוח לפי מאפיין מותאם אישית. צריך לכלול את הדוח כמפרסם או כמפרסם, ולהגדיר את המאפיין המותאם אישית ב-DoubleClick Search. השם של המאפיין המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות. אם הוא מופיע בדוח ההמרות, מוחזר הערך של המאפיין המותאם אישית שצוין עבור ההמרה הנתונה, אם היא מוגדרת. בעמודה זו לא מוצג פילוח בדוח ההמרות.
filters[].column.headerText	string	טקסט שמשמש לזיהוי העמודה הזו בפלט הדוח. ברירת המחדל היא columnName או savedColumnName כשלא מצוין. הפעולה הזו יכולה למנוע התנגשויות בין עמודות של DoubleClick Search לבין עמודות שמורות בעלות אותו שם.
filters[].column.startDate	string	תאריך כולל בפורמט YYYY-MM-DD. אם תספקו את המזהה הזה, הפעולה הזו תבטל את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לציין את המזהה הזה יחד עם endDate.
filters[].column.endDate	string	יום כולל בפורמט YYYY-MM-DD. אם תספקו את המזהה הזה, הפעולה הזו תבטל את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לציין את המזהה הזה יחד עם startDate.
filters[].column.groupByColumn	boolean	דוח סינכרוני בלבד. יש להגדיר את הערך true כדי לקבץ לפי העמודה הזו. ברירת המחדל היא false.
filters[].column.platformSource	string	הפלטפורמה שמשמשת לספק נתונים עבור המאפיין המותאם אישית. הערכים המקובלים הם "Flightlight".
orderBy[].column.customDimensionName	string	פילוח דוח לפי מאפיין מותאם אישית. צריך לכלול את הדוח כמפרסם או כמפרסם, ולהגדיר את המאפיין המותאם אישית ב-DoubleClick Search. השם של המאפיין המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות. אם הוא מופיע בדוח ההמרות, מוחזר הערך של המאפיין המותאם אישית שצוין עבור ההמרה הנתונה, אם היא מוגדרת. בעמודה זו לא מוצג פילוח בדוח ההמרות.
orderBy[].column.headerText	string	טקסט שמשמש לזיהוי העמודה הזו בפלט הדוח. ברירת המחדל היא columnName או savedColumnName כשלא מצוין. הפעולה הזו יכולה למנוע התנגשויות בין עמודות של DoubleClick Search לבין עמודות שמורות בעלות אותו שם.
orderBy[].column.startDate	string	תאריך כולל בפורמט YYYY-MM-DD. אם תספקו את המזהה הזה, הפעולה הזו תבטל את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לציין את המזהה הזה יחד עם endDate.
orderBy[].column.endDate	string	יום כולל בפורמט YYYY-MM-DD. אם תספקו את המזהה הזה, הפעולה הזו תבטל את טווח הזמן הכולל של הדוח בעמודה הזו בלבד. יש לציין את המזהה הזה יחד עם startDate.
orderBy[].column.groupByColumn	boolean	דוח סינכרוני בלבד. יש להגדיר את הערך true כדי לקבץ לפי העמודה הזו. ברירת המחדל היא false.
orderBy[].column.platformSource	string	הפלטפורמה שמשמשת לספק נתונים עבור המאפיין המותאם אישית. הערכים המקובלים הם "Flightlight".
columns[].customMetricName	string	שם המדד המותאם אישית שרוצים לכלול בדוח. צריך לכלול את הדוח כמפרסם או כמפרסם. כמו כן, את המדד המותאם אישית צריך כבר להגדיר ב-DoubleClick Search. השם של המדד המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.
filters[].column.customMetricName	string	שם המדד המותאם אישית שרוצים לכלול בדוח. צריך לכלול את הדוח כמפרסם או כמפרסם. כמו כן, את המדד המותאם אישית צריך כבר להגדיר ב-DoubleClick Search. השם של המדד המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.
orderBy[].column.customMetricName	string	שם המדד המותאם אישית שרוצים לכלול בדוח. צריך לכלול את הדוח כמפרסם או כמפרסם. כמו כן, את המדד המותאם אישית צריך כבר להגדיר ב-DoubleClick Search. השם של המדד המותאם אישית, שמופיע ב-DoubleClick Search, הוא תלוי אותיות רישיות.
columns[].productReportPerspective	string	מחזירה ערכים רק עבור סוג ספציפי של פעילות מוצר. ערכים קבילים: "sold": החזרת מדדים רק לגבי מוצרים שנמכרו "advertised": מציג מדדים רק של מוצרים שפורסמו בקמפיין שופינג ושעשויים להימכר או שלא נמכרו
filters[].column.productReportPerspective	string	מחזירה ערכים רק עבור סוג ספציפי של פעילות מוצר. ערכים קבילים: "sold": החזרת מדדים רק לגבי מוצרים שנמכרו "advertised": מציג מדדים רק של מוצרים שפורסמו בקמפיין שופינג ושעשויים להימכר או שלא נמכרו
orderBy[].column.productReportPerspective	string	מחזירה ערכים רק עבור סוג ספציפי של פעילות מוצר. ערכים קבילים: "sold": החזרת מדדים רק לגבי מוצרים שנמכרו "advertised": מציג מדדים רק של מוצרים שפורסמו בקמפיין שופינג ושעשויים להימכר או שלא נמכרו

תשובה

אם הצלחת, בשיטה הזו מוחזר משאב דוחות בגוף התגובה.

רוצה לנסות?

כדי לקרוא לשיטה הזו על נתונים בזמן אמת ולראות את התגובה, צריך להשתמש ב-APIs Explorer בהמשך. אפשר גם לנסות סייר עצמאי.