google.ads.googleads.v25.resources.Customer
*/
class Customer extends \Google\Protobuf\Internal\Message
{
/**
* Immutable. The resource name of the customer.
* Customer resource names have the form:
* `customers/{customer_id}`
*
* Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {
*/
protected $resource_name = '';
/**
* Output only. The ID of the customer.
*
* Generated from protobuf field optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $id = null;
/**
* Optional, non-unique descriptive name of the customer.
*
* Generated from protobuf field optional string descriptive_name = 20;
*/
protected $descriptive_name = null;
/**
* Immutable. The currency in which the account operates.
* A subset of the currency codes from the ISO 4217 standard is
* supported.
*
* Generated from protobuf field optional string currency_code = 21 [(.google.api.field_behavior) = IMMUTABLE];
*/
protected $currency_code = null;
/**
* Immutable. The local timezone ID of the customer.
*
* Generated from protobuf field optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
*/
protected $time_zone = null;
/**
* The URL template for constructing a tracking URL out of parameters.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional string tracking_url_template = 23;
*/
protected $tracking_url_template = null;
/**
* The URL template for appending params to the final URL.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional string final_url_suffix = 24;
*/
protected $final_url_suffix = null;
/**
* Whether auto-tagging is enabled for the customer.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional bool auto_tagging_enabled = 25;
*/
protected $auto_tagging_enabled = null;
/**
* Output only. Whether the Customer has a Partners program badge. If the
* Customer is not associated with the Partners program, this will be false.
* For more information, see
* https://support.google.com/partners/answer/3125774.
*
* Generated from protobuf field optional bool has_partners_badge = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $has_partners_badge = null;
/**
* Output only. Whether the customer is a manager.
*
* Generated from protobuf field optional bool manager = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $manager = null;
/**
* Output only. Whether the customer is a test account.
*
* Generated from protobuf field optional bool test_account = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $test_account = null;
/**
* Call reporting setting for a customer. Only mutable in an `update`
* operation.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.CallReportingSetting call_reporting_setting = 10;
*/
protected $call_reporting_setting = null;
/**
* Conversion tracking setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.ConversionTrackingSetting conversion_tracking_setting = 14;
*/
protected $conversion_tracking_setting = null;
/**
* Output only. Remarketing setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $remarketing_setting = null;
/**
* Output only. Reasons why the customer is not eligible to use
* PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
* This field is read-only.
*
* Generated from protobuf field repeated .google.ads.googleads.v25.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
private $pay_per_conversion_eligibility_failure_reasons;
/**
* Output only. Optimization score of the customer.
* Optimization score is an estimate of how well a customer's campaigns are
* set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null
* for all manager customers, and for unscored non-manager customers.
* See "About optimization score" at
* https://support.google.com/google-ads/answer/9061546.
* This field is read-only.
*
* Generated from protobuf field optional double optimization_score = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $optimization_score = null;
/**
* Output only. Optimization score weight of the customer.
* Optimization score weight can be used to compare/aggregate optimization
* scores across multiple non-manager customers. The aggregate optimization
* score of a manager is computed as the sum over all of their customers of
* `Customer.optimization_score * Customer.optimization_score_weight`. This
* field is 0 for all manager customers, and for unscored non-manager
* customers.
* This field is read-only.
*
* Generated from protobuf field double optimization_score_weight = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $optimization_score_weight = 0.0;
/**
* Output only. The status of the customer.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.CustomerStatusEnum.CustomerStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $status = 0;
/**
* Output only. True if feed based location has been migrated to asset based
* location.
*
* Generated from protobuf field optional bool location_asset_auto_migration_done = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $location_asset_auto_migration_done = null;
/**
* Output only. True if feed based image has been migrated to asset based
* image.
*
* Generated from protobuf field optional bool image_asset_auto_migration_done = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $image_asset_auto_migration_done = null;
/**
* Output only. Timestamp of migration from feed based location to asset base
* location in yyyy-MM-dd HH:mm:ss format.
*
* Generated from protobuf field optional string location_asset_auto_migration_done_date_time = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $location_asset_auto_migration_done_date_time = null;
/**
* Output only. Timestamp of migration from feed based image to asset base
* image in yyyy-MM-dd HH:mm:ss format.
*
* Generated from protobuf field optional string image_asset_auto_migration_done_date_time = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $image_asset_auto_migration_done_date_time = null;
/**
* Output only. Customer Agreement Setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.CustomerAgreementSetting customer_agreement_setting = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $customer_agreement_setting = null;
/**
* Output only. Settings for Local Services customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.LocalServicesSettings local_services_settings = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $local_services_settings = null;
/**
* Brand Safety setting at the account level. Allows for selecting
* an inventory type to show your ads on content that is the right fit for
* your brand. See https://support.google.com/google-ads/answer/7515513.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 46;
*/
protected $video_brand_safety_suitability = 0;
/**
* Video specific information about a Customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.VideoCustomer video_customer = 54;
*/
protected $video_customer = null;
/**
* Output only. Returns the advertiser self-declaration status of whether this
* customer contains political advertising content targeted towards the
* European Union. You can use the Google Ads UI to update this account-level
* declaration, or use the API to update the self-declaration status of
* individual campaigns.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.EuPoliticalAdvertisingStatusEnum.EuPoliticalAdvertisingStatus contains_eu_political_advertising = 55 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
protected $contains_eu_political_advertising = 0;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $resource_name
* Immutable. The resource name of the customer.
* Customer resource names have the form:
* `customers/{customer_id}`
* @type int|string $id
* Output only. The ID of the customer.
* @type string $descriptive_name
* Optional, non-unique descriptive name of the customer.
* @type string $currency_code
* Immutable. The currency in which the account operates.
* A subset of the currency codes from the ISO 4217 standard is
* supported.
* @type string $time_zone
* Immutable. The local timezone ID of the customer.
* @type string $tracking_url_template
* The URL template for constructing a tracking URL out of parameters.
* Only mutable in an `update` operation.
* @type string $final_url_suffix
* The URL template for appending params to the final URL.
* Only mutable in an `update` operation.
* @type bool $auto_tagging_enabled
* Whether auto-tagging is enabled for the customer.
* Only mutable in an `update` operation.
* @type bool $has_partners_badge
* Output only. Whether the Customer has a Partners program badge. If the
* Customer is not associated with the Partners program, this will be false.
* For more information, see
* https://support.google.com/partners/answer/3125774.
* @type bool $manager
* Output only. Whether the customer is a manager.
* @type bool $test_account
* Output only. Whether the customer is a test account.
* @type \Google\Ads\GoogleAds\V25\Resources\CallReportingSetting $call_reporting_setting
* Call reporting setting for a customer. Only mutable in an `update`
* operation.
* @type \Google\Ads\GoogleAds\V25\Resources\ConversionTrackingSetting $conversion_tracking_setting
* Conversion tracking setting for a customer.
* @type \Google\Ads\GoogleAds\V25\Resources\RemarketingSetting $remarketing_setting
* Output only. Remarketing setting for a customer.
* @type int[] $pay_per_conversion_eligibility_failure_reasons
* Output only. Reasons why the customer is not eligible to use
* PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
* This field is read-only.
* @type float $optimization_score
* Output only. Optimization score of the customer.
* Optimization score is an estimate of how well a customer's campaigns are
* set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null
* for all manager customers, and for unscored non-manager customers.
* See "About optimization score" at
* https://support.google.com/google-ads/answer/9061546.
* This field is read-only.
* @type float $optimization_score_weight
* Output only. Optimization score weight of the customer.
* Optimization score weight can be used to compare/aggregate optimization
* scores across multiple non-manager customers. The aggregate optimization
* score of a manager is computed as the sum over all of their customers of
* `Customer.optimization_score * Customer.optimization_score_weight`. This
* field is 0 for all manager customers, and for unscored non-manager
* customers.
* This field is read-only.
* @type int $status
* Output only. The status of the customer.
* @type bool $location_asset_auto_migration_done
* Output only. True if feed based location has been migrated to asset based
* location.
* @type bool $image_asset_auto_migration_done
* Output only. True if feed based image has been migrated to asset based
* image.
* @type string $location_asset_auto_migration_done_date_time
* Output only. Timestamp of migration from feed based location to asset base
* location in yyyy-MM-dd HH:mm:ss format.
* @type string $image_asset_auto_migration_done_date_time
* Output only. Timestamp of migration from feed based image to asset base
* image in yyyy-MM-dd HH:mm:ss format.
* @type \Google\Ads\GoogleAds\V25\Resources\CustomerAgreementSetting $customer_agreement_setting
* Output only. Customer Agreement Setting for a customer.
* @type \Google\Ads\GoogleAds\V25\Resources\LocalServicesSettings $local_services_settings
* Output only. Settings for Local Services customer.
* @type int $video_brand_safety_suitability
* Brand Safety setting at the account level. Allows for selecting
* an inventory type to show your ads on content that is the right fit for
* your brand. See https://support.google.com/google-ads/answer/7515513.
* @type \Google\Ads\GoogleAds\V25\Resources\VideoCustomer $video_customer
* Video specific information about a Customer.
* @type int $contains_eu_political_advertising
* Output only. Returns the advertiser self-declaration status of whether this
* customer contains political advertising content targeted towards the
* European Union. You can use the Google Ads UI to update this account-level
* declaration, or use the API to update the self-declaration status of
* individual campaigns.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Ads\GoogleAds\V25\Resources\Customer::initOnce();
parent::__construct($data);
}
/**
* Immutable. The resource name of the customer.
* Customer resource names have the form:
* `customers/{customer_id}`
*
* Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = {
* @return string
*/
public function getResourceName()
{
return $this->resource_name;
}
/**
* Immutable. The resource name of the customer.
* Customer resource names have the form:
* `customers/{customer_id}`
*
* Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.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 ID of the customer.
*
* Generated from protobuf field optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return int|string
*/
public function getId()
{
return isset($this->id) ? $this->id : 0;
}
public function hasId()
{
return isset($this->id);
}
public function clearId()
{
unset($this->id);
}
/**
* Output only. The ID of the customer.
*
* Generated from protobuf field optional int64 id = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param int|string $var
* @return $this
*/
public function setId($var)
{
GPBUtil::checkInt64($var);
$this->id = $var;
return $this;
}
/**
* Optional, non-unique descriptive name of the customer.
*
* Generated from protobuf field optional string descriptive_name = 20;
* @return string
*/
public function getDescriptiveName()
{
return isset($this->descriptive_name) ? $this->descriptive_name : '';
}
public function hasDescriptiveName()
{
return isset($this->descriptive_name);
}
public function clearDescriptiveName()
{
unset($this->descriptive_name);
}
/**
* Optional, non-unique descriptive name of the customer.
*
* Generated from protobuf field optional string descriptive_name = 20;
* @param string $var
* @return $this
*/
public function setDescriptiveName($var)
{
GPBUtil::checkString($var, True);
$this->descriptive_name = $var;
return $this;
}
/**
* Immutable. The currency in which the account operates.
* A subset of the currency codes from the ISO 4217 standard is
* supported.
*
* Generated from protobuf field optional string currency_code = 21 [(.google.api.field_behavior) = IMMUTABLE];
* @return string
*/
public function getCurrencyCode()
{
return isset($this->currency_code) ? $this->currency_code : '';
}
public function hasCurrencyCode()
{
return isset($this->currency_code);
}
public function clearCurrencyCode()
{
unset($this->currency_code);
}
/**
* Immutable. The currency in which the account operates.
* A subset of the currency codes from the ISO 4217 standard is
* supported.
*
* Generated from protobuf field optional string currency_code = 21 [(.google.api.field_behavior) = IMMUTABLE];
* @param string $var
* @return $this
*/
public function setCurrencyCode($var)
{
GPBUtil::checkString($var, True);
$this->currency_code = $var;
return $this;
}
/**
* Immutable. The local timezone ID of the customer.
*
* Generated from protobuf field optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
* @return string
*/
public function getTimeZone()
{
return isset($this->time_zone) ? $this->time_zone : '';
}
public function hasTimeZone()
{
return isset($this->time_zone);
}
public function clearTimeZone()
{
unset($this->time_zone);
}
/**
* Immutable. The local timezone ID of the customer.
*
* Generated from protobuf field optional string time_zone = 22 [(.google.api.field_behavior) = IMMUTABLE];
* @param string $var
* @return $this
*/
public function setTimeZone($var)
{
GPBUtil::checkString($var, True);
$this->time_zone = $var;
return $this;
}
/**
* The URL template for constructing a tracking URL out of parameters.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional string tracking_url_template = 23;
* @return string
*/
public function getTrackingUrlTemplate()
{
return isset($this->tracking_url_template) ? $this->tracking_url_template : '';
}
public function hasTrackingUrlTemplate()
{
return isset($this->tracking_url_template);
}
public function clearTrackingUrlTemplate()
{
unset($this->tracking_url_template);
}
/**
* The URL template for constructing a tracking URL out of parameters.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional string tracking_url_template = 23;
* @param string $var
* @return $this
*/
public function setTrackingUrlTemplate($var)
{
GPBUtil::checkString($var, True);
$this->tracking_url_template = $var;
return $this;
}
/**
* The URL template for appending params to the final URL.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional string final_url_suffix = 24;
* @return string
*/
public function getFinalUrlSuffix()
{
return isset($this->final_url_suffix) ? $this->final_url_suffix : '';
}
public function hasFinalUrlSuffix()
{
return isset($this->final_url_suffix);
}
public function clearFinalUrlSuffix()
{
unset($this->final_url_suffix);
}
/**
* The URL template for appending params to the final URL.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional string final_url_suffix = 24;
* @param string $var
* @return $this
*/
public function setFinalUrlSuffix($var)
{
GPBUtil::checkString($var, True);
$this->final_url_suffix = $var;
return $this;
}
/**
* Whether auto-tagging is enabled for the customer.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional bool auto_tagging_enabled = 25;
* @return bool
*/
public function getAutoTaggingEnabled()
{
return isset($this->auto_tagging_enabled) ? $this->auto_tagging_enabled : false;
}
public function hasAutoTaggingEnabled()
{
return isset($this->auto_tagging_enabled);
}
public function clearAutoTaggingEnabled()
{
unset($this->auto_tagging_enabled);
}
/**
* Whether auto-tagging is enabled for the customer.
* Only mutable in an `update` operation.
*
* Generated from protobuf field optional bool auto_tagging_enabled = 25;
* @param bool $var
* @return $this
*/
public function setAutoTaggingEnabled($var)
{
GPBUtil::checkBool($var);
$this->auto_tagging_enabled = $var;
return $this;
}
/**
* Output only. Whether the Customer has a Partners program badge. If the
* Customer is not associated with the Partners program, this will be false.
* For more information, see
* https://support.google.com/partners/answer/3125774.
*
* Generated from protobuf field optional bool has_partners_badge = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return bool
*/
public function getHasPartnersBadge()
{
return isset($this->has_partners_badge) ? $this->has_partners_badge : false;
}
public function hasHasPartnersBadge()
{
return isset($this->has_partners_badge);
}
public function clearHasPartnersBadge()
{
unset($this->has_partners_badge);
}
/**
* Output only. Whether the Customer has a Partners program badge. If the
* Customer is not associated with the Partners program, this will be false.
* For more information, see
* https://support.google.com/partners/answer/3125774.
*
* Generated from protobuf field optional bool has_partners_badge = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param bool $var
* @return $this
*/
public function setHasPartnersBadge($var)
{
GPBUtil::checkBool($var);
$this->has_partners_badge = $var;
return $this;
}
/**
* Output only. Whether the customer is a manager.
*
* Generated from protobuf field optional bool manager = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return bool
*/
public function getManager()
{
return isset($this->manager) ? $this->manager : false;
}
public function hasManager()
{
return isset($this->manager);
}
public function clearManager()
{
unset($this->manager);
}
/**
* Output only. Whether the customer is a manager.
*
* Generated from protobuf field optional bool manager = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param bool $var
* @return $this
*/
public function setManager($var)
{
GPBUtil::checkBool($var);
$this->manager = $var;
return $this;
}
/**
* Output only. Whether the customer is a test account.
*
* Generated from protobuf field optional bool test_account = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return bool
*/
public function getTestAccount()
{
return isset($this->test_account) ? $this->test_account : false;
}
public function hasTestAccount()
{
return isset($this->test_account);
}
public function clearTestAccount()
{
unset($this->test_account);
}
/**
* Output only. Whether the customer is a test account.
*
* Generated from protobuf field optional bool test_account = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param bool $var
* @return $this
*/
public function setTestAccount($var)
{
GPBUtil::checkBool($var);
$this->test_account = $var;
return $this;
}
/**
* Call reporting setting for a customer. Only mutable in an `update`
* operation.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.CallReportingSetting call_reporting_setting = 10;
* @return \Google\Ads\GoogleAds\V25\Resources\CallReportingSetting|null
*/
public function getCallReportingSetting()
{
return $this->call_reporting_setting;
}
public function hasCallReportingSetting()
{
return isset($this->call_reporting_setting);
}
public function clearCallReportingSetting()
{
unset($this->call_reporting_setting);
}
/**
* Call reporting setting for a customer. Only mutable in an `update`
* operation.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.CallReportingSetting call_reporting_setting = 10;
* @param \Google\Ads\GoogleAds\V25\Resources\CallReportingSetting $var
* @return $this
*/
public function setCallReportingSetting($var)
{
GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Resources\CallReportingSetting::class);
$this->call_reporting_setting = $var;
return $this;
}
/**
* Conversion tracking setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.ConversionTrackingSetting conversion_tracking_setting = 14;
* @return \Google\Ads\GoogleAds\V25\Resources\ConversionTrackingSetting|null
*/
public function getConversionTrackingSetting()
{
return $this->conversion_tracking_setting;
}
public function hasConversionTrackingSetting()
{
return isset($this->conversion_tracking_setting);
}
public function clearConversionTrackingSetting()
{
unset($this->conversion_tracking_setting);
}
/**
* Conversion tracking setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.ConversionTrackingSetting conversion_tracking_setting = 14;
* @param \Google\Ads\GoogleAds\V25\Resources\ConversionTrackingSetting $var
* @return $this
*/
public function setConversionTrackingSetting($var)
{
GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Resources\ConversionTrackingSetting::class);
$this->conversion_tracking_setting = $var;
return $this;
}
/**
* Output only. Remarketing setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return \Google\Ads\GoogleAds\V25\Resources\RemarketingSetting|null
*/
public function getRemarketingSetting()
{
return $this->remarketing_setting;
}
public function hasRemarketingSetting()
{
return isset($this->remarketing_setting);
}
public function clearRemarketingSetting()
{
unset($this->remarketing_setting);
}
/**
* Output only. Remarketing setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.RemarketingSetting remarketing_setting = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param \Google\Ads\GoogleAds\V25\Resources\RemarketingSetting $var
* @return $this
*/
public function setRemarketingSetting($var)
{
GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Resources\RemarketingSetting::class);
$this->remarketing_setting = $var;
return $this;
}
/**
* Output only. Reasons why the customer is not eligible to use
* PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
* This field is read-only.
*
* Generated from protobuf field repeated .google.ads.googleads.v25.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return RepeatedField
*/
public function getPayPerConversionEligibilityFailureReasons()
{
return $this->pay_per_conversion_eligibility_failure_reasons;
}
/**
* Output only. Reasons why the customer is not eligible to use
* PaymentMode.CONVERSIONS. If the list is empty, the customer is eligible.
* This field is read-only.
*
* Generated from protobuf field repeated .google.ads.googleads.v25.enums.CustomerPayPerConversionEligibilityFailureReasonEnum.CustomerPayPerConversionEligibilityFailureReason pay_per_conversion_eligibility_failure_reasons = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param int[] $var
* @return $this
*/
public function setPayPerConversionEligibilityFailureReasons($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V25\Enums\CustomerPayPerConversionEligibilityFailureReasonEnum\CustomerPayPerConversionEligibilityFailureReason::class);
$this->pay_per_conversion_eligibility_failure_reasons = $arr;
return $this;
}
/**
* Output only. Optimization score of the customer.
* Optimization score is an estimate of how well a customer's campaigns are
* set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null
* for all manager customers, and for unscored non-manager customers.
* See "About optimization score" at
* https://support.google.com/google-ads/answer/9061546.
* This field is read-only.
*
* Generated from protobuf field optional double optimization_score = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return float
*/
public function getOptimizationScore()
{
return isset($this->optimization_score) ? $this->optimization_score : 0.0;
}
public function hasOptimizationScore()
{
return isset($this->optimization_score);
}
public function clearOptimizationScore()
{
unset($this->optimization_score);
}
/**
* Output only. Optimization score of the customer.
* Optimization score is an estimate of how well a customer's campaigns are
* set to perform. It ranges from 0% (0.0) to 100% (1.0). This field is null
* for all manager customers, and for unscored non-manager customers.
* See "About optimization score" at
* https://support.google.com/google-ads/answer/9061546.
* This field is read-only.
*
* Generated from protobuf field optional double optimization_score = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param float $var
* @return $this
*/
public function setOptimizationScore($var)
{
GPBUtil::checkDouble($var);
$this->optimization_score = $var;
return $this;
}
/**
* Output only. Optimization score weight of the customer.
* Optimization score weight can be used to compare/aggregate optimization
* scores across multiple non-manager customers. The aggregate optimization
* score of a manager is computed as the sum over all of their customers of
* `Customer.optimization_score * Customer.optimization_score_weight`. This
* field is 0 for all manager customers, and for unscored non-manager
* customers.
* This field is read-only.
*
* Generated from protobuf field double optimization_score_weight = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return float
*/
public function getOptimizationScoreWeight()
{
return $this->optimization_score_weight;
}
/**
* Output only. Optimization score weight of the customer.
* Optimization score weight can be used to compare/aggregate optimization
* scores across multiple non-manager customers. The aggregate optimization
* score of a manager is computed as the sum over all of their customers of
* `Customer.optimization_score * Customer.optimization_score_weight`. This
* field is 0 for all manager customers, and for unscored non-manager
* customers.
* This field is read-only.
*
* Generated from protobuf field double optimization_score_weight = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param float $var
* @return $this
*/
public function setOptimizationScoreWeight($var)
{
GPBUtil::checkDouble($var);
$this->optimization_score_weight = $var;
return $this;
}
/**
* Output only. The status of the customer.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.CustomerStatusEnum.CustomerStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return int
*/
public function getStatus()
{
return $this->status;
}
/**
* Output only. The status of the customer.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.CustomerStatusEnum.CustomerStatus status = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param int $var
* @return $this
*/
public function setStatus($var)
{
GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V25\Enums\CustomerStatusEnum\CustomerStatus::class);
$this->status = $var;
return $this;
}
/**
* Output only. True if feed based location has been migrated to asset based
* location.
*
* Generated from protobuf field optional bool location_asset_auto_migration_done = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return bool
*/
public function getLocationAssetAutoMigrationDone()
{
return isset($this->location_asset_auto_migration_done) ? $this->location_asset_auto_migration_done : false;
}
public function hasLocationAssetAutoMigrationDone()
{
return isset($this->location_asset_auto_migration_done);
}
public function clearLocationAssetAutoMigrationDone()
{
unset($this->location_asset_auto_migration_done);
}
/**
* Output only. True if feed based location has been migrated to asset based
* location.
*
* Generated from protobuf field optional bool location_asset_auto_migration_done = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param bool $var
* @return $this
*/
public function setLocationAssetAutoMigrationDone($var)
{
GPBUtil::checkBool($var);
$this->location_asset_auto_migration_done = $var;
return $this;
}
/**
* Output only. True if feed based image has been migrated to asset based
* image.
*
* Generated from protobuf field optional bool image_asset_auto_migration_done = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return bool
*/
public function getImageAssetAutoMigrationDone()
{
return isset($this->image_asset_auto_migration_done) ? $this->image_asset_auto_migration_done : false;
}
public function hasImageAssetAutoMigrationDone()
{
return isset($this->image_asset_auto_migration_done);
}
public function clearImageAssetAutoMigrationDone()
{
unset($this->image_asset_auto_migration_done);
}
/**
* Output only. True if feed based image has been migrated to asset based
* image.
*
* Generated from protobuf field optional bool image_asset_auto_migration_done = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param bool $var
* @return $this
*/
public function setImageAssetAutoMigrationDone($var)
{
GPBUtil::checkBool($var);
$this->image_asset_auto_migration_done = $var;
return $this;
}
/**
* Output only. Timestamp of migration from feed based location to asset base
* location in yyyy-MM-dd HH:mm:ss format.
*
* Generated from protobuf field optional string location_asset_auto_migration_done_date_time = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return string
*/
public function getLocationAssetAutoMigrationDoneDateTime()
{
return isset($this->location_asset_auto_migration_done_date_time) ? $this->location_asset_auto_migration_done_date_time : '';
}
public function hasLocationAssetAutoMigrationDoneDateTime()
{
return isset($this->location_asset_auto_migration_done_date_time);
}
public function clearLocationAssetAutoMigrationDoneDateTime()
{
unset($this->location_asset_auto_migration_done_date_time);
}
/**
* Output only. Timestamp of migration from feed based location to asset base
* location in yyyy-MM-dd HH:mm:ss format.
*
* Generated from protobuf field optional string location_asset_auto_migration_done_date_time = 40 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param string $var
* @return $this
*/
public function setLocationAssetAutoMigrationDoneDateTime($var)
{
GPBUtil::checkString($var, True);
$this->location_asset_auto_migration_done_date_time = $var;
return $this;
}
/**
* Output only. Timestamp of migration from feed based image to asset base
* image in yyyy-MM-dd HH:mm:ss format.
*
* Generated from protobuf field optional string image_asset_auto_migration_done_date_time = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return string
*/
public function getImageAssetAutoMigrationDoneDateTime()
{
return isset($this->image_asset_auto_migration_done_date_time) ? $this->image_asset_auto_migration_done_date_time : '';
}
public function hasImageAssetAutoMigrationDoneDateTime()
{
return isset($this->image_asset_auto_migration_done_date_time);
}
public function clearImageAssetAutoMigrationDoneDateTime()
{
unset($this->image_asset_auto_migration_done_date_time);
}
/**
* Output only. Timestamp of migration from feed based image to asset base
* image in yyyy-MM-dd HH:mm:ss format.
*
* Generated from protobuf field optional string image_asset_auto_migration_done_date_time = 41 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param string $var
* @return $this
*/
public function setImageAssetAutoMigrationDoneDateTime($var)
{
GPBUtil::checkString($var, True);
$this->image_asset_auto_migration_done_date_time = $var;
return $this;
}
/**
* Output only. Customer Agreement Setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.CustomerAgreementSetting customer_agreement_setting = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return \Google\Ads\GoogleAds\V25\Resources\CustomerAgreementSetting|null
*/
public function getCustomerAgreementSetting()
{
return $this->customer_agreement_setting;
}
public function hasCustomerAgreementSetting()
{
return isset($this->customer_agreement_setting);
}
public function clearCustomerAgreementSetting()
{
unset($this->customer_agreement_setting);
}
/**
* Output only. Customer Agreement Setting for a customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.CustomerAgreementSetting customer_agreement_setting = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param \Google\Ads\GoogleAds\V25\Resources\CustomerAgreementSetting $var
* @return $this
*/
public function setCustomerAgreementSetting($var)
{
GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Resources\CustomerAgreementSetting::class);
$this->customer_agreement_setting = $var;
return $this;
}
/**
* Output only. Settings for Local Services customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.LocalServicesSettings local_services_settings = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return \Google\Ads\GoogleAds\V25\Resources\LocalServicesSettings|null
*/
public function getLocalServicesSettings()
{
return $this->local_services_settings;
}
public function hasLocalServicesSettings()
{
return isset($this->local_services_settings);
}
public function clearLocalServicesSettings()
{
unset($this->local_services_settings);
}
/**
* Output only. Settings for Local Services customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.LocalServicesSettings local_services_settings = 45 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param \Google\Ads\GoogleAds\V25\Resources\LocalServicesSettings $var
* @return $this
*/
public function setLocalServicesSettings($var)
{
GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Resources\LocalServicesSettings::class);
$this->local_services_settings = $var;
return $this;
}
/**
* Brand Safety setting at the account level. Allows for selecting
* an inventory type to show your ads on content that is the right fit for
* your brand. See https://support.google.com/google-ads/answer/7515513.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 46;
* @return int
*/
public function getVideoBrandSafetySuitability()
{
return $this->video_brand_safety_suitability;
}
/**
* Brand Safety setting at the account level. Allows for selecting
* an inventory type to show your ads on content that is the right fit for
* your brand. See https://support.google.com/google-ads/answer/7515513.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 46;
* @param int $var
* @return $this
*/
public function setVideoBrandSafetySuitability($var)
{
GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V25\Enums\BrandSafetySuitabilityEnum\BrandSafetySuitability::class);
$this->video_brand_safety_suitability = $var;
return $this;
}
/**
* Video specific information about a Customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.VideoCustomer video_customer = 54;
* @return \Google\Ads\GoogleAds\V25\Resources\VideoCustomer|null
*/
public function getVideoCustomer()
{
return $this->video_customer;
}
public function hasVideoCustomer()
{
return isset($this->video_customer);
}
public function clearVideoCustomer()
{
unset($this->video_customer);
}
/**
* Video specific information about a Customer.
*
* Generated from protobuf field .google.ads.googleads.v25.resources.VideoCustomer video_customer = 54;
* @param \Google\Ads\GoogleAds\V25\Resources\VideoCustomer $var
* @return $this
*/
public function setVideoCustomer($var)
{
GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V25\Resources\VideoCustomer::class);
$this->video_customer = $var;
return $this;
}
/**
* Output only. Returns the advertiser self-declaration status of whether this
* customer contains political advertising content targeted towards the
* European Union. You can use the Google Ads UI to update this account-level
* declaration, or use the API to update the self-declaration status of
* individual campaigns.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.EuPoliticalAdvertisingStatusEnum.EuPoliticalAdvertisingStatus contains_eu_political_advertising = 55 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return int
*/
public function getContainsEuPoliticalAdvertising()
{
return $this->contains_eu_political_advertising;
}
/**
* Output only. Returns the advertiser self-declaration status of whether this
* customer contains political advertising content targeted towards the
* European Union. You can use the Google Ads UI to update this account-level
* declaration, or use the API to update the self-declaration status of
* individual campaigns.
*
* Generated from protobuf field .google.ads.googleads.v25.enums.EuPoliticalAdvertisingStatusEnum.EuPoliticalAdvertisingStatus contains_eu_political_advertising = 55 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param int $var
* @return $this
*/
public function setContainsEuPoliticalAdvertising($var)
{
GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V25\Enums\EuPoliticalAdvertisingStatusEnum\EuPoliticalAdvertisingStatus::class);
$this->contains_eu_political_advertising = $var;
return $this;
}
}