报告

通过报告,您可以检索有关已关联账号的广告效果和潜在客户信息。

账户报告

账号报告会显示与经理账号的关联本地服务账号相关联的效果和指标。您可以查看指定时间段内的这些数据。数据可能最多延迟 30 分钟。

如需获取报告,请向 https://localservices.googleapis.com/v1/accountReports:search 发送 HTTP GET 请求,并使用以下可配置的网址参数:

网址参数
query

必需

包含一个或多个 ID 值,其中一个必须是查询所针对的经理账号的 ID。query 可接受多个以半角分号分隔的值:

  • 必需: manager_customer_id:<manager_cid>
  • 可选:customer_id:<linked_cid>。

示例: query=manager_customer_id:123;customer_id:456

startDate.day

可选

报告期的开始日期。可以取介于 1 和 31 之间(含边界值)的值。默认值为 1。

startDate.month

可选

报告期的起始月份。可以取介于 1 和 12 之间(含边界值)的值。默认为当月。

startDate.year

可选

报告期开始年份,格式为 YYYY。默认为当前年份。

endDate.day

可选

报告期结束的日期。可以取介于 1 和 31 之间(含边界值)的值。默认为当天。

endDate.month

可选

报告期结束的月份。可以取介于 1 和 12 之间(含边界值)的值。默认为当月。

endDate.year

可选

报告期结束年份,格式为 YYYY。 默认为当前年份。

pageSize

可选

一个正整数,表示要返回的条目数。 默认值为 1000,最大值为 10000。

pageToken

可选

字符串。在此字段中输入上一个响应中的 next_page_token。

上表中的字段用于构建 SearchAccountReportsRequest。对于请求中的每个客户 ID,SearchAccountReportsResponse 中都会包含相应的 AccountReports。 每个账号报告都与一个展示本地服务广告的关联客户账号一一对应。

下表显示了 AccountReports 中的字段:

字段
accountId 与本地生活服务账号相关联的客户 ID。
businessName 客户的商家名称。
averageWeeklyBudget 客户当前的平均每周预算。
averageFiveStarRating 平均五星级评分,根据客户的所有可用评价计算得出。
totalReview 客户可查看的评价总数。
impressionsLastTwoDays 相应账号在过去两天内获得的展示次数总和。
phoneLeadResponsiveness 相应账号在过去 90 天内的电话潜在客户响应情况。 计算方法为:将付费电话潜在客户带来的已接通电话总数除以收到的电话总数。
currentPeriodChargedLeads 指定日期范围内的付费潜在客户数量。
previousPeriodChargedLeads 上个周期内已付费的潜在客户数量。例如,如果日期范围设置为 1 月 21 日至 1 月 30 日,则上一个周期为 1 月 11 日至 1 月 20 日。
currentPeriodTotalCost 指定日期范围内的付费潜在客户所产生的费用总和。
previousPeriodTotalCost 上个周期内已收费潜在客户的费用总和。例如,如果将日期范围设置为 1 月 21 日至 1 月 30 日,则上一个周期为 1 月 11 日至 1 月 20 日。
currencyCode 客户账号的币种代码。
currentPeriodPhoneCalls 指定日期范围内的电话通话次数,包括已接通和未接通的通话。
previousPeriodPhoneCalls 上个时间段内的通话次数,包括已接通和未接通的通话。
currentPeriodConnectedPhoneCalls 指定日期范围内的已接通电话(时长超过 30 秒)的数量。
previousPeriodConnectedPhoneCalls 上一个时间段内时长超过 30 秒的已接通电话的数量。

示例

HTTP 请求网址

https://localservices.googleapis.com/v1/accountReports:search?query=manager_customer_id:{manager_customer_id}

完整的 HTTP 请求示例

GET /v1/accountReports:search?query=manager_customer_id:{manager_customer_id} HTTP/1.1
Host: localservices.googleapis.com
User-Agent: curl
Content-Type: application/json
Accept: application/json
Authorization: Bearer [Enter OAuth 2.0 access token here]

