Создает и немедленно возвращает отчет. Попробуйте прямо сейчас .
Запрос
HTTP-запрос
POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate
Авторизация
Этот запрос требует авторизации со следующей областью действия:
Объем |
---|
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 | Идентификатор объявления ДС. | |
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 или сохраненный столбец. | |
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 | Возвращает метрики только для определенного типа активности продукта. Допустимые значения:
| |
filters[].column. productReportPerspective | string | Возвращает метрики только для определенного типа активности продукта. Допустимые значения:
| |
orderBy[].column. productReportPerspective | string | Возвращает метрики только для определенного типа активности продукта. Допустимые значения:
|
Ответ
В случае успеха этот метод возвращает ресурс Reports в тексте ответа.
Попробуй это!
Используйте обозреватель API ниже, чтобы вызвать этот метод для оперативных данных и просмотреть ответ. В качестве альтернативы попробуйте автономный проводник .