Class awRelatedToUrlSearchParameter

Description

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.

This search parameter can be used in bulk keyword requests through the getBulkKeywordIdeas(TargetingIdeaSelector) method. It must be single-valued when used in a call to that method.

This element is supported by following IdeaTypes: KEYWORD, PLACEMENT.

This element is supported by following RequestTypes: IDEAS, STATS.

Located in /classes/o/RelatedToUrlSearchParameter.php

awComplexObject
   |
   --awSearchParameter
      |
      --awRelatedToUrlSearchParameter
Variable Summary
 string[] $urls
Method Summary
 void getRow ()
Variables
bool $includeSubUrls

Whether to crawl links off of the {@code urls} for the same domain.

Default is {@code false}. Ignored on {@code KEYWORD} queries,

string[] $urls

A set of URL strings to which search results should be related. For {@code PLACEMENT} queries, up to five URLs may be submitted. For {@code KEYWORD} queries, only one URL may be submitted.

<span class="constraint ContentsDistinct">This field must contain distinct elements.</span> <span class="constraint ContentsNotNull">This field must not contain {@code null} elements.</span> <span class="constraint NotEmpty">This field must contain at least one element.</span> <span class="constraint Required">This field is required and should not be {@code null}.</span>

Inherited Variables

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_checkFields
awComplexObject::$_row
Methods

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