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 указан, это часовой пояс, который будет использоваться для данного отчета. Оставьте поле пустым для любого другого источника часовых поясов. Часовой пояс в формате 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 Активный вид, видимые объекты.
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 поля объединения. Тип определяет способ объединения базовых фильтров. type может принимать только одно из следующих значений:
fieldFilter

object ( FieldFilter )

Фильтр по одному полю.

notFilter

object ( Filter )

Фильтр, результат работы которого аннулируется.

andFilter

object ( FilterList )

Список фильтров, результаты которых объединены оператором И.

orFilter

object ( FilterList )

Список фильтров, результаты которых объединены оператором ИЛИ.

FieldFilter

Фильтр по определенному полю.

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 объединения (Unium 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 Отрицательные операнды сопоставляются с регулярным выражением или набором регулярных выражений (ни одно из них не обязательно должно совпадать).

ReportValue

Представляет собой отдельное значение в отчете.

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 поля объединения. Значение поля зависит от формата данных поля. value может принимать только одно из следующих значений:
intValue

string ( int64 format)

Для целых значений.

doubleValue

number

Для значений типа double.

stringValue

string

Для строковых значений.

boolValue

boolean

Для логических значений.

intListValue

object ( IntList )

Для списков целочисленных значений.

stringListValue

object ( StringList )

Для списков строковых значений.

doubleListValue

object ( DoubleList )

Для списков значений типа double.

bytesValue

string ( bytes format)

Для значений в байтах.

Строка, закодированная в формате Base64.

IntList

Список целочисленных значений.

JSON-представление 
{
  "values": [
    string
  ]
}
Поля
values[]

string ( int64 format)

Значения

StringList

Список строковых значений.

JSON-представление 
{
  "values": [
    string
  ]
}
Поля
values[]

string

Значения

DoubleList

Список значений типа double.

JSON-представление 
{
  "values": [
    number
  ]
}
Поля
values[]

number

Значения

FilterList

Список фильтров.

JSON-представление 
{
  "filters": [
    {
      object (Filter)
    }
  ]
}
Поля
filters[]

object ( Filter )

Обязательно. Список фильтров.

TimeZoneSource

Источник для определения часового пояса для отчета.

Перечисления
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 )

Относительный временной диапазон.

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

Варианты для указания относительных диапазонов дат.

Перечисления
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, сортировка будет производиться по убыванию.

Методы

create

 Создает объект Report .

delete

 Удаляет объект Report .

get

 Извлекает объект Report .

list

 Список объектов Report .

patch

 Обновляет объект Report .

run

 Инициирует асинхронное выполнение существующего отчета.