PHP Class SearchParameter, googleads-php-lib

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}

Show file Open project: googleads/googleads-php-lib Class Usage Examples

Public Properties

Property	Type	Description
$SearchParameterType	string

Public Methods

Method	Description
__construct ( $SearchParameterType = null )
__get ( $var ) : mixed	Provided for getting non-php-standard named variables
__set ( $var, $value )	Provided for setting non-php-standard named variables
getNamespace ( ) : string	Gets the namesapce of this class
getXsiTypeName ( ) : string	Gets the xsi:type name of this class

Protected Methods

Method	Description
getParameterMap ( ) : array	Provided for getting non-php-standard named variables

Method Details

__construct() public method

public __construct ( $SearchParameterType = null )

__get() public method

Provided for getting non-php-standard named variables

public __get ( $var ) : mixed
$var		Variable name to get
return	mixed	Variable value

__set() public method

Provided for setting non-php-standard named variables

public __set ( $var, $value )
$var		Variable name to set
$value		Value to set

getNamespace() public method

Gets the namesapce of this class

public getNamespace ( ) : string
return	string	the namespace of this class

getParameterMap() protected method

Provided for getting non-php-standard named variables

protected getParameterMap ( ) : array
return	array	parameter map

getXsiTypeName() public method

Gets the xsi:type name of this class

public getXsiTypeName ( ) : string
return	string	the xsi:type name of this class

Property Details

$SearchParameterType public property

public string $SearchParameterType
return	string