Abstract Class awSearchParameter

Description

A set of SearchParameters are supplied to the com.google.ads.api.services.targetingideas.TargetingIdeaSelector to specify how the user wants to filter the set of all possible com.google.ads.api.services.targetingideas.TargetingIdeas.

There is a SearchParameter for all types of inputs. SearchParameters can conceptually be broken down into two types.

  • Input SearchParameters provide the seed information from which ideas should be generated or statistic information is desired (eg. RelatedToKeywordSearchParameter, RelatedToUrlSearchParameter, etc). Such SearchParameters are required for valid requests.
  • Filter SearchParameters are used to trim down the results based on com.google.ads.api.services.targetingideas.attributes.Attribute related information (eg. CompetitionSearchParameter, etc.).
<p> A request should only contain one instance of each SearchParameter <p>One or more of the following SearchParameters are required:
  • KeywordCategoryIdSearchParameter
  • CategoryProductsAndServicesSearchParameter
  • RelatedToKeywordSearchParameter
  • RelatedToUrlSearchParameter
  • SeedAdGroupIdSearchParameter
<p> IdeaType KEYWORD supports following SearchParameters:
  • AdShareSearchParameter
  • AverageTargetedMonthlySearchesSearchParameter
  • CompetitionSearchParameter
  • DeviceTypeSearchParameter
  • ExcludedKeywordSearchParameter
  • GlobalMonthlySearchesSearchParameter
  • IdeaTextFilterSearchParameter
  • IdeaTextMatchesSearchParameter
  • IncludeAdultContentSearchParameter
  • KeywordCategoryIdSearchParameter
  • CategoryProductsAndServicesSearchParameter
  • KeywordMatchTypeSearchParameter
  • LanguageSearchParameter
  • MobileSearchParameter
  • NgramGroupsSearchParameter
  • RelatedToKeywordSearchParameter
  • RelatedToUrlSearchParameter
  • SearchShareSearchParameter
  • SeedAdGroupIdSearchParameter
<p> IdeaType PLACEMENT supports following SearchParameters:
  • AdTypeSearchParameter
  • DeviceTypeSearchParameter
  • LanguageSearchParameter
  • MobileSearchParameter
  • PlacementTypeSearchParameter
  • RelatedToKeywordSearchParameter
  • RelatedToUrlSearchParameter
<p>

Located in /classes/o/SearchParameter.php

awComplexObject
   |
   --awSearchParameter
Direct descendents
Class Description
 class awSeedAdGroupIdSearchParameter A SearchParameter for {@code KEYWORD} IdeaTypes that specifies that the supplied AdGroup should be used as a seed for generating new ideas. For example, an AdGroup's keywords would be used to generate new and related keywords.
 class awLocationSearchParameter A SearchParameter for both {@code PLACEMENT} and {@code KEYWORD} IdeaTypes used to indicate the locations being targeted. This can be used, for example, to search for {@code KEYWORD} IdeaTypes that are best for Japan and Los Angeles.
 class awRelatedToUrlSearchParameter A SearchParameter for {@code KEYWORD} and {@code PLACEMENT} IdeaTypes that specifies a set of URLs that results should in some way be related too. For example, keyword results would be similar to content keywords found on the related URLs.
 class awCategoryProductsAndServicesSearchParameter A SearchParameter for {@code KEYWORD} IdeaTypes that sets a keyword category that all search results should belong to.
 class awSearchShareSearchParameter A SearchParameter that specifies the percentage of search share
 class awAdShareSearchParameter A SearchParameter that specifies the percentage of ad share expected
 class awPlacementTypeSearchParameter A SearchParameter for {@code PLACEMENT} IdeaTypes
 class awRelatedToKeywordSearchParameter A SearchParameter for {@code KEYWORD} and {@code PLACEMENT} IdeaTypes that specifies a generic keyword that results should be related to.
 class awLanguageSearchParameter A SearchParameter for both {@code PLACEMENT} and {@code KEYWORD} IdeaTypes used to indicate the languages being targeted. This can be used, for example, to search for {@code KEYWORD} IdeaTypes that are best for Japanese and Korean languages.
 class awAdTypeSearchParameter A SearchParameter for {@code PLACEMENT} IdeaTypes used to filter the results by the AdType.
 class awAverageTargetedMonthlySearchesSearchParameter A SearchParameter that constrains the approximate average number of
 class awGlobalMonthlySearchesSearchParameter A SearchParameter that specifies the level of search volume expected
 class awDeviceTypeSearchParameter A SearchParameter for choosing which device types to get ideas and statistics for.
 class awExcludedKeywordSearchParameter A SearchParameter for {@code KEYWORD} IdeaTypes that
 class awCompetitionSearchParameter A SearchParameter for {@code KEYWORD} IdeaTypes used to filter the results by the amount of competition (eg: LOW, MEDIUM, HIGH).
 class awIncludeAdultContentSearchParameter SearchParameter that specifies whether adult content should be returned. Presence of this SearchParameter will allow adult keywords to be included in the results.
 class awIdeaTextFilterSearchParameter A SearchParameter for {@code KEYWORD} IdeaTypes that specifies a collection of strings by which the results should be constrained. This guarantees that each idea in the result will match at least one of the {@code included} values.
 class awKeywordMatchTypeSearchParameter A SearchParameter for {@code KEYWORD} IdeaTypes that specifies the KeywordMatchTypes that all results must match.
Method Summary
 void factory ( $row,  $className)
Variables
Methods

Documentation generated on Fri, 23 Mar 2012 13:44:11 +0200 by phpDocumentor 1.4.3