File Coverage

lib/Google/Ads/AdWords/v201710/SearchParameter.pm
Criterion Covered Total %
statement 12 14 85.7
branch n/a
condition n/a
subroutine 4 6 66.6
pod n/a
total 16 20 80.0


line stmt bran cond sub pod time code
1             package Google::Ads::AdWords::v201710::SearchParameter;
2 2     2   2007 use strict;
  2         7  
  2         71  
3 2     2   12 use warnings;
  2         6  
  2         189  
4              
5              
6             __PACKAGE__->_set_element_form_qualified(1);
7              
8 0     0     sub get_xmlns { 'https://adwords.google.com/api/adwords/o/v201710' };
9              
10             our $XML_ATTRIBUTE_CLASS;
11             undef $XML_ATTRIBUTE_CLASS;
12              
13             sub __get_attr_class {
14 0     0     return $XML_ATTRIBUTE_CLASS;
15             }
16              
17 2     2   17 use Class::Std::Fast::Storable constructor => 'none';
  2         6  
  2         19  
18 2     2   306 use base qw(Google::Ads::SOAP::Typelib::ComplexType);
  2         5  
  2         334  
19              
20             { # BLOCK to scope variables
21              
22             my %SearchParameter__Type_of :ATTR(:get);
23              
24             __PACKAGE__->_factory(
25             [ qw( SearchParameter__Type
26              
27             ) ],
28             {
29             'SearchParameter__Type' => \%SearchParameter__Type_of,
30             },
31             {
32             'SearchParameter__Type' => 'SOAP::WSDL::XSD::Typelib::Builtin::string',
33             },
34             {
35              
36             'SearchParameter__Type' => 'SearchParameter.Type',
37             }
38             );
39              
40             } # end BLOCK
41              
42              
43              
44              
45              
46              
47              
48             1;
49              
50              
51             =pod
52              
53             =head1 NAME
54              
55             Google::Ads::AdWords::v201710::SearchParameter
56              
57             =head1 DESCRIPTION
58              
59             Perl data type class for the XML Schema defined complexType
60             SearchParameter from the namespace https://adwords.google.com/api/adwords/o/v201710.
61              
62             A set of {@link SearchParameter}s is supplied to the {@link TargetingIdeaSelector} to specify how the user wants to filter the set of all possible {@link TargetingIdea}s.

There is a {@link SearchParameter} for each type of input. {@link SearchParameter}s can conceptually be broken down into two types.

  • Input {@link SearchParameter}s provide the seed information from which ideas or stats are to be generated (e.g., {@link RelatedToQuerySearchParameter}, {@link RelatedToUrlSearchParameter}, etc.). This type of {@link SearchParameters} is required in requests.
  • Filter {@link SearchParameter}s (e.g., {@link CompetitionSearchParameter}, etc.) are used to trim down the results based on {@link Attribute}-related information.

A request should only contain one instance of each {@link SearchParameter}. Requests containing multiple instances of the same search parameter will be rejected.

One or more of the following {@link SearchParameter}s are required:

  • {@link CategoryProductsAndServicesSearchParameter}
  • {@link LocationSearchParameter}
  • {@link RelatedToQuerySearchParameter}
  • {@link RelatedToUrlSearchParameter}
  • {@link SeedAdGroupIdSearchParameter}

{@link IdeaType} KEYWORD supports following {@link SearchParameter}s:

  • {@link CategoryProductsAndServicesSearchParameter}
  • {@link CompetitionSearchParameter}
  • {@link IdeaTextFilterSearchParameter}
  • {@link IncludeAdultContentSearchParameter}
  • {@link LanguageSearchParameter}
  • {@link LocationSearchParameter}
  • {@link NetworkSearchParameter}
  • {@link RelatedToQuerySearchParameter}
  • {@link RelatedToUrlSearchParameter}
  • {@link SearchVolumeSearchParameter}
  • {@link SeedAdGroupIdSearchParameter}
63              
64              
65              
66              
67             =head2 PROPERTIES
68              
69             The following properties may be accessed using get_PROPERTY / set_PROPERTY
70             methods:
71              
72             =over
73              
74             =item * SearchParameter__Type
75              
76             Note: The name of this property has been altered, because it didn't match
77             perl's notion of variable/subroutine names. The altered name is used in
78             perl code only, XML output uses the original name:
79              
80             SearchParameter.Type
81              
82              
83              
84              
85             =back
86              
87              
88             =head1 METHODS
89              
90             =head2 new
91              
92             Constructor. The following data structure may be passed to new():
93              
94              
95              
96              
97              
98              
99             =head1 AUTHOR
100              
101             Generated by SOAP::WSDL
102              
103             =cut
104