File Coverage

blib/lib/Google/Ads/AdWords/Reports/ReportingConfiguration.pm
Criterion Covered Total %
statement 21 23 91.3
branch n/a
condition 0 10 0.0
subroutine 7 7 100.0
pod n/a
total 28 40 70.0


line stmt bran cond sub pod time code
1             # Copyright 2014, Google Inc. All Rights Reserved.
2             #
3             # Licensed under the Apache License, Version 2.0 (the "License");
4             # you may not use this file except in compliance with the License.
5             # You may obtain a copy of the License at
6             #
7             # http://www.apache.org/licenses/LICENSE-2.0
8             #
9             # Unless required by applicable law or agreed to in writing, software
10             # distributed under the License is distributed on an "AS IS" BASIS,
11             # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12             # See the License for the specific language governing permissions and
13             # limitations under the License.
14              
15             package Google::Ads::AdWords::Reports::ReportingConfiguration;
16              
17 2     2   156264 use strict;
  2         6  
  2         67  
18 2     2   12 use warnings;
  2         4  
  2         71  
19 2     2   14 use utf8;
  2         8  
  2         22  
20 2     2   56 use version;
  2         5  
  2         15  
21              
22             # The following needs to be on one line because CPAN uses a particularly hacky
23             # eval() to determine module versions.
24 2     2   168 use Google::Ads::AdWords::Constants; our $VERSION = ${Google::Ads::AdWords::Constants::VERSION};
  2         7  
  2         113  
25              
26 2     2   11 use Class::Std::Fast;
  2         3  
  2         19  
27              
28             my %skip_header_of : ATTR(:name :default<>);
29             my %skip_column_header_of : ATTR(:name :default<>);
30             my %skip_summary_of : ATTR(:name :default<>);
31             my %include_zero_impressions_of :
32             ATTR(:name :default<>);
33             my %use_raw_enum_values_of : ATTR(:name :default<>);
34              
35             sub as_string : STRINGIFY {
36 0           my ($self, $ident) = @_;
37 0   0       return sprintf(
      0        
      0        
      0        
      0        
38             "ReportingConfiguration {\n skip_header: %s\n" .
39             " skip_column_header: %s\n" . " skip_summary: %s\n" .
40             " include_zero_impressions: %s\n use raw enum values: %s\n}",
41             $self->get_skip_header() || "",
42             $self->get_skip_column_header() || "",
43             $self->get_skip_summary() || "",
44             $self->get_include_zero_impressions() || "",
45             $self->get_use_raw_enum_values() || ""
46             );
47 2     2   525 }
  2         6  
  2         16  
48              
49             1;
50              
51             =pod
52              
53             =head1 NAME
54              
55             Google::Ads::AdWords::Reports::ReportingConfiguration
56              
57             =head1 DESCRIPTION
58              
59             Represents additional reporting configuration options.
60              
61              
62             =head2 PROPERTIES
63              
64             The following properties may be accessed using get_PROPERTY / set_PROPERTY
65             methods:
66              
67             =over
68              
69             =item * skip_header
70              
71             Set this to true to request that report output excludes the report header
72             row containing the report name and date range.
73              
74             =item * skip_column_header
75              
76             Set this to true to request that the report output excludes the row
77             containing column names.
78              
79             =item * skip_summary
80              
81             Set this to true to request that report output excludes the report summary
82             row containing totals.
83              
84             =item * include_zero_impressions
85              
86             Set this to true to request that report output includes data with zero
87             impressions.
88              
89             =item * use_raw_enum_values
90              
91             Set this to true to request that report output return enum field values as
92             enum values instead of display values.
93              
94             =back
95              
96              
97             =head1 METHODS
98              
99             =head2 new
100              
101             Constructor. The following data structure may be passed to new():
102              
103             { # Google::Ads::AdWords::Reports::ReportingConfiguration
104             skip_header => $some_value, # boolean
105             skip_column_header => $some_value, #boolean
106             skip_summary => $some_value, # boolean
107             include_zero_impressions => $some_value, # boolean
108             use_raw_enum_values => $some_value, # boolean
109             },
110              
111             =cut
112