google.ads.googleads.v24.resources.SearchTermView
*/
class SearchTermView extends \Google\Protobuf\Internal\Message
{
/**
* Output only. The resource name of the search term view.
* Search term view resource names have the form:
* `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
*
* Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
*/
protected $resource_name = '';
/**
* Output only. The search term.
*
* Generated from protobuf field optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $search_term = null;
/**
* Output only. The ad group the search term served in.
*
* Generated from protobuf field optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
*/
protected $ad_group = null;
/**
* Output only. Indicates whether the search term is currently one of your
* targeted or excluded keywords.
*
* Generated from protobuf field .google.ads.googleads.v24.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $status = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $resource_name
* Output only. The resource name of the search term view.
* Search term view resource names have the form:
* `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
* @type string $search_term
* Output only. The search term.
* @type string $ad_group
* Output only. The ad group the search term served in.
* @type int $status
* Output only. Indicates whether the search term is currently one of your
* targeted or excluded keywords.
* }
*/
public function __construct($data = null)
{
\GPBMetadata\Google\Ads\GoogleAds\V24\Resources\SearchTermView::initOnce();
parent::__construct($data);
}
/**
* Output only. The resource name of the search term view.
* Search term view resource names have the form:
* `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
*
* Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
*
* @return string
*/
public function getResourceName()
{
return $this->resource_name;
}
/**
* Output only. The resource name of the search term view.
* Search term view resource names have the form:
* `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
*
* Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
*
* @param string $var
* @return $this
*/
public function setResourceName($var)
{
GPBUtil::checkString($var, true);
$this->resource_name = $var;
return $this;
}
/**
* Output only. The search term.
*
* Generated from protobuf field optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return string
*/
public function getSearchTerm()
{
return isset($this->search_term) ? $this->search_term : '';
}
public function hasSearchTerm()
{
return isset($this->search_term);
}
public function clearSearchTerm()
{
unset($this->search_term);
}
/**
* Output only. The search term.
*
* Generated from protobuf field optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @param string $var
* @return $this
*/
public function setSearchTerm($var)
{
GPBUtil::checkString($var, true);
$this->search_term = $var;
return $this;
}
/**
* Output only. The ad group the search term served in.
*
* Generated from protobuf field optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
*
* @return string
*/
public function getAdGroup()
{
return isset($this->ad_group) ? $this->ad_group : '';
}
public function hasAdGroup()
{
return isset($this->ad_group);
}
public function clearAdGroup()
{
unset($this->ad_group);
}
/**
* Output only. The ad group the search term served in.
*
* Generated from protobuf field optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
*
* @param string $var
* @return $this
*/
public function setAdGroup($var)
{
GPBUtil::checkString($var, true);
$this->ad_group = $var;
return $this;
}
/**
* Output only. Indicates whether the search term is currently one of your
* targeted or excluded keywords.
*
* Generated from protobuf field .google.ads.googleads.v24.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return int
*/
public function getStatus()
{
return $this->status;
}
/**
* Output only. Indicates whether the search term is currently one of your
* targeted or excluded keywords.
*
* Generated from protobuf field .google.ads.googleads.v24.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @param int $var
* @return $this
*/
public function setStatus($var)
{
GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V24\Enums\SearchTermTargetingStatusEnum\SearchTermTargetingStatus::class);
$this->status = $var;
return $this;
}
}