Blame view

app/library/App/Resources/GaResource.php 3.04 KB
b38ef228   Alex Savenko   generate GaResource
1
2
3
4
5
6
7
8
9
10
11
12
13
  <?php
  /**
   * Created by PhpStorm.
   * User: Alex Savenko
   * Date: 09.02.2017
   * Time: 18:02
   */
  
  namespace App\Resources;
  
  
  use App\Constants\AclRoles;
  use App\Controllers\GaController;
8104a88d   Alex Savenko   extended classes
14
15
  use PhalconRest\Api\ApiEndpoint;
  use PhalconRest\Api\ApiResource;
b38ef228   Alex Savenko   generate GaResource
16
  
8104a88d   Alex Savenko   extended classes
17
  class GaResource extends ApiResource   {
b38ef228   Alex Savenko   generate GaResource
18
19
20
21
22
  
      public function initialize() {
  
          $this
              ->name('Google Analytics')
b38ef228   Alex Savenko   generate GaResource
23
              ->expectsJsonData()
b38ef228   Alex Savenko   generate GaResource
24
25
26
27
28
              ->itemKey('ga')
              ->collectionKey('ga')
              ->deny(AclRoles::UNAUTHORIZED)
              ->handler(GaController::class)
  
b05d4e78   Alex Savenko   docs
29
              ->endpoint(ApiEndpoint::factory('', 'GET', 'getAction')
b38ef228   Alex Savenko   generate GaResource
30
                  ->allow(AclRoles::USER)
fbd4cc5f   Alex Savenko   docs example requ...
31
                  ->description('Returns data from Google Analytics Api. https://developers.google.com/analytics/devguides/reporting/core/dimsmets')
e367fb50   Alex Savenko   dynamic dateRange
32
                  ->exampleResponse([
8c1ac2ba   Alex Savenko   ga output
33
34
35
36
37
38
39
40
                        "name"            => "rukzachok.com.ua",
                        "(Other)"         => "646",
                        "Direct"          => "482",
                        "Display"         => "134",
                        "Organic Search"  => "2278",
                        "Paid Search"     => "2989",
                        "Referral"        => "128",
                        "Social"          => "29"
e367fb50   Alex Savenko   dynamic dateRange
41
                  ])
ec2de8a1   Alex Savenko   docs
42
                  ->paramsDescription([
fbd4cc5f   Alex Savenko   docs example requ...
43
                      'get params' => [
ec2de8a1   Alex Savenko   docs
44
                          'required params' => [
0c1a07f0   Alex Savenko   add filter param ...
45
                              'metric'    => 'string(метрика Google, линк в описании запроса)',
ec2de8a1   Alex Savenko   docs
46
                              'dimension' => 'string(размерность Google, линк в описании запроса)',
0c1a07f0   Alex Savenko   add filter param ...
47
48
                              'start'     => 'ГГГГ-ММ-ДД/NdaysAgo, где N – целое положительное число(дата начала загрузки данных)',
                              'end'       => 'ГГГГ-ММ-ДД/NdaysAgo, где N – целое положительное число(дата конца загрузки данных)'
ec2de8a1   Alex Savenko   docs
49
50
                          ],
                          'optional params' => [
5de5ebae   Alex Savenko   фиксы по гуглу: м...
51
52
53
54
55
56
57
                              'user_id'       => 'integer(id пользователя в системе)',
                              'view_id'       => 'integer(id представления проэкта с гугл аналитики)',
                              'chart'         => 'boolean(Задает структуру возвращаемых данных(true для графиков))',
                              'filter'        => 'expression(https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters)',
                              'sort'          => 'string(параметр сортировки, metric либо dimension)',
                              'sort_type'     => 'enum(ans, desc)',
                              'max_result'    => 'integer(максимальное число строк в результате, по умолчанию 50,000)',
d34fce51   Alex Savenko   docs example requ...
58
                          ]
5de5ebae   Alex Savenko   фиксы по гуглу: м...
59
                      ]
46647ae2   Alex Savenko   docs example requ...
60
                  ])
b38ef228   Alex Savenko   generate GaResource
61
62
63
64
65
66
              )
          ;
  
      }
  
  }