Class: SearchParameter

Source Location: /AdWords/v201008/o/TargetingIdeaService.php

Class Overview

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.

Variables

$SearchParameterType

Methods

Child classes:

SearchShareSearchParameter: A SearchParameter that specifies the percentage of search share

SeedAdGroupIdSearchParameter: 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.

AdShareSearchParameter: A SearchParameter that specifies the percentage of ad share expected

AdTypeSearchParameter: A SearchParameter for {@code PLACEMENT} IdeaTypes used to filter the results by the AdType.

AverageTargetedMonthlySearchesSearchParameter: A SearchParameter that constrains the approximate average number of

CompetitionSearchParameter: A SearchParameter for {@code KEYWORD} IdeaTypes used to filter the results by the amount of competition (eg: LOW, MEDIUM, HIGH).

CountryTargetSearchParameter: A SearchParameter for both {@code PLACEMENT} and {@code KEYWORD}

ExcludedKeywordSearchParameter: A SearchParameter for {@code KEYWORD} IdeaTypes that specifies Keywords that should be excluded from the results.

GlobalMonthlySearchesSearchParameter: A SearchParameter that specifies the level of search volume expected

IdeaTextMatchesSearchParameter: 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.

IncludeAdultContentSearchParameter: SearchParameter that specifies whether adult content should be returned.

KeywordCategoryIdSearchParameter: A SearchParameter for {@code KEYWORD} IdeaTypes that sets a keyword category that all search results should belong to.

KeywordMatchTypeSearchParameter: A SearchParameter for {@code KEYWORD} IdeaTypes that specifies the KeywordMatchTypes that all results must match.

LanguageTargetSearchParameter: 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.

MobileSearchParameter: A SearchParameter that limits results to keywords and statistics for

PlacementTypeSearchParameter: A SearchParameter for {@code PLACEMENT} IdeaTypes

RelatedToKeywordSearchParameter: A SearchParameter for {@code KEYWORD} and {@code PLACEMENT} IdeaTypes that specifies a generic keyword that results should be related to.

RelatedToUrlSearchParameter: 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 Details

[line 4424]
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.).

A request should only contain one instance of each SearchParameter One or more of the following SearchParameters are required:

KeywordCategoryIdSearchParameter
CategoryProductsAndServicesSearchParameter
RelatedToKeywordSearchParameter
RelatedToUrlSearchParameter
SeedAdGroupIdSearchParameter

IdeaType KEYWORD supports following SearchParameters:

IdeaType PLACEMENT supports following SearchParameters:

[ Top ]

Class Variables

$SearchParameterType =

[line 4429]

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor __construct [line 4479]

SearchParameter __construct(
[
$SearchParameterType = NULL])

Parameters:

$SearchParameterType

[ Top ]

method getNamespace [line 4467]

the getNamespace(
)

Gets the namesapce of this class

Tags:

return:	namespace of this class
access:	public

Overridden in child classes as:

SearchShareSearchParameter::getNamespace(): Gets the namesapce of this class

SeedAdGroupIdSearchParameter::getNamespace(): Gets the namesapce of this class

AdShareSearchParameter::getNamespace(): Gets the namesapce of this class

AdTypeSearchParameter::getNamespace(): Gets the namesapce of this class

AverageTargetedMonthlySearchesSearchParameter::getNamespace(): Gets the namesapce of this class

CompetitionSearchParameter::getNamespace(): Gets the namesapce of this class

CountryTargetSearchParameter::getNamespace(): Gets the namesapce of this class

ExcludedKeywordSearchParameter::getNamespace(): Gets the namesapce of this class

GlobalMonthlySearchesSearchParameter::getNamespace(): Gets the namesapce of this class

IdeaTextMatchesSearchParameter::getNamespace(): Gets the namesapce of this class

IncludeAdultContentSearchParameter::getNamespace(): Gets the namesapce of this class

KeywordCategoryIdSearchParameter::getNamespace(): Gets the namesapce of this class

KeywordMatchTypeSearchParameter::getNamespace(): Gets the namesapce of this class

LanguageTargetSearchParameter::getNamespace(): Gets the namesapce of this class

MobileSearchParameter::getNamespace(): Gets the namesapce of this class

PlacementTypeSearchParameter::getNamespace(): Gets the namesapce of this class

RelatedToKeywordSearchParameter::getNamespace(): Gets the namesapce of this class

RelatedToUrlSearchParameter::getNamespace(): Gets the namesapce of this class

[ Top ]

method getParameterMap [line 4459]

array getParameterMap(
)

Provided for getting non-php-standard named variables

Tags:

return:	parameter map
access:	protected

[ Top ]

method getXsiTypeName [line 4475]

the getXsiTypeName(
)

Gets the xsi:type name of this class

Tags:

return:	xsi:type name of this class
access:	public

Overridden in child classes as:

SearchShareSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

SeedAdGroupIdSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

AdShareSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

AdTypeSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

AverageTargetedMonthlySearchesSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

CompetitionSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

CountryTargetSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

ExcludedKeywordSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

GlobalMonthlySearchesSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

IdeaTextMatchesSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

IncludeAdultContentSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

KeywordCategoryIdSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

KeywordMatchTypeSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

LanguageTargetSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

MobileSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

PlacementTypeSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

RelatedToKeywordSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

RelatedToUrlSearchParameter::getXsiTypeName(): Gets the xsi:type name of this class

[ Top ]

method __get [line 4447]

mixed __get(
$var
$var)

Provided for getting non-php-standard named variables

Tags:

return:	Variable value
access:	public

Parameters:

$var

$var

Variable name to get.

[ Top ]

method __set [line 4440]

void __set(
$var
$var, $value
$value)

Provided for setting non-php-standard named variables

Tags:

access:

public

Parameters:

$var	$var	Variable name to set
$value	$value	Value to set

[ Top ]

Documentation generated by phpDocumentor 1.4.3