Предыдущий API отчетов Search Ads 360 выведен из эксплуатации. Теперь вы можете создавать отчеты с помощью нового API отчетов Search Ads 360 .

Обратите внимание, что API конверсий Search Ads 360 не будет затронут и будет продолжать поддерживаться.

Эта страница переведена с помощью Cloud Translation API.

Reports: request

Вставляет запрос отчета в систему отчетов. Попробуйте сейчас .

Запрос

HTTP-запрос

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

Авторизация

Этот запрос требует авторизации со следующей областью действия:

Объем
`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`	Включающая дата в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с `endDate` .
`columns[]. endDate`	`string`	Включающий день в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с `startDate` .
`columns[]. groupByColumn`	`boolean`	Только синхронный отчет. Установите значение `true` , чтобы группировать по этому столбцу. По умолчанию установлено значение `false` .
`timeRange`	`object`	Если в отчете запрашиваются метрики, этот аргумент будет использоваться для ограничения метрик определенным временным диапазоном.
`timeRange. startDate`	`string`	Включающая дата в формате ГГГГ-ММ-ДД.
`timeRange. endDate`	`string`	Включающая дата в формате ГГГГ-ММ-ДД.
`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`	Платформа, которая используется для предоставления данных для специального измерения. Приемлемые значения — «прожектор».
`filters[].column. customDimensionName`	`string`	Сегментирует отчет по специальному параметру. Отчет должен быть ограничен рекламодателем или ниже, а специальный параметр уже должен быть настроен в DoubleClick Search. Имя специального параметра, которое отображается в DoubleClick Search, чувствительно к регистру. При использовании в отчете о конверсиях возвращает значение указанного специального параметра для данной конверсии, если оно установлено. Этот столбец не сегментирует отчет о конверсиях.
`filters[].column. headerText`	`string`	Текст, используемый для идентификации этого столбца в выходных данных отчета; по умолчанию — `columnName` или `savedColumnName` , если не указано иное. Это можно использовать для предотвращения конфликтов между столбцами DoubleClick Search и сохраненными столбцами с тем же именем.
`filters[].column. startDate`	`string`	Включающая дата в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с `endDate` .
`filters[].column. endDate`	`string`	Включающий день в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с `startDate` .
`filters[].column. groupByColumn`	`boolean`	Только синхронный отчет. Установите значение `true` , чтобы группировать по этому столбцу. По умолчанию установлено значение `false` .
`filters[].column. platformSource`	`string`	Платформа, которая используется для предоставления данных для специального измерения. Приемлемые значения — «прожектор».
`orderBy[].column. customDimensionName`	`string`	Сегментирует отчет по специальному параметру. Отчет должен быть ограничен рекламодателем или ниже, а специальный параметр уже должен быть настроен в DoubleClick Search. Имя специального параметра, которое отображается в DoubleClick Search, чувствительно к регистру. При использовании в отчете о конверсиях возвращает значение указанного специального параметра для данной конверсии, если оно установлено. Этот столбец не сегментирует отчет о конверсиях.
`orderBy[].column. headerText`	`string`	Текст, используемый для идентификации этого столбца в выходных данных отчета; по умолчанию — `columnName` или `savedColumnName` , если не указано иное. Это можно использовать для предотвращения конфликтов между столбцами DoubleClick Search и сохраненными столбцами с тем же именем.
`orderBy[].column. startDate`	`string`	Включающая дата в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с `endDate` .
`orderBy[].column. endDate`	`string`	Включающий день в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с `startDate` .
`orderBy[].column. groupByColumn`	`boolean`	Только синхронный отчет. Установите значение `true` , чтобы группировать по этому столбцу. По умолчанию установлено значение `false` .
`orderBy[].column. platformSource`	`string`	Платформа, которая используется для предоставления данных для специального измерения. Приемлемые значения — «прожектор».
`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` »: возвращает показатели только для продуктов, которые рекламировались в торговой кампании и которые могли быть проданы, а могли и не быть проданы.

Ответ

В случае успеха этот метод возвращает ресурс Reports в теле ответа.

Попробуйте!

Используйте API-интерфейс ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ. Альтернативно попробуйте автономный Проводник .