跟踪点击

返回特定日期范围内跟踪点击和展示的数据。

请求格式

获取 https://api.appmetrica.yandex.com/logs/v1/export/clicks.{csv | json}
  ? application_id=<int>
  & date_since=<string>
  & date_until=<string>
  & fields=<string>
  & [date_dimension=<string>]
  & [limit=<int>]
  & [use_utf8_bom=<bool>]
  & [<any field name>=<string>]
  & [skip_unavailable_shards=<bool>]

应用ID*

按应用在 AppMetrica 中的数字 ID 过滤。

date_since*

日期范围的开始,格式为 yyyy-mm-dd hh:mm:ss。 您还可以定义影响 date_dimension 查询参数中数据的日期和时间类型。

date_until*

日期范围的结束,格式为 yyyy-mm-dd hh:mm:ss。 您还可以定义影响 date_dimension 查询参数中数据的日期和时间类型。

字段*

用逗号分隔的字段列表用于示例。

一个包含所有可用字段的列表(便于快速复制):

application_id,click_datetime,click_id,click_ipv6,click_timestamp,click_url_parameters,click_user_agent,publisher_id,publisher_name,tracker_name,tracking_id,touch_type,is_bot,city,country_iso_code,device_manufacturer,device_model,device_type,google_aid,oaid,ios_ifa,ios_ifv,os_name,os_version,windows_aid

date_dimension

此参数定义计算日期范围的起点:

  • default:事件在设备上发生时。
  • receive:服务器收到事件信息时。

限制

列表中项目数量的限制。 默认取最大值。 不保证请求之间的结果一致(结果排序可能存在差异)。

使用 UTF-8 BOM

启用字节顺序标记使用的参数。 默认值为 false。

<any field name>

按可用字段之一的值过滤。 仅支持相等检查操作。

跳过不可用的分片

用于提高数据可用性。 默认值为 false。

响应格式

如果请求了所有可用的字段:

{
  "data": [
    {
      "application_id": "integer",
      "touch_type": "string",
      "click_datetime": "string",
      "click_id": "string",
      "click_ipv6": "string",
      "click_timestamp": "integer",
      "click_url_parameters": "string",
      "click_user_agent": "string",
      "publisher_id": "integer",
      "publisher_name": "string",
      "tracker_name": "string",
      "tracking_id": "integer",
      "city": "string",
      "country_iso_code": "string",
      "device_type": "string",
      "device_model": "string",
      "device_manufacturer": "string",
      "os_version": "string",
      "os_name": "string",
      "windows_aid": "string",
      "google_aid": "string",
      "oaid": "string",
      "ios_ifv": "string",
      "ios_ifa": "string",
      "is_bot": "boolean"
    },
    ...
  ]
}
应用程序ID,ios_ifa,操作系统名称,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,iOS,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,iOS,...
1111,,Android
...

application_id

应用在 AppMetrica 中的唯一数字标识符。

touch_type

类型:点击或展示。 可能的值:click | impression | unknown。

点击日期时间

点击/展示的日期和时间,格式为 yyyy-mm-dd hh:mm:ss。

click_id

点击/展示的 ID 或 ''(如果 ID 不可用则为空字符串)。

点击 IPv6

点击/展示时的 IP 地址,格式为 IPv6。 例如:2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147。

click_timestamp

点击/展示的时间,格式为 Unix time,以秒为单位。

点击URL参数

参数在 URL 中的显示方式。 特殊字符必须转义(例如,?param1=1&param2=2... 在请求中会显示为 ?param1%3D1%26param2%3D2...)。

点击用户代理

点击/展示的用户代理。

publisher_id

AppMetrica 发布者的 ID。

出版商名称

AppMetrica 合作伙伴的名称。

tracker_name

添加到 AppMetrica 界面的跟踪器名称。

tracking_id

AppMetrica 跟踪器的 ID。

城市

城市名称(英文)。

country_iso_code

ISO 国家代码。

设备制造商

AppMetrica 服务检测到的设备制造商(例如,Apple 或 Samsung)。

设备模型

AppMetrica 服务检测到的设备型号(例如,Galaxy S6)。

device_type

AppMetrica 服务检测到的设备类型。 可能的值:phone | tablet | unknown。

google_aid

设备的 Google AID,格式为从设备接收的格式。

oaid

设备的华为 OAID,格式为从设备接收的格式。

ios_ifa

设备的 IFA,格式为从设备接收的格式。

ios_ifv

应用的 IFV,格式为从设备接收的格式。

os_name

用户设备上的操作系统:ios | android | windows。

os_version

用户设备上的操作系统版本。

windows_aid

设备的 Windows AID,格式为从设备接收的格式。

is_bot

指示非浏览器点击。

Example

请求:

curl -X GET \
  'https://api.appmetrica.yandex.com/logs/v1/export/clicks.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=application_id,touch_type,click_datetime,click_id,click_ipv6,click_timestamp,click_url_parameters,click_user_agent,publisher_id,publisher_name,tracker_name,tracking_id,city,country_iso_code,device_type,device_model,device_manufacturer,os_version,os_name,windows_aid,google_aid,oaid,ios_ifv,ios_ifa,is_bot' \
  -H 'Authorization: OAuth oauth_token'

响应:

{
  "data": [
    {
      "application_id": "1111",
      "touch_type": "click",
      "click_datetime": "yyyy-mm-dd hh:mm:ss",
      "click_id": "f2ae4254de8844dda58b29cac2cf0e87",
      "click_ipv6": "::ffff:5.255.232.147",
      "click_timestamp": "1556258660",
      "click_timestamp": "1556258660",
      "click_url_parameters": "click_id=f2ae4254de8844dda58b29cac2cf0e87&c=1234&google_aid=&google_aid_sha1=&google_aid_md5=&ios_ifa=&ios_ifa_sha1=&ios_ifa_md5&click_timestamp=1554824136&afpub_id=&site_id=&creative_id=&goal_id1=&goal_id2 ",
      "click_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 12_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1 Mobile/15E148 Safari/604.1",
      "publisher_id": "39",
      "publisher_name": "AdColony",
      "tracker_name": "Advertising iOS campaign",
      "tracking_id": "12345678901234567890",
      "city": "Moscow",
      "country_iso_code": "RU",
      "device_type": "phone",
      "device_model": "iPhone X",
      "device_manufacturer": "Apple",
      "os_version": "12.2",
      "os_name": "ios",
      "windows_aid": "",
      "google_aid": "",
      "oaid": "",
      "ios_ifv": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "ios_ifa": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "is_bot": "false"
    }
  ]
}

如果您没有找到所需答案,可以通过反馈表单提交您的问题。 请尽可能详细地描述问题。 如果可能,请附上截图。

联系支持 为文档提出改进建议
上一篇
下一篇