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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

locale

string

فقط خروجی. زبان این گزارش. زبان از زبان کاربر در زمان درخواست تنظیم می‌شود. زبان قابل تغییر نیست.

تعریف گزارش

تعریف نحوه اجرای یک گزارش.

نمایش 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) است. اگر منبع ارائه شده باشد، فیلد منطقه زمانی در تعریف گزارش نیز باید یک منطقه زمانی تنظیم کند.

timeZone

string

اختیاری. اگر timeZoneSource ارائه شده باشد، این منطقه زمانی است که برای این گزارش استفاده می‌شود. برای هر منبع منطقه زمانی دیگر، خالی بگذارید. منطقه زمانی با فرمت IANA. به عنوان مثال، "America/New_York".

currencyCode

string

اختیاری. کد ارزی ISO 4217 برای این گزارش. در صورت عدم تعیین، به طور پیش‌فرض کد ارزی حساب در نظر گرفته می‌شود.

dateRange

object ( DateRange )

الزامی. محدوده تاریخ اصلی این گزارش.

sorts[]

object ( Sort )

اختیاری. مرتب‌سازی‌های پیش‌فرض برای این گزارش اعمال می‌شود.

ابعاد

ابعاد گزارشگری.

انوم‌ها
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 نام نمایشی محلی‌شده‌ی وضعیت پاسخ درخواست‌های بخش داده در فرآیند گزینش بلادرنگ. برای جزئیات بیشتر به 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 هفته.

متریک

گزارش معیارها.

انوم‌ها
METRIC_UNSPECIFIED مقدار پیش‌فرض. این مقدار استفاده نشده است.
ACTIVE_VIEW_MEASURABILITY_RATE نرخ اندازه‌گیری نمای فعال.
ACTIVE_VIEW_MEASURABLE نمای فعال قابل اندازه‌گیری.
ACTIVE_VIEW_VIEWABILITY_RATE نرخ مشاهده‌پذیری نمای فعال.
ACTIVE_VIEW_VIEWABLE نمایش فعال imp های قابل مشاهده.
AUCTIONS_WON مزایده‌ها برنده شدند.
BIDS پیشنهادهای قیمت
BIDS_IN_AUCTION پیشنهاد قیمت در حراج.
BID_REQUESTS درخواست‌های مناقصه.
CLICKS کلیک‌ها
CURATION_PARTNER_FEE هزینه متصدی
DATA_SEGMENT_REQUESTS تعداد درخواست‌های ارسال‌شده برای بخش داده در فرآیند گزینش بلادرنگ.
IMPRESSIONS برداشت‌ها.
SPEND با ارز گزارشگری مشخص شده در درخواست هزینه کنید. به طور پیش‌فرض دلار آمریکا است.

فیلتر

فیلتری روی یک یا چند فیلد.

نمایش JSON 
{

  // Union field type can be only one of the following:
  "fieldFilter": {
    object (FieldFilter)
  },
  "notFilter": {
    object (Filter)
  },
  "andFilter": {
    object (FilterList)
  },
  "orFilter": {
    object (FilterList)
  }
  // End of list of possible types for union field type.
}
فیلدها
type فیلد Union. این نوع، نحوه ترکیب فیلترهای زیرین را تعیین می‌کند. type می‌تواند فقط یکی از موارد زیر باشد:
fieldFilter

object ( FieldFilter )

یک فیلتر روی یک فیلد واحد.

notFilter

object ( Filter )

فیلتری که نتیجه آن منفی است.

andFilter

object ( FilterList )

فهرستی از فیلترهایی که نتایج آنها با AND-ed ویرایش می‌شوند.

orFilter

object ( FilterList )

فهرستی از فیلترهایی که نتایج آنها با OR ویرایش شده است.

فیلتر میدانی

فیلتر روی یک فیلد خاص.

نمایش JSON 
{
  "field": {
    object (Field)
  },
  "operation": enum (Operation),
  "values": [
    {
      object (ReportValue)
    }
  ]
}
فیلدها
field

object ( Field )

الزامی. فیلدی که باید روی آن فیلتر انجام شود.

operation

enum ( Operation )

مورد نیاز. عملکرد این فیلتر.

values[]

object ( ReportValue )

مقادیری که باید فیلتر شوند. الزامی.

میدان

یک بُعد یا یک معیار در یک گزارش.

نمایش JSON 
{

  // Union field field can be only one of the following:
  "dimension": enum (Dimension),
  "metric": enum (Metric)
  // End of list of possible types for union field field.
}
فیلدها
field یونیون (Union Field) فیلد. چه یک بُعد باشد چه یک متریک. field می‌تواند فقط یکی از موارد زیر باشد:
dimension

enum ( Dimension )

بُعدی که این میدان نشان می‌دهد.

metric

enum ( Metric )

