Queries

Поддержка этой версии Bid Manager API прекращена. Пользователи должны использовать Bid Manager API версии 2 .

Список методов для этого ресурса см. в конце этой страницы.

Представления ресурсов

Представляет запрос.

{
  "kind": "doubleclickbidmanager#query",
  "queryId": long,
  "metadata": {
    "title": string,
    "dataRange": string,
    "format": string,
    "running": boolean,
    "reportCount": integer,
    "googleCloudStoragePathForLatestReport": string,
    "latestReportRunTimeMs": long,
    "googleDrivePathForLatestReport": string,
    "sendNotification": boolean,
    "shareEmailAddress": [
      string
    ],
    "locale": string
  },
  "params": {
    "type": string,
    "groupBys": [
      string
    ],
    "filters": [
      {
        "type": string,
        "value": string
      }
    ],
    "metrics": [
      string
    ],
    "includeInviteData": boolean
  },
  "schedule": {
    "frequency": string,
    "endTimeMs": long,
    "nextRunMinuteOfDay": integer,
    "nextRunTimezoneCode": string
  },
  "reportDataStartTimeMs": long,
  "reportDataEndTimeMs": long,
  "timezoneCode": string
}

Имя свойства	Ценить	Описание	Примечания
kind	string	Определяет, что это за ресурс. Значение: фиксированная строка "doubleclickbidmanager#query" .
metadata	nested object	Метаданные запроса.
metadata. dataRange	string	Диапазон данных отчета. Приемлемые значения: " ALL_TIME " " CURRENT_DAY " " CUSTOM_DATES " " LAST_14_DAYS " " LAST_30_DAYS " " LAST_365_DAYS " " LAST_7_DAYS " " LAST_90_DAYS " " MONTH_TO_DATE " " PREVIOUS_DAY " " PREVIOUS_HALF_MONTH " " PREVIOUS_MONTH " " PREVIOUS_QUARTER " " PREVIOUS_WEEK " " PREVIOUS_YEAR " " QUARTER_TO_DATE " " TYPE_NOT_SUPPORTED " " WEEK_TO_DATE " " YEAR_TO_DATE "
metadata. format	string	Формат создаваемого отчета. Приемлемые значения: " CSV " " EXCEL_CSV " " XLSX "
metadata. googleCloudStoragePathForLatestReport	string	Путь к месту в Google Cloud Storage, где хранится последний отчет.
metadata. googleDrivePathForLatestReport	string	Путь к последнему отчету на Google Диске.
metadata. latestReportRunTimeMs	long	Время начала запуска последнего отчета.
metadata. locale	string	Локаль создаваемых отчетов. Приемлемые значения: " cs " для ЧЕШСКОГО " de " для НЕМЕЦКОГО « en » для АНГЛИЙСКОГО " es " для ИСПАНСКОГО " fr " для ФРАНЦУЗСКОГО " it " на ИТАЛЬЯНСКОМ « ja » по-японски " ko " на КОРЕЙСКОМ " pl " для ПОЛЬСКОГО " pt-BR " для БРАЗИЛЬСКОГО_ПОРТУГАЛЬСКОГО " ru " для РУССКОГО " tr " для ТУРЕЦКОГО " uk " для УКРАИНСКОГО " zh-CN " для CHINA_CHINESE « zh-TW » для ТАЙВАНЬ_КИТАЙСКОГО Строка локали, которой нет в списке выше, будет генерировать отчеты на английском языке.
metadata. reportCount	integer	Количество отчетов, созданных по запросу.
metadata. running	boolean	Выполняется ли в данный момент последний отчет.
metadata. sendNotification	boolean	Отправлять ли уведомление по электронной почте о готовности отчета. По умолчанию — ложь.
metadata. shareEmailAddress[]	list	Список адресов электронной почты, на которые отправляются уведомления по электронной почте после завершения отчета. Отдельно от sendNotification .
metadata. title	string	Название запроса. Он используется для обозначения отчетов, созданных на основе этого запроса.
params	nested object	Параметры запроса.
params. filters[]	list	Фильтры , используемые для сопоставления данных о трафике в вашем отчете.
params.filters[]. type	string	Тип фильтра. Приемлемые значения: " FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY " " FILTER_ACTIVITY_ID " " FILTER_ADVERTISER " " FILTER_ADVERTISER_CURRENCY " " FILTER_ADVERTISER_TIMEZONE " " FILTER_AD_POSITION " " FILTER_AGE " " FILTER_AUTHORIZED_SELLER_STATE_ID " " FILTER_BRANDSAFE_CHANNEL_ID " " FILTER_BROWSER " " FILTER_BUDGET_SEGMENT_DESCRIPTION " " FILTER_CAMPAIGN_DAILY_FREQUENCY " " FILTER_CARRIER " " FILTER_CHANNEL_ID " " FILTER_CITY " " FILTER_COMPANION_CREATIVE_ID " " FILTER_CONVERSION_DELAY " " FILTER_COUNTRY " " FILTER_CREATIVE_ATTRIBUTE " " FILTER_CREATIVE_HEIGHT " " FILTER_CREATIVE_ID " " FILTER_CREATIVE_SIZE " " FILTER_CREATIVE_TYPE " " FILTER_CREATIVE_WIDTH " " FILTER_DATA_PROVIDER " " FILTER_DATE " " FILTER_DAY_OF_WEEK " " FILTER_DEVICE_MAKE " " FILTER_DEVICE_MODEL " " FILTER_DEVICE_TYPE " " FILTER_DFP_ORDER_ID " " FILTER_DMA " " FILTER_DV360_ACTIVITY_ID " " FILTER_EXCHANGE_ID " " FILTER_FLOODLIGHT_ACTIVITY_ID " " FILTER_FLOODLIGHT_PIXEL_ID " " FILTER_GENDER " " FILTER_INSERTION_ORDER " " FILTER_INVENTORY_COMMITMENT_TYPE " " FILTER_INVENTORY_DELIVERY_METHOD " " FILTER_INVENTORY_FORMAT " " FILTER_INVENTORY_RATE_TYPE " " FILTER_INVENTORY_SOURCE " " FILTER_INVENTORY_SOURCE_TYPE " " FILTER_KEYWORD " " FILTER_LINE_ITEM " " FILTER_LINE_ITEM_DAILY_FREQUENCY " " FILTER_LINE_ITEM_LIFETIME_FREQUENCY " " FILTER_LINE_ITEM_TYPE " " FILTER_MEDIA_PLAN " " FILTER_MOBILE_DEVICE_MAKE " " FILTER_MOBILE_DEVICE_MAKE_MODEL " " FILTER_MOBILE_DEVICE_TYPE " " FILTER_MOBILE_GEO " " FILTER_MONTH " " FILTER_MRAID_SUPPORT " " FILTER_NIELSEN_AGE " " FILTER_NIELSEN_COUNTRY_CODE " " FILTER_NIELSEN_DEVICE_ID " " FILTER_NIELSEN_GENDER " " FILTER_NOT_SUPPORTED " " FILTER_ORDER_ID " " FILTER_OS " " FILTER_PAGE_CATEGORY " " FILTER_PAGE_LAYOUT " " FILTER_PARTNER " " FILTER_PARTNER_CURRENCY " " FILTER_PUBLIC_INVENTORY " " FILTER_QUARTER " " FILTER_REGION " " FILTER_REGULAR_CHANNEL_ID " " FILTER_SITE_ID " " FILTER_SITE_LANGUAGE " " FILTER_SKIPPABLE_SUPPORT " " FILTER_TARGETED_USER_LIST " " FILTER_TIME_OF_DAY " " FILTER_TRUEVIEW_AD_GROUP_AD_ID " " FILTER_TRUEVIEW_AD_GROUP_ID " " FILTER_TRUEVIEW_AGE " " FILTER_TRUEVIEW_CATEGORY " " FILTER_TRUEVIEW_CITY " " FILTER_TRUEVIEW_CONVERSION_TYPE " " FILTER_TRUEVIEW_COUNTRY " " FILTER_TRUEVIEW_CUSTOM_AFFINITY " " FILTER_TRUEVIEW_DMA " " FILTER_TRUEVIEW_GENDER " " FILTER_TRUEVIEW_IAR_AGE " " FILTER_TRUEVIEW_IAR_CATEGORY " " FILTER_TRUEVIEW_IAR_CITY " " FILTER_TRUEVIEW_IAR_COUNTRY " " FILTER_TRUEVIEW_IAR_GENDER " " FILTER_TRUEVIEW_IAR_INTEREST " " FILTER_TRUEVIEW_IAR_LANGUAGE " " FILTER_TRUEVIEW_IAR_PARENTAL_STATUS " " FILTER_TRUEVIEW_IAR_REGION " " FILTER_TRUEVIEW_IAR_REMARKETING_LIST " " FILTER_TRUEVIEW_IAR_TIME_OF_DAY " " FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL " " FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO " " FILTER_TRUEVIEW_IAR_ZIPCODE " " FILTER_TRUEVIEW_INTEREST " " FILTER_TRUEVIEW_KEYWORD " " FILTER_TRUEVIEW_PARENTAL_STATUS " " FILTER_TRUEVIEW_PLACEMENT " " FILTER_TRUEVIEW_REGION " " FILTER_TRUEVIEW_REMARKETING_LIST " " FILTER_TRUEVIEW_URL " " FILTER_TRUEVIEW_ZIPCODE " " FILTER_UNKNOWN " " FILTER_USER_LIST " " FILTER_USER_LIST_FIRST_PARTY " " FILTER_USER_LIST_THIRD_PARTY " " FILTER_VIDEO_AD_POSITION_IN_STREAM " " FILTER_VIDEO_COMPANION_SIZE " " FILTER_VIDEO_COMPANION_TYPE " " FILTER_VIDEO_CREATIVE_DURATION " " FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE " " FILTER_VIDEO_DURATION_SECONDS " " FILTER_VIDEO_FORMAT_SUPPORT " " FILTER_VIDEO_INVENTORY_TYPE " " FILTER_VIDEO_PLAYER_SIZE " " FILTER_VIDEO_RATING_TIER " " FILTER_VIDEO_SKIPPABLE_SUPPORT " " FILTER_VIDEO_VPAID_SUPPORT " " FILTER_WEEK " " FILTER_YEAR " " FILTER_YOUTUBE_VERTICAL " " FILTER_ZIP_CODE "
params.filters[]. value	string	Значение фильтра.
params. groupBys[]	list	Данные группируются по фильтрам, указанным в этом поле.
params. includeInviteData	boolean	Устарело. Это поле больше не используется.
params. metrics[]	list	Метрики, которые нужно включить в виде столбцов в отчет.
params. type	string	Тип отчета. Ограничения для конкретного типа: TYPE_ORDER_ID поддерживает диапазоны дат не более 60 дней назад. TYPE_AUDIENCE_COMPOSITION , TYPE_INVENTORY_AVAILABILITY , TYPE_TRUEVIEW_IAR диапазон дат поддержки не может превышать 30 дней назад. Приемлемые значения: " TYPE_ACTIVE_GRP " " TYPE_AUDIENCE_COMPOSITION " " TYPE_AUDIENCE_PERFORMANCE " " TYPE_CLIENT_SAFE " " TYPE_COMSCORE_VCE " " TYPE_CROSS_FEE " " TYPE_CROSS_PARTNER " " TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER " " TYPE_ESTIMATED_CONVERSION " " TYPE_FEE " " TYPE_GENERAL " " TYPE_INVENTORY_AVAILABILITY " " TYPE_KEYWORD " " TYPE_LINEAR_TV_SEARCH_LIFT " " TYPE_NIELSEN_AUDIENCE_PROFILE " " TYPE_NIELSEN_DAILY_REACH_BUILD " " TYPE_NIELSEN_ONLINE_GLOBAL_MARKET " " TYPE_NIELSEN_SITE " " TYPE_NOT_SUPPORTED " " TYPE_ORDER_ID " " TYPE_PAGE_CATEGORY " " TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE " " TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD " " TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET " " TYPE_PIXEL_LOAD " " TYPE_REACH_AND_FREQUENCY " " TYPE_REACH_AUDIENCE " " TYPE_THIRD_PARTY_DATA_PROVIDER " " TYPE_TRUEVIEW " " TYPE_TRUEVIEW_IAR " " TYPE_VERIFICATION " " TYPE_YOUTUBE_VERTICAL "
queryId	long	Идентификатор запроса.
reportDataEndTimeMs	long	Время окончания данных, отображаемых в отчете. Обратите внимание, reportDataEndTimeMs требуется, если metadata.dataRange имеет CUSTOM_DATES , и игнорируется в противном случае.
reportDataStartTimeMs	long	Время начала данных, отображаемых в отчете. Обратите внимание, reportDataStartTimeMs требуется, если metadata.dataRange имеет CUSTOM_DATES , и игнорируется в противном случае.
schedule	nested object	Информация о том, как часто и когда выполнять запрос.
schedule. endTimeMs	long	Datetime для периодического выполнения запроса до тех пор.
schedule. frequency	string	Как часто выполняется запрос. Приемлемые значения: " DAILY " " MONTHLY " " ONE_TIME " " QUARTERLY " " SEMI_MONTHLY " " WEEKLY "
schedule. nextRunMinuteOfDay	integer	Устарело. Это поле не имеет никакого эффекта.
schedule. nextRunTimezoneCode	string	Канонический код часового пояса для времени создания отчета. По умолчанию — America/New_York .
timezoneCode	string	Канонический код часового пояса для времени данных отчета. По умолчанию — America/New_York .

Методы

создать запрос

Создает запрос.

удалить запрос

Удаляет сохраненный запрос, а также связанные с ним сохраненные отчеты.

получить запрос

Получает сохраненный запрос.

списки запросов

Извлекает сохраненные запросы.

запуск запроса

Запускает сохраненный запрос для создания отчета.