REST Resource: curators.reports

מקור מידע: דוח

המשאב Report.

ייצוג ב-JSON
{
  "name": string,
  "reportId": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "displayName": string,
  "updateTime": string,
  "createTime": string,
  "locale": string
}
שדות
name

string

מזהה. שם המשאב של הדוח. השם של מקור המידע של הדוח הוא בפורמט: curators/{accountId}/reports/{reportId}

reportId

string (int64 format)

פלט בלבד. מזהה הדוח.

reportDefinition

object (ReportDefinition)

חובה. הגדרת הדוח.

displayName

string

אופציונלי. השם המוצג של הדוח.

updateTime

string (Timestamp format)

פלט בלבד. המועד שבו הדוח הזה שונה לאחרונה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

createTime

string (Timestamp format)

פלט בלבד. הרגע שבו הדוח הזה נוצר.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z",‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

locale

string

פלט בלבד. הלוקאל של הדוח הזה. הלוקאל מוגדר לפי הלוקאל של המשתמש בזמן הבקשה. אי אפשר לשנות את הלוקאל.

ReportDefinition

ההגדרה של אופן הפעלת הדוח.

ייצוג ב-JSON
{
  "dimensions": [
    enum (Dimension)
  ],
  "metrics": [
    enum (Metric)
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "timeZoneSource": enum (TimeZoneSource),
  "timeZone": string,
  "currencyCode": string,
  "dateRange": {
    object (DateRange)
  },
  "sorts": [
    {
      object (Sort)
    }
  ]
}
שדות
dimensions[]

enum (Dimension)

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

metrics[]

enum (Metric)

חובה. רשימת המדדים שעליהם רוצים לדווח. אם לא תבחרו מדדים, הדוח יהיה ריק.

filters[]

object (Filter)

אופציונלי. המסננים של הדוח הזה.

timeZoneSource

enum (TimeZoneSource)

אופציונלי. איפה אפשר למצוא את אזור הזמן של הדוח הזה. ברירת המחדל היא אזור הזמן של החוף המערבי של ארה"ב (PT). אם המקור הוא PROVIDED, צריך להגדיר אזור זמן גם בשדה timeZone בהגדרת הדוח.

timeZone

string

אופציונלי. אם הערך של timeZoneSource הוא PROVIDED, זהו אזור הזמן שבו צריך להשתמש בדוח הזה. אם המקור של אזור הזמן הוא אחר, משאירים את השדה ריק. אזור הזמן בפורמט IANA. לדוגמה, "America/New_York".

currencyCode

string

אופציונלי. קוד המטבע לפי תקן ISO 4217 בדוח הזה. אם לא מציינים קוד מטבע, ברירת המחדל היא קוד המטבע של החשבון.

dateRange

object (DateRange)

חובה. טווח התאריכים הראשי של הדוח הזה.

sorts[]

object (Sort)

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

מאפיין

מאפייני דיווח.

טיפוסים בני מנייה (enum)
DIMENSION_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
ADVERTISER_DOMAIN הדומיין של המפרסם.
COUNTRY השם המוצג של המדינה.
CURATION_DATA_SEGMENT_ID המזהה של פלח הנתונים שנוצר על ידי אוצר.
CURATION_DATA_SEGMENT_RESPONSE_STATUS סטטוס התגובה של הבקשות לפלחי נתונים באוסף בזמן אמת. פרטים נוספים זמינים בכתובת https://developers.google.com/authorized-buyers/curation/get-started/start.
CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME השם המותאם לשוק המקומי שמוצג לסטטוס התגובה של הבקשות לפלחי נתונים ב-Real-time curation. פרטים נוספים זמינים בכתובת https://developers.google.com/authorized-buyers/curation/get-started/start.
CURATOR_FEE_TYPE סוג שירות האוספים (למשל, חבילה או פלח נתונים).
DATE תאריך.
DEAL_ID מספר העסקה.
DEAL_NAME שם המבצע.
DETECTED_ADVERTISER_NAME השם המוצג של המפרסם שזוהה.
DSP_NAME השם המוצג של פלטפורמת ה-DSP.
DSP_SEAT_ID מזהה המושב ב-DSP.
ENVIRONMENT מכשיר המשתמש וסביבת הקונטיינר שמהם מגיעה החשיפה. הערכים הנתמכים הם "app" ו-"web".
ENVIRONMENT_NAME השם המותאם לשוק המקומי שמוצג למכשיר המשתמש ולסביבת הקונטיינר שבהם מקור החשיפה. הערכים הנתמכים הם "app" ו-"web".
HOLDING_COMPANY_NAME השם המוצג של חברת האחזקות.
HOUR שעה.
MOBILE_APP_ID מזהה האפליקציה לנייד.
MOBILE_APP_NAME שם האפליקציה לנייד.
MOBILE_OS מערכת ההפעלה של המכשיר הנייד.
MONTH חודש.
PACKAGE_FEE_VISIBILITY החשיפה של עמלת החבילה (למשל, גלויה או לא גלויה).
PLATFORM פלטפורמה, למשל "מחשב" לעומת "נייד".
PUBLISHER_DOMAIN הדומיין של בעל האתר.
PUBLISHER_ID מזהה בעל האפליקציה.
PUBLISHER_NAME שם בעל האפליקציה.
WEEK שבוע.

מדד

מדד בדוח.

טיפוסים בני מנייה (enum)
METRIC_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
ACTIVE_VIEW_MEASURABILITY_RATE שיעור החשיפות שניתנות למדידה ב-Active View.
ACTIVE_VIEW_MEASURABLE חשיפות ניתנות למדידה ב-Active View.
ACTIVE_VIEW_VIEWABILITY_RATE שיעור הניראות של Active View.
ACTIVE_VIEW_VIEWABLE חשיפות ניתנות לצפייה לפי Active View
AUCTIONS_WON מכרזים שזכיתם בהם.
BIDS הצעות מחיר.
BIDS_IN_AUCTION הצעות מחיר במכרזים.
BID_REQUESTS בקשות להצעות מחיר.
CLICKS קליקים.
CURATION_PARTNER_FEE עמלת האוצר. הערך הזה יצונזר ל-0.00 אם סטטוס החשיפה של החבילה מוגדר כ"לא גלוי". כדי לבדוק אם העמלה של החבילה גלויה, משתמשים במאפיין PACKAGE_FEE_VISIBILITY.
DATA_SEGMENT_REQUESTS מספר הבקשות לפלחי נתונים שנשלחו ב-Real-time curation.
IMPRESSIONS חשיפות.
SPEND ההוצאה במטבע לדיווח שצוין בבקשה. ברירת המחדל היא דולר ארה"ב.

סינון

מסנן בשדה אחד או יותר.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of mutually exclusive fields.
}
שדות
הסוג קובע איך המסננים הבסיסיים משולבים. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
fieldFilter