详细的潜在客户报告

详细潜在客户报告可深入了解与经理账号的关联本地生活服务账号相关的潜在客户。您可以查看指定时间段内的这些数据。对于给定的时间范围,报告中会包含已创建的潜在客户或争议状态已更新的潜在客户。数据可能最多延迟 30 分钟。

如需获取报告,请向 https://localservices.googleapis.com/v1/detailedLeadReports:search 发送 HTTP GET 请求,并使用以下可配置的网址参数:

网址参数
query

必需

包含一个或多个 ID 值,其中一个必须是查询所针对的经理账号的 ID。query 可接受多个以半角分号分隔的值:

  • 必需: manager_customer_id:<manager_cid>
  • 可选:customer_id:<linked_cid>。

示例: query=manager_customer_id:123;customer_id:456

startDate.day

可选

报告期的开始日期。可以取介于 1 和 31 之间(含边界值)的值。默认值为 1。

startDate.month

可选

报告期的起始月份。可以取介于 1 和 12 之间(含边界值)的值。默认为当月。

startDate.year

可选

报告期开始年份,格式为 YYYY。默认为当前年份。

endDate.day

可选

报告期结束的日期。可以取介于 1 和 31 之间(含边界值)的值。默认为当天。

endDate.month

可选

报告期结束的月份。可以取介于 1 和 12 之间(含边界值)的值。默认为当月。

endDate.year

可选

报告期结束年份,格式为 YYYY。 默认为当前年份。

pageSize

可选

一个正整数,表示要返回的条目数。 默认值为 1000,最大值为 10000。

pageToken

可选

字符串。在此字段中输入上一个响应中的 next_page_token。

上述字段用于构造 SearchDetailedLeadReportsRequest。对于请求中的每个客户 ID,SearchDetailedLeadReportsResponse 中都会包含相应的 DetailedLeadReports。每份“详细潜在客户报告”都与一个特定潜在客户一一对应,该潜在客户与展示本地生活服务广告的关联客户账号相关联。

下表显示了 DetailedLeadReports 中的字段:

字段
leadId 潜在客户的唯一标识符。
accountId 标识接收潜在客户的账号。
businessName 与账号关联的商家名称。
leadCreationTimestamp

潜在客户的创建时间戳。包括 M/D/YYYY 格式的日期和 HH:MM:SS 格式的时间。

示例:11/1/2019 12:13:20

leadType 潜在客户的类型:MESSAGE 或 PHONE_CALL。
leadCategory

与潜在客户关联的服务类别。

示例:housecleaner

geo

关联账号的居住城市的位置。

示例:San Francisco, California, United States

messageLead 仅与消息潜在客户相关联的信息:customerName、jobType、postalCode 和 consumerPhoneNumber。
phoneLead 仅与电话潜在客户相关联的信息: chargedCallTimestamp、 chargedConnectedCallDurationSeconds 和 consumerPhoneNumber。
bookingLead 仅与预订潜在客户相关联的信息: customerName、 consumerPhoneNumber、 jobType、 consumerEmail 和 bookingAppointmentTimestamp。
chargeStatus 相应潜在客户信息是否已计费。可以是 true 或 false。
currencyCode 相应潜在客户所针对的账号的币种代码。
disputeStatus 相应潜在客户的异议状态。
aggregatorInfo

特定于第三方汇总平台合作伙伴的信息。此字段仅针对与第三方汇总平台合作伙伴相关联的 API 客户端填充。

timezone 与潜在客户关联的账号的时区。以 IANA 时区数据库格式提供。

示例

HTTP 请求网址

https://localservices.googleapis.com/v1/detailedLeadReports:search?query=manager_customer_id:{manager_customer_id}

完整的 HTTP 请求示例

GET /v1/detailedReports:search?query=manager_customer_id:{manager_customer_id} HTTP/1.1
Host: localservices.googleapis.com
User-Agent: curl
Content-Type: application/json
Accept: application/json
Authorization: Bearer [Enter OAuth 2.0 access token here]