Список методов для этого ресурса см. в конце этой страницы.
Представления ресурсов
Отчет DoubleClick Search. Этот объект содержит запрос отчета, некоторые метаданные отчета, такие как код валюты, а также сгенерированные строки отчета или файлы отчета.
{ "kind": "doubleclicksearch#report", "id": string, "isReportReady": boolean, "request": { "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 }, "statisticsCurrencyCode": string, "statisticsTimeZone": string, "rowCount": integer, "files": [ { "url": string, "byteCount": long } ], "rows": [ { (key): (value) } ] }
Имя свойства | Ценить | Описание | Примечания |
---|---|---|---|
files[] | list | Только асинхронный отчет. Содержит список файлов отчетов, созданных после успешного завершения отчета. | |
files[]. byteCount | long | Размер этого файла отчета в байтах. | |
files[]. url | string | Используйте этот URL-адрес для загрузки файла отчета. | |
id | string | Только асинхронный отчет. Идентификатор отчета. | |
isReportReady | boolean | Только асинхронный отчет. Значение true тогда и только тогда, когда отчет выполнен успешно и файлы отчета готовы к загрузке. | |
kind | string | Идентифицирует это как ресурс отчета. Значение: фиксированная строка doubleclicksearch#report . | |
request | nested object | Запрос, создавший отчет. Необязательные поля, не указанные в исходном запросе, заполняются значениями по умолчанию. | |
request. columns[] | list | Столбцы, которые необходимо включить в отчет. Сюда входят как столбцы DoubleClick Search, так и сохраненные столбцы. Для столбцов DoubleClick Search требуется только параметр columnName . Для сохраненных столбцов требуется только параметр savedColumnName . И columnName , и savedColumnName не могут быть установлены в одном и том же разделе.Максимальное количество столбцов на запрос — 300. | |
request.columns[]. columnName | string | Имя столбца DoubleClick Search, который нужно включить в отчет. | |
request.columns[]. customDimensionName | string | Сегментирует отчет по специальному параметру. Отчет должен быть ограничен рекламодателем или ниже, а специальный параметр уже должен быть настроен в DoubleClick Search. Имя специального параметра, которое отображается в DoubleClick Search, чувствительно к регистру. При использовании в отчете о конверсиях возвращает значение указанного специального параметра для данной конверсии, если оно установлено. Этот столбец не сегментирует отчет о конверсиях. | |
request.columns[]. customMetricName | string | Имя специального показателя, который нужно включить в отчет. Отчет должен быть ограничен рекламодателем или ниже, а специальный показатель уже должен быть настроен в DoubleClick Search. Имя специального показателя, которое отображается в DoubleClick Search, чувствительно к регистру. | |
request.columns[]. endDate | string | Включающий день в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с startDate . | |
request.columns[]. groupByColumn | boolean | Только синхронный отчет. Установите значение true , чтобы группировать по этому столбцу. По умолчанию установлено значение false . | |
request.columns[]. headerText | string | Текст, используемый для идентификации этого столбца в выходных данных отчета; по умолчанию — columnName или savedColumnName , если не указано иное. Это можно использовать для предотвращения конфликтов между столбцами DoubleClick Search и сохраненными столбцами с тем же именем. | |
request.columns[]. platformSource | string | Платформа, которая используется для предоставления данных для специального измерения. Приемлемые значения — «прожектор». | |
request.columns[]. productReportPerspective | string | Возвращает метрики только для определенного типа активности продукта. Принятые значения:
| |
request.columns[]. savedColumnName | string | Имя сохраненного столбца для включения в отчет. Отчет должен иметь область рекламодателя или более раннюю версию, и этот сохраненный столбец уже должен быть создан в пользовательском интерфейсе DoubleClick Search. | |
request.columns[]. startDate | string | Включающая дата в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с endDate . | |
request. downloadFormat | string | Формат, в котором должен быть возвращен отчет. В настоящее время поддерживаются csv или tsv . | |
request. filters[] | list | Список фильтров, которые будут применены к отчету. Максимальное количество фильтров на запрос — 300. | |
request.filters[]. column | nested object | Столбец для выполнения фильтра. Это может быть столбец DoubleClick Search или сохраненный столбец. | |
request.filters[].column. columnName | string | Имя столбца DoubleClick Search, который нужно включить в отчет. | |
request.filters[].column. customDimensionName | string | Сегментирует отчет по специальному параметру. Отчет должен быть ограничен рекламодателем или ниже, а специальный параметр уже должен быть настроен в DoubleClick Search. Имя специального параметра, которое отображается в DoubleClick Search, чувствительно к регистру. При использовании в отчете о конверсиях возвращает значение указанного специального параметра для данной конверсии, если оно установлено. Этот столбец не сегментирует отчет о конверсиях. | |
request.filters[].column. customMetricName | string | Имя специального показателя, который нужно включить в отчет. Отчет должен быть ограничен рекламодателем или ниже, а специальный показатель уже должен быть настроен в DoubleClick Search. Имя специального показателя, которое отображается в DoubleClick Search, чувствительно к регистру. | |
request.filters[].column. endDate | string | Включающий день в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с startDate . | |
request.filters[].column. groupByColumn | boolean | Только синхронный отчет. Установите значение true , чтобы группировать по этому столбцу. По умолчанию установлено значение false . | |
request.filters[].column. headerText | string | Текст, используемый для идентификации этого столбца в выходных данных отчета; по умолчанию используется columnName или savedColumnName , если они не указаны. Это можно использовать для предотвращения конфликтов между столбцами DoubleClick Search и сохраненными столбцами с тем же именем. | |
request.filters[].column. platformSource | string | Платформа, которая используется для предоставления данных для специального измерения. Приемлемые значения — «прожектор». | |
request.filters[].column. productReportPerspective | string | Возвращает метрики только для определенного типа активности продукта. Принятые значения:
| |
request.filters[].column. savedColumnName | string | Имя сохраненного столбца для включения в отчет. Отчет должен иметь область рекламодателя или более раннюю версию, и этот сохраненный столбец уже должен быть создан в пользовательском интерфейсе DoubleClick Search. | |
request.filters[].column. startDate | string | Включительная дата в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с endDate . | |
request.filters[]. operator | string | Оператор для использования в фильтре. Список доступных операторов см. в справочнике по фильтру. | |
request.filters[]. values[] | list | Список значений для фильтрации значений столбца. Максимальное количество значений фильтра на запрос — 300. | |
request. includeDeletedEntities | boolean | Определяет, следует ли включать удаленные объекты в отчет. По умолчанию установлено значение false . Устарело, используйте вместо него includeRemovedEntities . | |
request. includeRemovedEntities | boolean | Определяет, следует ли включать удаленные объекты в отчет. По умолчанию установлено значение false . | |
request. maxRowsPerFile | integer | Только асинхронный отчет. Максимальное количество строк в файле отчета. Большой отчет разбивается на множество файлов на основе этого поля. Допустимые значения: от 1000000 до 100000000 включительно. | |
request. orderBy[] | list | Только синхронный отчет. Список столбцов и направлений, определяющих сортировку строк отчета. Максимальное количество заказов на один запрос — 300. | |
request.orderBy[]. column | nested object | Столбец, по которому необходимо выполнить сортировку. Это может быть столбец, определенный DoubleClick Search, или сохраненный столбец. | |
request.orderBy[].column. columnName | string | Имя столбца DoubleClick Search, который нужно включить в отчет. | |
request.orderBy[].column. customDimensionName | string | Сегментирует отчет по специальному параметру. Отчет должен быть ограничен рекламодателем или ниже, а специальный параметр уже должен быть настроен в DoubleClick Search. Имя специального параметра, которое отображается в DoubleClick Search, чувствительно к регистру. При использовании в отчете о конверсиях возвращает значение указанного специального параметра для данной конверсии, если оно установлено. Этот столбец не сегментирует отчет о конверсиях. | |
request.orderBy[].column. customMetricName | string | Имя специального показателя, который нужно включить в отчет. Отчет должен быть ограничен рекламодателем или ниже, а специальный показатель уже должен быть настроен в DoubleClick Search. Имя специального показателя, которое отображается в DoubleClick Search, чувствительно к регистру. | |
request.orderBy[].column. endDate | string | Включающий день в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с startDate . | |
request.orderBy[].column. groupByColumn | boolean | Только синхронный отчет. Установите значение true , чтобы группировать по этому столбцу. По умолчанию установлено значение false . | |
request.orderBy[].column. headerText | string | Текст, используемый для идентификации этого столбца в выходных данных отчета; по умолчанию используется columnName или savedColumnName , если они не указаны. Это можно использовать для предотвращения конфликтов между столбцами DoubleClick Search и сохраненными столбцами с тем же именем. | |
request.orderBy[].column. platformSource | string | Платформа, которая используется для предоставления данных для специального измерения. Приемлемые значения — «прожектор». | |
request.orderBy[].column. productReportPerspective | string | Возвращает метрики только для определенного типа активности продукта. Принятые значения:
| |
request.orderBy[].column. savedColumnName | string | Имя сохраненного столбца для включения в отчет. Отчет должен иметь область рекламодателя или более раннюю версию, и этот сохраненный столбец уже должен быть создан в пользовательском интерфейсе DoubleClick Search. | |
request.orderBy[].column. startDate | string | Включительная дата в формате ГГГГ-ММ-ДД. Если этот параметр предоставлен, он переопределяет общий временной диапазон отчета только для этого столбца. Должен быть предоставлен вместе с endDate . | |
request.orderBy[]. sortOrder | string | Направление сортировки: ascending или descending . | |
request. reportScope | object | reportScope — это набор идентификаторов, которые используются для определения того, какое подмножество сущностей будет возвращено в отчете. Требуется полная линия идентификаторов от самого низкого желаемого уровня до агентства. | |
request.reportScope. adGroupId | long | Идентификатор группы объявлений DS. | |
request.reportScope. adId | long | Идентификатор объявления DS. | |
request.reportScope. advertiserId | long | Идентификатор рекламодателя DS. | |
request.reportScope. agencyId | long | Идентификатор агентства DS. | |
request.reportScope. campaignId | long | Идентификатор кампании DS. | |
request.reportScope. engineAccountId | long | Идентификатор учетной записи ядра DS. | |
request.reportScope. keywordId | long | Идентификатор ключевого слова DS. | |
request. reportType | string | Определяет тип строк, возвращаемых в отчете. Например, если вы укажете reportType: keyword , каждая строка отчета будет содержать данные о ключевом слове. Столбцы, доступные для каждого типа, см. в справочнике по типам отчетов . | |
request. rowCount | integer | Только синхронный отчет. Максимальное количество возвращаемых строк; дополнительные строки удаляются. Допустимые значения: от 0 до 10000 включительно. По умолчанию 10000 . | |
request. startRow | integer | Только синхронный отчет. Индекс первой возвращаемой строки, отсчитываемый от нуля. Допустимые значения: от 0 до 50000 включительно. По умолчанию 0 . | |
request. statisticsCurrency | string | Указывает валюту, в которой будут возвращены денежные средства. Возможные значения: usd , agency (действительно, если область действия отчета ограничена агентством или ниже), advertiser (действительно, если область действия отчета ограничена * рекламодателем или ниже) или account (действительно, если область действия отчета ограничена аккаунтом системы или ниже). . | |
request. timeRange | object | Если в отчете запрашиваются метрики, этот аргумент будет использоваться для ограничения метрик определенным временным диапазоном. | |
request.timeRange. changedAttributesSinceTimestamp | datetime | Включающая временная метка UTC в формате RFC, например 2013-07-16T10:16:23.555Z . См. дополнительные ссылки о том, как работают отчеты об измененных атрибутах. | |
request.timeRange. changedMetricsSinceTimestamp | datetime | Включающая временная метка UTC в формате RFC, например 2013-07-16T10:16:23.555Z . См. дополнительные ссылки о том, как работают отчеты об измененных метриках. | |
request.timeRange. endDate | string | Включающая дата в формате ГГГГ-ММ-ДД. | |
request.timeRange. startDate | string | Включительная дата в формате ГГГГ-ММ-ДД. | |
request. verifySingleTimeZone | boolean | Если true , отчет будет создан только в том случае, если все запрошенные статистические данные получены из одного часового пояса. По умолчанию установлено значение false . | |
rowCount | integer | Количество строк отчета, созданных отчетом, не включая заголовки. | |
rows[] | list | Только синхронный отчет. Сгенерированные строки отчета. | |
rows[]. (key) | any value | Указывает столбцы, представленные в этой строке. То есть каждому ключу соответствует столбец с непустой ячейкой в этой строке. | |
statisticsCurrencyCode | string | Код валюты всех денежных значений, отображаемых в отчете, включая значения, заданные пользователями (например, настройки ставок для ключевых слов) и показатели (например, затраты и доходы). Код валюты отчета определяется полем statisticsCurrency запроса отчета. | |
statisticsTimeZone | string | Если вся статистика отчета взята из одного и того же часового пояса, это будет так. В противном случае поле не установлено. |
Методы
- генерировать
- Немедленно генерирует и возвращает отчет.
- получать
- Опросы статуса запроса отчета.
- получить файл
- Загружает файл отчета в кодировке UTF-8.
- getIdMappingFile
- Загружает CSV-файл (в кодировке UTF-8), содержащий сопоставления идентификаторов между предыдущей версией Search Ads 360 и новой Search Ads 360. Для запрошенного рекламодателя файл включает все дочерние объекты (например, учетные записи системы, кампании, группы объявлений и т. д.). .), которые существовали как в предыдущей версии Search Ads 360, так и в новой Search Ads 360.
- запрос
- Вставляет запрос отчета в систему отчетов.