object (FieldFilter)

מסנן בשדה אחד.

notFilter

object (Filter)

מסנן שהתוצאה שלו נשללת.

andFilter

object (FilterList)

רשימת מסננים שהתוצאות שלהם משולבות באמצעות AND.

orFilter

object (FilterList)

רשימת מסננים שהתוצאות שלהם משולבות באמצעות האופרטור OR.

סוף השדות שמוציאים זה את זה.

FieldFilter

מסנן בשדה ספציפי.

ייצוג ב-JSON
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
שדות
field

object (Field)

חובה. השדה שלפיו רוצים לסנן.

operation

enum (Operation)

חובה. הפעולה של המסנן הזה.

values[]

object (ReportValue)

חובה. הערכים שלפיהם רוצים לסנן.

שדה

מאפיין או מדד בדוח.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of mutually exclusive fields.
}
שדות
מאפיין או מדד. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
dimension

enum (Dimension)

המאפיין שהשדה הזה מייצג.

metric

enum (Metric)

המדד שהשדה הזה מייצג.

סוף השדות שמוציאים זה את זה.

פעולה

פעולות סינון נתמכות.

טיפוסים בני מנייה (enum)
IN

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

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

ערך ברירת המחדל.

NOT_IN

לאופרנדים סקלריים, בודק שהאופרנד לא נמצא בקבוצה של ערכי הסינון שסופקו.

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

CONTAINS

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

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

NOT_CONTAINS

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

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

