| 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 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 18 | 2 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 19 | 2 | ▶ | use utf8; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 20 | 2 | ▶ | use version; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 21 | |||
| 22 | # The following needs to be on one line because CPAN uses a particularly hacky | ||
| 23 | # eval() to determine module versions. | ||
| 24 | 2 | ▶ | use Google::Ads::AdWords::Constants; our $VERSION = ${Google::Ads::AdWords::Constants::VERSION}; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 25 | |||
| 26 | 2 | ▶ | use Class::Std::Fast; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 27 | |||
| 28 | 1 | my %skip_header_of : ATTR(:name<skip_header> :default<>); | |
| 29 | 2 | my %skip_column_header_of : ATTR(:name<skip_column_header> :default<>); | |
| 30 | 2 | my %skip_summary_of : ATTR(:name<skip_summary> :default<>); | |
| 31 | 2 | my %include_zero_impressions_of : | |
| 32 | ATTR(:name<include_zero_impressions> :default<>); | ||
| 33 | 2 | my %use_raw_enum_values_of : ATTR(:name<use_raw_enum_values> :default<>); | |
| 34 | |||
| 35 | sub as_string : STRINGIFY { | ||
| 36 | my ($self, $ident) = @_; | ||
| 37 | return sprintf( | ||
| 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() || "<undef>", | ||
| 42 | $self->get_skip_column_header() || "<undef>", | ||
| 43 | $self->get_skip_summary() || "<undef>", | ||
| 44 | $self->get_include_zero_impressions() || "<undef>", | ||
| 45 | $self->get_use_raw_enum_values() || "<undef>" | ||
| 46 | ); | ||
| 47 | 2 | ▶ | } |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 48 | |||
| 49 | 2 | 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 | |||