背景
Google API客户端库是从Google Discovery服务生成的。PHP客户端库为资源的每个属性生成了setProperty
和getProperty
。
分析报告API V4
分析报告API V4参考文档详细描述了该API。开发人员指南提供了客户端库将生成的底层JSON示例:
POST https:
{
"reportRequests":
[
{
"viewId": "XXXX",
"dateRanges": [
{"endDate": "2014-11-30", "startDate": "2014-11-01"}
],
"metrics": [
{"expression": "ga:pageviews"},
{"expression": "ga:sessions"}
],
"dimensions": [{"name": "ga:browser"}, {"name": "ga:country"}],
"dimensionFilterClauses": [
{
"filters": [
{
"dimensionName": "ga:browser",
"operator": "EXACT",
"expressions": ["Chrome"]
}
]
}
]
}
]
}
这个示例页面展示了Python、Java、PHP和JavaScript的很多请求示例,这些示例应该可以让你很好地了解如何使用各个客户端库。但是你说得没错,没有一个明确的PHP使用过滤器的示例。
PHP过滤器示例
下面是与上述请求相同的示例:
// Create the DateRange object.
$dateRange = new Google_Service_AnalyticsReporting_DateRange();
$dateRange->setStartDate("2014-11-01");
$dateRange->setEndDate("2014-11-30");
// Create the Metrics object.
$pageviews = new Google_Service_AnalyticsReporting_Metric();
$pageviews->setExpression("ga:pageviews");
$sessions = new Google_Service_AnalyticsReporting_Metric();
$sessions->setExpression("ga:sessions");
//Create the Dimensions object.
$browser = new Google_Service_AnalyticsReporting_Dimension();
$browser->setName("ga:browser");
$country = new Google_Service_AnalyticsReporting_Dimension();
$country->setName("ga:country");
// Create the DimensionFilter.
$dimensionFilter = new Google_Service_AnalyticsReporting_DimensionFilter();
$dimensionFilter->setDimensionName('ga:browser');
$dimensionFilter->setOperator('EXACT');
$dimensionFilter->setExpressions(array('Chrome'));
// Create the DimensionFilterClauses
$dimensionFilterClause = new Google_Service_AnalyticsReporting_DimensionFilterClause();
$dimensionFilterClause->setFilters(array($dimensionFilter));
// Create the ReportRequest object.
$request = new Google_Service_AnalyticsReporting_ReportRequest();
$request->setViewId("XXXX");
$request->setDateRanges($dateRange);
$request->setDimensions(array($browser, $country));
$request->setDimensionFilterClauses(array($dimensionFilterClause));
$request->setMetrics(array($pageviews, $sessions));
$body = new Google_Service_AnalyticsReporting_GetReportsRequest();
$body->setReportRequests( array( $request) );
return $analyticsreporting->reports->batchGet( $body );
作为您可能已经注意到的,我从未使用过
$object->getProperty()
。基本上它只会给我它当前的值。当调用API时,您只需要
$object->setProperty($value);
。这就是为什么我向您介绍了客户端库是如何生成的背景。
结论
Analytics Reporting API本身很复杂,并且有许多客户端库语言。不总是可能在每种可能的客户端库语言中提供API的每种可能的用法示例。这就是为什么有必要了解如何查看参考文档并理解客户端库是如何从描述的结构中生成的原因。