google.ads.googleads.v23.services.GenerateKeywordIdeaResponse
*/
class GenerateKeywordIdeaResponse extends \Google\Protobuf\Internal\Message
{
/**
* Results of generating keyword ideas.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.GenerateKeywordIdeaResult results = 1;
*/
private $results;
/**
* The aggregate metrics for all keyword ideas.
*
* Generated from protobuf field .google.ads.googleads.v23.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 4;
*/
protected $aggregate_metric_results = null;
/**
* Pagination token used to retrieve the next page of results.
* Pass the content of this string as the `page_token` attribute of
* the next request.
* `next_page_token` is not returned for the last page.
*
* Generated from protobuf field string next_page_token = 2;
*/
protected $next_page_token = '';
/**
* Total number of results available.
*
* Generated from protobuf field int64 total_size = 3;
*/
protected $total_size = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type \Google\Ads\GoogleAds\V23\Services\GenerateKeywordIdeaResult[] $results
* Results of generating keyword ideas.
* @type \Google\Ads\GoogleAds\V23\Common\KeywordPlanAggregateMetricResults $aggregate_metric_results
* The aggregate metrics for all keyword ideas.
* @type string $next_page_token
* Pagination token used to retrieve the next page of results.
* Pass the content of this string as the `page_token` attribute of
* the next request.
* `next_page_token` is not returned for the last page.
* @type int|string $total_size
* Total number of results available.
* }
*/
public function __construct($data = null)
{
\GPBMetadata\Google\Ads\GoogleAds\V23\Services\KeywordPlanIdeaService::initOnce();
parent::__construct($data);
}
/**
* Results of generating keyword ideas.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.GenerateKeywordIdeaResult results = 1;
*
* @return RepeatedField<\Google\Ads\GoogleAds\V23\Services\GenerateKeywordIdeaResult>
*/
public function getResults()
{
return $this->results;
}
/**
* Results of generating keyword ideas.
*
* Generated from protobuf field repeated .google.ads.googleads.v23.services.GenerateKeywordIdeaResult results = 1;
*
* @param \Google\Ads\GoogleAds\V23\Services\GenerateKeywordIdeaResult[] $var
* @return $this
*/
public function setResults($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V23\Services\GenerateKeywordIdeaResult::class);
$this->results = $arr;
return $this;
}
/**
* The aggregate metrics for all keyword ideas.
*
* Generated from protobuf field .google.ads.googleads.v23.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 4;
*
* @return \Google\Ads\GoogleAds\V23\Common\KeywordPlanAggregateMetricResults|null
*/
public function getAggregateMetricResults()
{
return $this->aggregate_metric_results;
}
public function hasAggregateMetricResults()
{
return isset($this->aggregate_metric_results);
}
public function clearAggregateMetricResults()
{
unset($this->aggregate_metric_results);
}
/**
* The aggregate metrics for all keyword ideas.
*
* Generated from protobuf field .google.ads.googleads.v23.common.KeywordPlanAggregateMetricResults aggregate_metric_results = 4;
*
* @param \Google\Ads\GoogleAds\V23\Common\KeywordPlanAggregateMetricResults $var
* @return $this
*/
public function setAggregateMetricResults($var)
{
GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\KeywordPlanAggregateMetricResults::class);
$this->aggregate_metric_results = $var;
return $this;
}
/**
* Pagination token used to retrieve the next page of results.
* Pass the content of this string as the `page_token` attribute of
* the next request.
* `next_page_token` is not returned for the last page.
*
* Generated from protobuf field string next_page_token = 2;
*
* @return string
*/
public function getNextPageToken()
{
return $this->next_page_token;
}
/**
* Pagination token used to retrieve the next page of results.
* Pass the content of this string as the `page_token` attribute of
* the next request.
* `next_page_token` is not returned for the last page.
*
* Generated from protobuf field string next_page_token = 2;
*
* @param string $var
* @return $this
*/
public function setNextPageToken($var)
{
GPBUtil::checkString($var, true);
$this->next_page_token = $var;
return $this;
}
/**
* Total number of results available.
*
* Generated from protobuf field int64 total_size = 3;
*
* @return int|string
*/
public function getTotalSize()
{
return $this->total_size;
}
/**
* Total number of results available.
*
* Generated from protobuf field int64 total_size = 3;
*
* @param int|string $var
* @return $this
*/
public function setTotalSize($var)
{
GPBUtil::checkInt64($var);
$this->total_size = $var;
return $this;
}
}