معیاری که این فیلد نشان می‌دهد.

عملیات

عملیات فیلتر پشتیبانی شده.

انوم‌ها
IN

برای عملوندهای اسکالر، بررسی می‌کند که آیا عملوند در مجموعه مقادیر فیلتر ارائه شده وجود دارد یا خیر.

برای عملوندهای لیستی، بررسی می‌کند که آیا عنصری در عملوند در مجموعه مقادیر فیلتر ارائه شده وجود دارد یا خیر.

مقدار پیش‌فرض.

NOT_IN

برای عملوندهای اسکالر، بررسی می‌کند که عملوند در مجموعه مقادیر فیلتر ارائه شده نباشد.

برای عملوندهای لیستی، بررسی می‌کند که هیچ یک از عناصر موجود در عملوند در مجموعه مقادیر فیلتر ارائه شده نباشد.

CONTAINS

برای عملوندهای رشته‌ای اسکالر، بررسی می‌کند که آیا عملوند شامل هر یک از زیررشته‌های فیلتر ارائه شده است یا خیر.

برای عملوندهای لیست رشته‌ای، بررسی می‌کند که آیا رشته‌ای در عملوند شامل هر یک از زیررشته‌های فیلتر ارائه شده است یا خیر.

NOT_CONTAINS

برای عملوندهای رشته‌ای اسکالر، بررسی می‌کند که عملوند شامل هیچ یک از زیررشته‌های فیلتر ارائه شده نباشد.

برای عملوندهای لیست رشته‌ای، بررسی می‌کند که هیچ یک از رشته‌های موجود در عملوند شامل هیچ یک از زیررشته‌های فیلتر ارائه شده نباشد.

LESS_THAN عملوند کمتر از مقدار فیلتر ارائه شده است.
LESS_THAN_EQUALS عملوند کوچکتر یا مساوی مقدار فیلتر ارائه شده است.
GREATER_THAN مقدار عملوند از مقدار فیلتر ارائه شده بزرگتر است.
GREATER_THAN_EQUALS عملوند بزرگتر یا مساوی مقدار فیلتر ارائه شده است.
BETWEEN عملوند بین مقادیر فیلتر ارائه شده است.
MATCHES عملوند با یک عبارت منظم یا مجموعه‌ای از عبارات منظم مطابقت دارد (یکی از آنها باید مطابقت داشته باشد).
NOT_MATCHES عملوند منفی با یک عبارت منظم یا مجموعه‌ای از عبارات منظم مطابقت دارد (هیچ‌کدام نباید مطابقت داشته باشند).

گزارش ارزش

نشان دهنده یک مقدار واحد در یک گزارش است.

نمایش JSON 
{

  // Union field value can be only one of the following:
  "intValue": string,
  "doubleValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "intListValue": {
    object (IntList)
  },
  "stringListValue": {
    object (StringList)
  },
  "doubleListValue": {
    object (DoubleList)
  },
  "bytesValue": string
  // End of list of possible types for union field value.
}
فیلدها
value فیلد Union. مقدار فیلد به فرمت داده فیلد بستگی دارد. value می‌تواند فقط یکی از موارد زیر باشد:
intValue

string ( int64 format)

برای مقادیر صحیح.

doubleValue

number

برای مقادیر دوگانه.

stringValue

string

برای مقادیر رشته‌ای.

boolValue

boolean

برای مقادیر بولی.

intListValue

object ( IntList )

برای لیست‌هایی از مقادیر صحیح.

stringListValue

object ( StringList )

برای لیست‌هایی از مقادیر رشته‌ای.

doubleListValue

object ( DoubleList )

برای لیست‌هایی از مقادیر دوگانه.

bytesValue

string ( bytes format)

برای مقادیر بایت.

یک رشته کدگذاری شده با base64.

لیست داخلی

فهرستی از مقادیر صحیح.

نمایش JSON 
{
  "values": [
    string
  ]
}
فیلدها
values[]

string ( int64 format)

ارزش‌ها

لیست رشته‌ای

فهرستی از مقادیر رشته‌ای.

نمایش JSON 
{
  "values": [
    string
  ]
}
فیلدها
values[]

string

ارزش‌ها

دابل لیست

فهرستی از مقادیر دوگانه.

نمایش JSON 
{
  "values": [
    number
  ]
}
فیلدها
values[]

number

ارزش‌ها

لیست فیلتر

فهرستی از فیلترها.

نمایش JSON 
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
فیلدها
filters[]

object ( Filter )

الزامی. فهرستی از فیلترها.

منبع منطقه زمانی

منبعی برای تعیین منطقه زمانی گزارش.

