<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/ads/googleads/v25/services/benchmarks_service.proto

namespace Google\Ads\GoogleAds\V25\Services;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;

/**
 * Metrics calculated by aggregating values of a single metric.
 *
 * Generated from protobuf message <code>google.ads.googleads.v25.services.AggregateMetrics</code>
 */
class AggregateMetrics extends \Google\Protobuf\Internal\Message
{
    /**
     * The total cost paid by the customer. Cost is represented in USD by default,
     * if unspecified in the request.
     *
     * Generated from protobuf field <code>double cost = 1;</code>
     */
    protected $cost = 0.0;
    /**
     * The number of video TrueView views.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on TrueView Views.
     *
     * Generated from protobuf field <code>double video_trueview_views = 2;</code>
     */
    protected $video_trueview_views = 0.0;
    /**
     * The number of times the Ad was shown to users.
     *
     * Generated from protobuf field <code>double impressions = 3;</code>
     */
    protected $impressions = 0.0;
    /**
     * The number of impressions that are considered viewable according to the
     * Active View criteria.
     * See https://support.google.com/google-ads/answer/7029393 for more
     * information on Active View.
     *
     * Generated from protobuf field <code>double viewable_impressions = 4;</code>
     */
    protected $viewable_impressions = 0.0;
    /**
     * The number of clicks received.
     *
     * Generated from protobuf field <code>double clicks = 5;</code>
     */
    protected $clicks = 0.0;
    /**
     * The number of interactions. Interactions include physical clicks,
     * engagements, and video views that are logged as clicks.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on interactions.
     *
     * Generated from protobuf field <code>double interactions = 6;</code>
     */
    protected $interactions = 0.0;
    /**
     * The number of engagements. Engagements are ad interactions such as
     * expanding a lightbox Ad or clicking on a video teaser.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on engagements.
     *
     * Generated from protobuf field <code>double engagements = 7;</code>
     */
    protected $engagements = 0.0;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type float $cost
     *           The total cost paid by the customer. Cost is represented in USD by default,
     *           if unspecified in the request.
     *     @type float $video_trueview_views
     *           The number of video TrueView views.
     *           See https://support.google.com/google-ads/answer/2375431 for more
     *           information on TrueView Views.
     *     @type float $impressions
     *           The number of times the Ad was shown to users.
     *     @type float $viewable_impressions
     *           The number of impressions that are considered viewable according to the
     *           Active View criteria.
     *           See https://support.google.com/google-ads/answer/7029393 for more
     *           information on Active View.
     *     @type float $clicks
     *           The number of clicks received.
     *     @type float $interactions
     *           The number of interactions. Interactions include physical clicks,
     *           engagements, and video views that are logged as clicks.
     *           See https://support.google.com/google-ads/answer/2375431 for more
     *           information on interactions.
     *     @type float $engagements
     *           The number of engagements. Engagements are ad interactions such as
     *           expanding a lightbox Ad or clicking on a video teaser.
     *           See https://support.google.com/google-ads/answer/2375431 for more
     *           information on engagements.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Ads\GoogleAds\V25\Services\BenchmarksService::initOnce();
        parent::__construct($data);
    }

    /**
     * The total cost paid by the customer. Cost is represented in USD by default,
     * if unspecified in the request.
     *
     * Generated from protobuf field <code>double cost = 1;</code>
     * @return float
     */
    public function getCost()
    {
        return $this->cost;
    }

    /**
     * The total cost paid by the customer. Cost is represented in USD by default,
     * if unspecified in the request.
     *
     * Generated from protobuf field <code>double cost = 1;</code>
     * @param float $var
     * @return $this
     */
    public function setCost($var)
    {
        GPBUtil::checkDouble($var);
        $this->cost = $var;

        return $this;
    }

    /**
     * The number of video TrueView views.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on TrueView Views.
     *
     * Generated from protobuf field <code>double video_trueview_views = 2;</code>
     * @return float
     */
    public function getVideoTrueviewViews()
    {
        return $this->video_trueview_views;
    }

    /**
     * The number of video TrueView views.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on TrueView Views.
     *
     * Generated from protobuf field <code>double video_trueview_views = 2;</code>
     * @param float $var
     * @return $this
     */
    public function setVideoTrueviewViews($var)
    {
        GPBUtil::checkDouble($var);
        $this->video_trueview_views = $var;

        return $this;
    }

    /**
     * The number of times the Ad was shown to users.
     *
     * Generated from protobuf field <code>double impressions = 3;</code>
     * @return float
     */
    public function getImpressions()
    {
        return $this->impressions;
    }

    /**
     * The number of times the Ad was shown to users.
     *
     * Generated from protobuf field <code>double impressions = 3;</code>
     * @param float $var
     * @return $this
     */
    public function setImpressions($var)
    {
        GPBUtil::checkDouble($var);
        $this->impressions = $var;

        return $this;
    }

    /**
     * The number of impressions that are considered viewable according to the
     * Active View criteria.
     * See https://support.google.com/google-ads/answer/7029393 for more
     * information on Active View.
     *
     * Generated from protobuf field <code>double viewable_impressions = 4;</code>
     * @return float
     */
    public function getViewableImpressions()
    {
        return $this->viewable_impressions;
    }

    /**
     * The number of impressions that are considered viewable according to the
     * Active View criteria.
     * See https://support.google.com/google-ads/answer/7029393 for more
     * information on Active View.
     *
     * Generated from protobuf field <code>double viewable_impressions = 4;</code>
     * @param float $var
     * @return $this
     */
    public function setViewableImpressions($var)
    {
        GPBUtil::checkDouble($var);
        $this->viewable_impressions = $var;

        return $this;
    }

    /**
     * The number of clicks received.
     *
     * Generated from protobuf field <code>double clicks = 5;</code>
     * @return float
     */
    public function getClicks()
    {
        return $this->clicks;
    }

    /**
     * The number of clicks received.
     *
     * Generated from protobuf field <code>double clicks = 5;</code>
     * @param float $var
     * @return $this
     */
    public function setClicks($var)
    {
        GPBUtil::checkDouble($var);
        $this->clicks = $var;

        return $this;
    }

    /**
     * The number of interactions. Interactions include physical clicks,
     * engagements, and video views that are logged as clicks.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on interactions.
     *
     * Generated from protobuf field <code>double interactions = 6;</code>
     * @return float
     */
    public function getInteractions()
    {
        return $this->interactions;
    }

    /**
     * The number of interactions. Interactions include physical clicks,
     * engagements, and video views that are logged as clicks.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on interactions.
     *
     * Generated from protobuf field <code>double interactions = 6;</code>
     * @param float $var
     * @return $this
     */
    public function setInteractions($var)
    {
        GPBUtil::checkDouble($var);
        $this->interactions = $var;

        return $this;
    }

    /**
     * The number of engagements. Engagements are ad interactions such as
     * expanding a lightbox Ad or clicking on a video teaser.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on engagements.
     *
     * Generated from protobuf field <code>double engagements = 7;</code>
     * @return float
     */
    public function getEngagements()
    {
        return $this->engagements;
    }

    /**
     * The number of engagements. Engagements are ad interactions such as
     * expanding a lightbox Ad or clicking on a video teaser.
     * See https://support.google.com/google-ads/answer/2375431 for more
     * information on engagements.
     *
     * Generated from protobuf field <code>double engagements = 7;</code>
     * @param float $var
     * @return $this
     */
    public function setEngagements($var)
    {
        GPBUtil::checkDouble($var);
        $this->engagements = $var;

        return $this;
    }

}

