- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- Сетьрепортспек
- Измерение
- Метрика
- Фильтр размеров
- Условие сортировки
- Примеры
- Попробуйте!
Создает отчет о сети AdMob на основе предоставленной спецификации отчета. Возвращает результат потокового RPC на стороне сервера. Результат возвращается в виде последовательности ответов.
HTTP-запрос
POST https://admob.googleapis.com/v1/{parent=accounts/*}/networkReport:generate
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
parent | Имя ресурса учетной записи, для которой создается отчет. Пример: account/pub-9876543210987654. |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{
"reportSpec": {
object ( |
Поля | |
---|---|
reportSpec | Спецификация сетевого отчета. |
Тело ответа
Потоковый ответ для отчета сети AdMob, где первый ответ содержит заголовок отчета, затем поток ответов по строкам и, наконец, нижний колонтитул в качестве последнего ответного сообщения.
Например:
[{
"header": {
"dateRange": {
"startDate": {"year": 2018, "month": 9, "day": 1},
"endDate": {"year": 2018, "month": 9, "day": 1}
},
"localizationSettings": {
"currencyCode": "USD",
"languageCode": "en-US"
}
}
},
{
"row": {
"dimensionValues": {
"DATE": {"value": "20180918"},
"APP": {
"value": "ca-app-pub-8123415297019784~1001342552",
displayLabel: "My app name!"
}
},
"metricValues": {
"ESTIMATED_EARNINGS": {"microsValue": 6500000}
}
}
},
{
"footer": {"matchingRowCount": 1}
}]
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
payload Union Field. Каждое ответное сообщение потока содержит один тип полезной нагрузки. payload может быть только одной из следующих: | |
header | Настройки создания отчета, описывающие содержимое отчета, например диапазон дат отчета и настройки локализации. |
row | Фактические данные отчета. |
footer | Дополнительная информация о созданном отчете, например предупреждения о данных. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/admob.readonly
-
https://www.googleapis.com/auth/admob.report
Дополнительную информацию см. в обзоре OAuth 2.0 .
Сетьрепортспек
Спецификация для создания отчета о сети AdMob. Например, спецификация для получения кликов и расчетного дохода только для стран «США» и «CN» может выглядеть следующим образом:
{
'dateRange': {
'startDate': {'year': 2021, 'month': 9, 'day': 1},
'endDate': {'year': 2021, 'month': 9, 'day': 30}
},
'dimensions': ['DATE', 'APP', 'COUNTRY'],
'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
'dimensionFilters': [
{
'dimension': 'COUNTRY',
'matchesAny': {'values': [{'value': 'US', 'value': 'CN'}]}
}
],
'sortConditions': [
{'dimension':'APP', order: 'ASCENDING'},
{'metric':'CLICKS', order: 'DESCENDING'}
],
'localizationSettings': {
'currencyCode': 'USD',
'languageCode': 'en-US'
}
}
Для лучшего понимания вы можете рассматривать предыдущую спецификацию как следующий псевдо-SQL:
SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
FROM NETWORK_REPORT
WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30'
AND COUNTRY IN ('US', 'CN')
GROUP BY DATE, APP, COUNTRY
ORDER BY APP ASC, CLICKS DESC;
JSON-представление |
---|
{ "dateRange": { object ( |
Поля | |
---|---|
dateRange | Диапазон дат, за который создается отчет. |
dimensions[] | Список измерений отчета. Комбинация значений этих измерений определяет строку отчета. Если параметры не указаны, отчет возвращает одну строку запрошенных показателей для всей учетной записи. |
metrics[] | Список метрик отчета. В отчете должна быть указана хотя бы одна метрика. |
dimensionFilters[] | Описывает, какие строки отчета следует сопоставлять на основе значений их измерений. |
sortConditions[] | Описывает сортировку строк отчета. Порядок условия в списке определяет его приоритет; чем раньше возникло условие, тем выше его приоритет. Если условия сортировки не указаны, порядок строк не определен. |
localizationSettings | Настройки локализации отчета. |
maxReportRows | Максимальное количество возвращаемых строк данных отчета. Если значение не задано, API возвращает максимально возможное количество строк, до 100 000. Допустимые значения: 1–100 000 включительно. Значения больше 100000 возвращают ошибку. |
timeZone | Часовой пояс отчета. Принимает значения имени IANA TZ, например «America/Los_Angeles». Если часовой пояс не определен, вступает в силу значение по умолчанию для учетной записи. Проверьте значение по умолчанию с помощью действия получения учетной записи. Предупреждение: «Америка/Лос-Анджелес» — единственное поддерживаемое значение на данный момент. |
Измерение
Размеры сетевого отчета. Измерения — это атрибуты данных, позволяющие разбить или уточнить количественные измерения (показатели) по определенным атрибутам, таким как формат объявления или платформа, на которой было просмотрено объявление.
Перечисления | |
---|---|
DIMENSION_UNSPECIFIED | Значение по умолчанию для неустановленного поля. Не используйте. |
DATE | Дата в формате ГГГГММДД (например, «20210701»). В запросах можно указать не более одного измерения времени. |
MONTH | Месяц в формате ГГГГММ (например, «202107»). В запросах можно указать не более одного измерения времени. |
WEEK | Дата первого дня недели в формате ГГГГММДД (например, «20210701»). В запросах можно указать не более одного измерения времени. |
AD_UNIT | Уникальный идентификатор рекламного блока (например, ca-app-pub-1234/1234). Если указано измерение AD_UNIT, то APP включается автоматически. |
APP | Уникальный идентификатор мобильного приложения (например, «ca-app-pub-1234~1234»). |
AD_TYPE | Тип объявления (например, «текст» или «изображение»), параметр показа объявления. Внимание! Параметр несовместим с показателями AD_REQUESTS , MATCH_RATE и IMPRESSION_RPM . |
COUNTRY | Код страны CLDR места, где происходят просмотры/клики по объявлению (например, «США» или «FR»). Это географическое измерение. |
FORMAT | Формат рекламного блока (например, «Баннер», «Нативный»), параметр показа рекламы. |
PLATFORM | Платформа мобильной ОС приложения (например, «Android» или «iOS»). |
MOBILE_OS_VERSION | Версия мобильной операционной системы, например «iOS 13.5.1». |
GMA_SDK_VERSION | Версия GMA SDK, например «iOS 7.62.0». |
APP_VERSION_NAME | Для Android имя версии приложения можно найти в поле versionName в PackageInfo. Для iOS имя версии приложения можно найти в CFBundleShortVersionString. |
SERVING_RESTRICTION | Режим ограничения показа рекламы (например, «Неперсонализированная реклама»). |
Метрика
Метрики сетевого отчета. Метрики — это количественные измерения, показывающие, как работает издательский бизнес. Они объединяются из отдельных рекламных событий и группируются по параметрам отчета. Значение метрики может быть целым или десятичным (без округления).
Перечисления | |
---|---|
METRIC_UNSPECIFIED | Значение по умолчанию для неустановленного поля. Не используйте. |
AD_REQUESTS | Количество запросов объявлений. Значение является целым числом. Внимание! Показатель несовместим с измерением AD_TYPE . |
CLICKS | Сколько раз пользователь нажимает на объявление. Значение является целым числом. |
ESTIMATED_EARNINGS | Ориентировочный доход издателя AdMob. Валютная единица (доллар США, евро или другая) показателей дохода определяется настройкой локализации валюты. Сумма указана в микронах. Например, 6,50 доллара США будут представлены как 6500000. |
IMPRESSIONS | Общее количество объявлений, показанных пользователям. Значение является целым числом. |
IMPRESSION_CTR | Соотношение кликов и показов. Значение представляет собой десятичное значение двойной точности (приблизительное). |
IMPRESSION_RPM | Ориентировочный доход за тысячу показов рекламы. Значение указано в микронах. Например, 1,03 доллара США будут представлены как 1030000. Это эквивалентно эффективной цене за тысячу показов в интерфейсе AdMob. Внимание! Показатель несовместим с измерением AD_TYPE . |
MATCHED_REQUESTS | Сколько раз объявления возвращались в ответ на запрос. Значение является целым числом. |
MATCH_RATE | Отношение совпадающих запросов объявлений к общему количеству запросов объявлений. Значение представляет собой десятичное значение двойной точности (приблизительное). Внимание! Показатель несовместим с измерением AD_TYPE . |
SHOW_RATE | Соотношение отображаемых объявлений и возвращаемых объявлений, определяемое как показы/сопоставленные запросы. Значение представляет собой десятичное значение двойной точности (приблизительное). |
Фильтр размеров
Описывает, какие строки отчета следует сопоставлять на основе значений их измерений.
JSON-представление |
---|
{ "dimension": enum ( |
Поля | |
---|---|
dimension | Применяет критерий фильтра к указанному измерению. |
Полевой operator Союза. Оператор фильтра, который необходимо применить. operator может быть только одним из следующих: | |
matchesAny | Соответствует строке, если ее значение для указанного измерения находится в одном из значений, указанных в этом условии. |
Условие сортировки
Направление сортировки, применяемое к измерению или показателю.
JSON-представление |
---|
{ "order": enum ( |
Поля | |
---|---|
order | Порядок сортировки параметра или показателя. |
Поле объединения sort_on . Определяет, по каким значениям производить сортировку. sort_on может быть только одним из следующих: | |
dimension | Сортировка по указанному размеру. |
metric | Сортировка по указанному показателю. |