انوم‌ها
TIME_ZONE_SOURCE_UNSPECIFIED مقدار پیش‌فرض نامشخص.
AD_EXCHANGE از منطقه زمانی اقیانوس آرام (PT) استفاده کنید.
UTC از منطقه زمانی UTC استفاده کنید.
PROVIDED از منطقه زمانی ارائه شده در فیلد ReportDefinition.time_zone استفاده کنید. اجرای گزارش‌ها ممکن است بیشتر طول بکشد زیرا تاریخ‌ها به صورت پویا در زمان درخواست محاسبه می‌شوند.

محدوده تاریخ

محدوده تاریخ برای گزارش.

نمایش JSON 
{

  // Union field date_range_type can be only one of the following:
  "fixed": {
    object (FixedDateRange)
  },
  "relative": enum (RelativeDateRange)
  // End of list of possible types for union field date_range_type.
}
فیلدها
فیلد اتحادیه‌ای date_range_type . یا یک محدوده تاریخ ثابت یا نسبی. date_range_type فقط می‌تواند یکی از موارد زیر باشد:
fixed

object ( FixedDateRange )

یک محدوده تاریخ ثابت.

relative

enum ( RelativeDateRange )

یک محدوده تاریخ نسبی.

محدوده تاریخ ثابت

یک محدوده تاریخی بین دو تاریخ ثابت (شامل تاریخ پایان).

نمایش JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
فیلدها
startDate

object ( Date )

الزامی. تاریخ شروع این محدوده تاریخ.

endDate

object ( Date )

الزامی. تاریخ پایان (شامل) این محدوده تاریخ.

تاریخ

نشان دهنده یک تاریخ تقویمی کامل یا جزئی، مانند تاریخ تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده‌اند یا اهمیت چندانی ندارند. تاریخ نسبت به تقویم میلادی است. این می‌تواند یکی از موارد زیر را نشان دهد:

  • یک تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
  • یک ماه و یک روز، با یک سال صفر (مثلاً یک سالگرد).
  • یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
  • یک سال و یک ماه، با یک روز صفر (برای مثال، تاریخ انقضای کارت اعتباری).

انواع مرتبط:

نمایش JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
فیلدها
year

integer

سال تاریخ. باید از ۱ تا ۹۹۹۹ باشد، یا برای مشخص کردن تاریخ بدون سال، ۰ باشد.

month

integer

ماه سال. باید از ۱ تا ۱۲ باشد، یا برای مشخص کردن سال بدون ماه و روز، ۰ باشد.

day

integer

روز ماه. باید از ۱ تا ۳۱ باشد و برای سال و ماه معتبر باشد، یا ۰ برای مشخص کردن یک سال به تنهایی یا یک سال و ماه که روز در آن مهم نیست.

محدوده تاریخ نسبی

گزینه‌هایی برای محدوده‌های تاریخ نسبی.

انوم‌ها
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 ۷ روز قبل از روز اجرای گزارش.
LAST_30_DAYS 30 روز قبل از روز اجرای گزارش.
LAST_60_DAYS ۶۰ روز قبل از روز اجرای گزارش.
LAST_90_DAYS ۹۰ روز قبل از روز اجرای گزارش.
LAST_93_DAYS ۹۳ روز قبل از روز اجرای گزارش.
LAST_180_DAYS ۱۸۰ روز قبل از روز اجرای گزارش.
LAST_360_DAYS ۳۶۰ روز قبل از روز اجرای گزارش.
LAST_365_DAYS ۳۶۵ روز قبل از روز اجرای گزارش.
LAST_3_MONTHS کل ۳ ماه تقویمی قبل از ماه تقویمی که گزارش در آن اجرا می‌شود.
LAST_6_MONTHS کل ۶ ماه تقویمی قبل از ماه تقویمی که گزارش در آن اجرا می‌شود.
LAST_12_MONTHS کل ۱۲ ماه تقویمی قبل از ماه تقویمی که گزارش در آن اجرا می‌شود.
ALL_AVAILABLE از ۳ سال قبل از اجرای گزارش، تا روز قبل از اجرای گزارش، شامل همه می‌شود.

مرتب سازی

نشان دهنده مرتب سازی در یک گزارش است.

نمایش JSON 
{
  "field": {
    object (Field)
  },
  "descending": boolean
}
فیلدها
field

object ( Field )

الزامی. فیلدی (بعد یا معیار) برای مرتب‌سازی بر اساس آن.

descending

boolean

اختیاری. ترتیب مرتب‌سازی. اگر درست باشد، مرتب‌سازی نزولی خواهد بود.

روش‌ها

create

 یک شیء Report ) ایجاد می‌کند.

delete

 یک شیء Report را حذف می‌کند.

get

 یک شیء Report را بازیابی می‌کند.

list

 لیست‌ها، Report اشیاء.

patch

 یک شیء Report را به‌روزرسانی می‌کند.

run

 اجرای یک گزارش موجود را به صورت غیرهمزمان آغاز می‌کند.