LESS_THAN האופרנד קטן מערך המסנן שצוין.
LESS_THAN_EQUALS האופרנד קטן מערך המסנן שצוין או שווה לו.
GREATER_THAN האופרנד גדול מערך הסינון שצוין.
GREATER_THAN_EQUALS האופרנד גדול מערך המסנן שצוין או שווה לו.
BETWEEN האופרנד נמצא בין ערכי המסנן שצוינו.
MATCHES האופרנד תואם לביטוי רגולרי או לקבוצה של ביטויים רגולריים (אחד מהם חייב להתאים).
NOT_MATCHES האופרנד לא תואם לביטוי רגולרי או לקבוצה של ביטויים רגולריים (אף אחד מהם לא צריך להתאים).

ReportValue

מייצג ערך יחיד בדוח.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of mutually exclusive fields.
}
שדות
הערך של השדה תלוי בפורמט הנתונים של השדה. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
intValue

string (int64 format)

לערכים של מספרים שלמים.

doubleValue

number

לערכים כפולים.

stringValue

string

לערכי מחרוזת.

boolValue

boolean

לערכים בוליאניים.

intListValue

object (IntList)

לרשימות של ערכים מספריים שלמים.

stringListValue

object (StringList)

לרשימות של ערכי מחרוזות.

doubleListValue

object (DoubleList)

לרשימות של ערכים כפולים.

bytesValue

string (bytes format)

לערכים של בייטים.

מחרוזת בקידוד Base64.

סוף השדות שמוציאים זה את זה.

IntList

רשימה של ערכים מספריים שלמים.

ייצוג ב-JSON
{
  "values": [
    string
  ]
}
שדות
values[]

string (int64 format)

הערכים

StringList

רשימה של ערכי מחרוזת.

ייצוג ב-JSON
{
  "values": [
    string
  ]
}
שדות
values[]

string

הערכים

DoubleList

רשימה של ערכים כפולים.

ייצוג ב-JSON
{
  "values": [
    number
  ]
}
שדות
values[]

number

הערכים

FilterList

רשימת מסננים.

ייצוג ב-JSON
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
שדות
filters[]

object (Filter)

חובה. רשימת מסננים.

TimeZoneSource

המקור לקביעת אזור הזמן של הדוח.

טיפוסים בני מנייה (enum)
TIME_ZONE_SOURCE_UNSPECIFIED לא צוין ערך ברירת מחדל.
AD_EXCHANGE השתמשו באזור הזמן של החוף המערבי של ארה"ב(PT).
UTC צריך להשתמש באזור הזמן UTC.
PROVIDED משתמשים באזור הזמן שצוין בשדה ReportDefinition.time_zone. יכול להיות שהרצת הדוחות תימשך זמן רב יותר, כי התאריכים מחושבים באופן דינמי בזמן הבקשה.
CURATOR השתמשו באזור הזמן שמוגדר בחשבון של האוצר.

DateRange

טווח תאריכים של דוח.

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of mutually exclusive fields.
}
שדות
טווח תאריכים קבוע או יחסי. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
fixed

object (FixedDateRange)

טווח תאריכים קבוע.

relative

enum (RelativeDateRange)

טווח תאריכים יחסי.

סוף השדות שמוציאים זה את זה.

FixedDateRange

טווח תאריכים בין שני תאריכים קבועים (כולל תאריך הסיום).

ייצוג ב-JSON
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
שדות
startDate

object (Date)

חובה. תאריך ההתחלה של טווח התאריכים הזה.

endDate

object (Date)

חובה. תאריך הסיום (כולל) של טווח התאריכים הזה.

תאריך

מייצג תאריך מלא או חלקי בלוח השנה, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שהם לא משמעותיים. התאריך הוא לפי הלוח הגרגוריאני. הערך הזה יכול לייצג את אחד מהמצבים הבאים:

  • תאריך מלא, עם ערכי שנה, חודש ויום שאינם אפס.
  • חודש ויום, עם שנה אפס (לדוגמה, יום נישואין).
  • שנה בלבד, עם אפס בחודש ואפס ביום.
  • שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגה של כרטיס אשראי).

סוגים קשורים:

ייצוג ב-JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה של התאריך. הערך חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך בלי שנה.

month

integer

חודש בשנה. הערך חייב להיות בין 1 ל-12, או 0 כדי לציין שנה בלי חודש ויום.

day

integer

יום בחודש. הערך חייב להיות בין 1 ל-31, ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא משמעותי.

