从Google Analytics报告API过滤结果

9
我使用PHP客户端库成功地从Google Analytics的报告API(版本4)下载结果。但是,我还没有弄清楚如何正确地过滤这些结果。
我知道可以通过cURL实现,但是在客户端库中却不行。我查看了客户端库代码,并找到了一个类方法:
apiclient-services/Google/Service/AnalyticsReporting/ReportRequest.php:
public function setMetricFilterClauses($metricFilterClauses)

我没有看到任何文档或使用相关的get方法:

public function getMetricFilterClauses()

有没有通过PHP客户端库使用过滤器的示例?

2个回答

33

背景

Google API客户端库是从Google Discovery服务生成的。PHP客户端库为资源的每个属性生成了setPropertygetProperty

分析报告API V4

分析报告API V4参考文档详细描述了该API。开发人员指南提供了客户端库将生成的底层JSON示例:

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet
{
  "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的每种可能的用法示例。这就是为什么有必要了解如何查看参考文档并理解客户端库是如何从描述的结构中生成的原因。


7
如果有人想知道Google_Service_AnalyticsReporting_DimensionFilterClause中'EXACT'字符串的含义,以下是可能的选项列表:https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/reports/batchGet#Operator我花了很长时间才找到这个信息。 - priki
非常感谢您提供的URL @DenisUyeda。确实很难找到! - xav

-1

在上面的脚本中DimensionFilter()类存在问题,我收到错误报告说它未被定义。但是我将其更改为Google_Service_AnalyticsReporting_DimensionFilter()类,现在它正在正常运行,希望这能对其他人有所帮助。


2
你应该使用注释来注释答案。 - sglessard

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接