RelativeDateRange

אפשרויות לטווחי תאריכים יחסיים.

טיפוסים בני מנייה (enum)
RELATIVE_DATE_RANGE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
TODAY התאריך שבו הדוח נוצר.
YESTERDAY התאריך של היום שלפני היום שבו הדוח מופעל.
THIS_WEEK_TO_DATE מתחילת השבוע הקלנדרי שבו הדוח מופעל ועד ליום שבו הדוח מופעל, כולל.
THIS_WEEK_TO_YESTERDAY מתחילת השבוע הקלנדרי שבו הדוח מופעל, עד היום שלפני הפעלת הדוח (כולל).
THIS_MONTH_TO_DATE מתחילת החודש הקלנדרי שבו הדוח מופעל, עד ליום שבו הדוח מופעל (כולל).
THIS_MONTH_TO_YESTERDAY מתחילת החודש הקלנדרי שבו הדוח מופעל, עד היום שלפני הפעלת הדוח (כולל).
THIS_QUARTER_TO_DATE מתחילת הרבעון הקלנדרי שבו הדוח מופעל, עד ליום שבו הדוח מופעל, כולל.
THIS_QUARTER_TO_YESTERDAY מתחילת הרבעון הקלנדרי שבו הדוח מופעל, עד היום שלפני הפעלת הדוח (כולל).
THIS_YEAR_TO_DATE מתחילת השנה הקלנדרית שבה הדוח מופעל, עד ליום שבו הדוח מופעל (כולל).
THIS_YEAR_TO_YESTERDAY מתחילת השנה הקלנדרית שבה הדוח מופעל, עד ליום שלפני הפעלת הדוח (כולל).
LAST_WEEK כל השבוע הקלנדרי הקודם, מיום שני עד יום ראשון (כולל), שלפני השבוע הקלנדרי שבו הדוח מופעל.
LAST_WEEK_STARTING_SUNDAY כל השבוע הקלנדרי הקודם, מיום ראשון עד שבת (כולל), שלפני השבוע הקלנדרי שבו הדוח מופעל.
LAST_MONTH כל החודש הקלנדרי הקודם, לפני החודש הקלנדרי שבו הדוח מופעל.
LAST_QUARTER כל הרבעון הקלנדרי הקודם, לפני הרבעון הקלנדרי שבו הדוח מופעל.
LAST_YEAR כל השנה הקלנדרית הקודמת, לפני השנה הקלנדרית שבה הדוח מופעל.
LAST_7_DAYS 7 הימים שלפני היום שבו הדוח מופעל.
LAST_30_DAYS ‫30 הימים שלפני היום שבו הדוח מופעל.
LAST_60_DAYS 60 הימים שלפני היום שבו הדוח מופעל.
LAST_90_DAYS 90 הימים שלפני היום שבו הדוח מופעל.
LAST_93_DAYS ‫93 הימים שלפני היום שבו הדוח מופעל.
LAST_180_DAYS ‫180 הימים שלפני היום שבו הדוח מופק.
LAST_360_DAYS ‫360 הימים שלפני היום שבו הדוח מופעל.
LAST_365_DAYS 365 הימים שלפני היום שבו הדוח מופעל.
LAST_3_MONTHS כל 3 החודשים הקלנדריים שקדמו לחודש הקלנדרי שבו הדוח מופעל.
LAST_6_MONTHS כל 6 החודשים הקלנדריים שקדמו לחודש הקלנדרי שבו הדוח מופק.
LAST_12_MONTHS כל 12 החודשים הקלנדריים שקדמו לחודש הקלנדרי שבו הדוח מופעל.
ALL_AVAILABLE מ-3 שנים לפני הפעלת הדוח ועד ליום שלפני הפעלת הדוח, כולל.

מיון

מייצג מיון בדוח.

ייצוג ב-JSON
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
שדות
field

object (Field)

חובה. שדה (מאפיין או מדד) שלפיו רוצים למיין.

descending

boolean

אופציונלי. סדר המיון. אם הערך הוא True, המיון יהיה בסדר יורד.

Methods

create

יוצרת אובייקט Report.

delete

מחיקת אובייקט Report.

get

אחזור של אובייקט Report.

list

מציג רשימה של Report אובייקטים.

patch

מעדכנת אובייקט Report.

run

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