Google-Ads-GoogleAds-Client/lib/Google/Ads/GoogleAds/V20/Common/Metrics.pm
# Copyright 2020, Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
package Google::Ads::GoogleAds::V20::Common::Metrics;
use strict;
use warnings;
use base qw(Google::Ads::GoogleAds::BaseEntity);
use Google::Ads::GoogleAds::Utils::GoogleAdsHelper;
sub new {
my ($class, $args) = @_;
my $self = {
absoluteTopImpressionPercentage => $args->{absoluteTopImpressionPercentage},
activeViewCpm => $args->{activeViewCpm},
activeViewCtr => $args->{activeViewCtr},
activeViewImpressions => $args->{activeViewImpressions},
activeViewMeasurability => $args->{activeViewMeasurability},
activeViewMeasurableCostMicros => $args->{activeViewMeasurableCostMicros},
activeViewMeasurableImpressions => $args->{activeViewMeasurableImpressions},
activeViewViewability => $args->{activeViewViewability},
allConversions => $args->{allConversions},
allConversionsByConversionDate => $args->{allConversionsByConversionDate},
allConversionsFromClickToCall => $args->{allConversionsFromClickToCall},
allConversionsFromDirections => $args->{allConversionsFromDirections},
allConversionsFromInteractionsRate =>
$args->{allConversionsFromInteractionsRate},
allConversionsFromInteractionsValuePerInteraction =>
$args->{allConversionsFromInteractionsValuePerInteraction},
allConversionsFromLocationAssetClickToCall =>
$args->{allConversionsFromLocationAssetClickToCall},
allConversionsFromLocationAssetDirections =>
$args->{allConversionsFromLocationAssetDirections},
allConversionsFromLocationAssetMenu =>
$args->{allConversionsFromLocationAssetMenu},
allConversionsFromLocationAssetOrder =>
$args->{allConversionsFromLocationAssetOrder},
allConversionsFromLocationAssetOtherEngagement =>
$args->{allConversionsFromLocationAssetOtherEngagement},
allConversionsFromLocationAssetStoreVisits =>
$args->{allConversionsFromLocationAssetStoreVisits},
allConversionsFromLocationAssetWebsite =>
$args->{allConversionsFromLocationAssetWebsite},
allConversionsFromMenu => $args->{allConversionsFromMenu},
allConversionsFromOrder => $args->{allConversionsFromOrder},
allConversionsFromOtherEngagement =>
$args->{allConversionsFromOtherEngagement},
allConversionsFromStoreVisit => $args->{allConversionsFromStoreVisit},
allConversionsFromStoreWebsite => $args->{allConversionsFromStoreWebsite},
allConversionsValue => $args->{allConversionsValue},
allConversionsValueByConversionDate =>
$args->{allConversionsValueByConversionDate},
allConversionsValuePerCost => $args->{allConversionsValuePerCost},
allNewCustomerLifetimeValue => $args->{allNewCustomerLifetimeValue},
assetBestPerformanceCostPercentage =>
$args->{assetBestPerformanceCostPercentage},
assetBestPerformanceImpressionPercentage =>
$args->{assetBestPerformanceImpressionPercentage},
assetGoodPerformanceCostPercentage =>
$args->{assetGoodPerformanceCostPercentage},
assetGoodPerformanceImpressionPercentage =>
$args->{assetGoodPerformanceImpressionPercentage},
assetLearningPerformanceCostPercentage =>
$args->{assetLearningPerformanceCostPercentage},
assetLearningPerformanceImpressionPercentage =>
$args->{assetLearningPerformanceImpressionPercentage},
assetLowPerformanceCostPercentage =>
$args->{assetLowPerformanceCostPercentage},
assetLowPerformanceImpressionPercentage =>
$args->{assetLowPerformanceImpressionPercentage},
assetPinnedAsDescriptionPositionOneCount =>
$args->{assetPinnedAsDescriptionPositionOneCount},
assetPinnedAsDescriptionPositionTwoCount =>
$args->{assetPinnedAsDescriptionPositionTwoCount},
assetPinnedAsHeadlinePositionOneCount =>
$args->{assetPinnedAsHeadlinePositionOneCount},
assetPinnedAsHeadlinePositionThreeCount =>
$args->{assetPinnedAsHeadlinePositionThreeCount},
assetPinnedAsHeadlinePositionTwoCount =>
$args->{assetPinnedAsHeadlinePositionTwoCount},
assetPinnedTotalCount => $args->{assetPinnedTotalCount},
assetUnratedPerformanceCostPercentage =>
$args->{assetUnratedPerformanceCostPercentage},
assetUnratedPerformanceImpressionPercentage =>
$args->{assetUnratedPerformanceImpressionPercentage},
auctionInsightSearchAbsoluteTopImpressionPercentage =>
$args->{auctionInsightSearchAbsoluteTopImpressionPercentage},
auctionInsightSearchImpressionShare =>
$args->{auctionInsightSearchImpressionShare},
auctionInsightSearchOutrankingShare =>
$args->{auctionInsightSearchOutrankingShare},
auctionInsightSearchOverlapRate => $args->{auctionInsightSearchOverlapRate},
auctionInsightSearchPositionAboveRate =>
$args->{auctionInsightSearchPositionAboveRate},
auctionInsightSearchTopImpressionPercentage =>
$args->{auctionInsightSearchTopImpressionPercentage},
averageCartSize => $args->{averageCartSize},
averageCost => $args->{averageCost},
averageCpc => $args->{averageCpc},
averageCpe => $args->{averageCpe},
averageCpm => $args->{averageCpm},
averageCpv => $args->{averageCpv},
averageImpressionFrequencyPerUser =>
$args->{averageImpressionFrequencyPerUser},
averageOrderValueMicros => $args->{averageOrderValueMicros},
averagePageViews => $args->{averagePageViews},
averageTargetCpaMicros => $args->{averageTargetCpaMicros},
averageTargetRoas => $args->{averageTargetRoas},
averageTimeOnSite => $args->{averageTimeOnSite},
benchmarkAverageMaxCpc => $args->{benchmarkAverageMaxCpc},
benchmarkCtr => $args->{benchmarkCtr},
biddableAppInstallConversions => $args->{biddableAppInstallConversions},
biddableAppPostInstallConversions =>
$args->{biddableAppPostInstallConversions},
biddableCohortAppPostInstallConversions =>
$args->{biddableCohortAppPostInstallConversions},
bounceRate => $args->{bounceRate},
clicks => $args->{clicks},
combinedClicks => $args->{combinedClicks},
combinedClicksPerQuery => $args->{combinedClicksPerQuery},
combinedQueries => $args->{combinedQueries},
contentBudgetLostImpressionShare =>
$args->{contentBudgetLostImpressionShare},
contentImpressionShare => $args->{contentImpressionShare},
contentRankLostImpressionShare => $args->{contentRankLostImpressionShare},
conversionLastConversionDate => $args->{conversionLastConversionDate},
conversionLastReceivedRequestDateTime =>
$args->{conversionLastReceivedRequestDateTime},
conversions => $args->{conversions},
conversionsByConversionDate => $args->{conversionsByConversionDate},
conversionsFromInteractionsRate => $args->{conversionsFromInteractionsRate},
conversionsFromInteractionsValuePerInteraction =>
$args->{conversionsFromInteractionsValuePerInteraction},
conversionsValue => $args->{conversionsValue},
conversionsValueByConversionDate =>
$args->{conversionsValueByConversionDate},
conversionsValuePerCost => $args->{conversionsValuePerCost},
costConvertedCurrencyPerPlatformComparableConversion =>
$args->{costConvertedCurrencyPerPlatformComparableConversion},
costMicros => $args->{costMicros},
costOfGoodsSoldMicros => $args->{costOfGoodsSoldMicros},
costPerAllConversions => $args->{costPerAllConversions},
costPerConversion => $args->{costPerConversion},
costPerCurrentModelAttributedConversion =>
$args->{costPerCurrentModelAttributedConversion},
costPerPlatformComparableConversion =>
$args->{costPerPlatformComparableConversion},
coviewedImpressions => $args->{coviewedImpressions},
crossDeviceConversions => $args->{crossDeviceConversions},
crossDeviceConversionsValueMicros =>
$args->{crossDeviceConversionsValueMicros},
crossSellCostOfGoodsSoldMicros => $args->{crossSellCostOfGoodsSoldMicros},
crossSellGrossProfitMicros => $args->{crossSellGrossProfitMicros},
crossSellRevenueMicros => $args->{crossSellRevenueMicros},
crossSellUnitsSold => $args->{crossSellUnitsSold},
ctr => $args->{ctr},
currentModelAttributedConversions =>
$args->{currentModelAttributedConversions},
currentModelAttributedConversionsFromInteractionsRate =>
$args->{currentModelAttributedConversionsFromInteractionsRate},
currentModelAttributedConversionsFromInteractionsValuePerInteraction =>
$args->
{currentModelAttributedConversionsFromInteractionsValuePerInteraction},
currentModelAttributedConversionsValue =>
$args->{currentModelAttributedConversionsValue},
currentModelAttributedConversionsValuePerCost =>
$args->{currentModelAttributedConversionsValuePerCost},
eligibleImpressionsFromLocationAssetStoreReach =>
$args->{eligibleImpressionsFromLocationAssetStoreReach},
engagementRate => $args->{engagementRate},
engagements => $args->{engagements},
generalInvalidClickRate => $args->{generalInvalidClickRate},
generalInvalidClicks => $args->{generalInvalidClicks},
gmailForwards => $args->{gmailForwards},
gmailSaves => $args->{gmailSaves},
gmailSecondaryClicks => $args->{gmailSecondaryClicks},
grossProfitMargin => $args->{grossProfitMargin},
grossProfitMicros => $args->{grossProfitMicros},
historicalCreativeQualityScore => $args->{historicalCreativeQualityScore},
historicalLandingPageQualityScore =>
$args->{historicalLandingPageQualityScore},
historicalQualityScore => $args->{historicalQualityScore},
historicalSearchPredictedCtr => $args->{historicalSearchPredictedCtr},
hotelAverageLeadValueMicros => $args->{hotelAverageLeadValueMicros},
hotelCommissionRateMicros => $args->{hotelCommissionRateMicros},
hotelEligibleImpressions => $args->{hotelEligibleImpressions},
hotelExpectedCommissionCost => $args->{hotelExpectedCommissionCost},
hotelPriceDifferencePercentage => $args->{hotelPriceDifferencePercentage},
impressions => $args->{impressions},
impressionsFromStoreReach => $args->{impressionsFromStoreReach},
interactionEventTypes => $args->{interactionEventTypes},
interactionRate => $args->{interactionRate},
interactions => $args->{interactions},
invalidClickRate => $args->{invalidClickRate},
invalidClicks => $args->{invalidClicks},
leadCostOfGoodsSoldMicros => $args->{leadCostOfGoodsSoldMicros},
leadGrossProfitMicros => $args->{leadGrossProfitMicros},
leadRevenueMicros => $args->{leadRevenueMicros},
leadUnitsSold => $args->{leadUnitsSold},
linkedEntitiesCount => $args->{linkedEntitiesCount},
linkedSampleEntities => $args->{linkedSampleEntities},
messageChatRate => $args->{messageChatRate},
messageChats => $args->{messageChats},
messageImpressions => $args->{messageImpressions},
mobileFriendlyClicksPercentage => $args->{mobileFriendlyClicksPercentage},
newCustomerLifetimeValue => $args->{newCustomerLifetimeValue},
optimizationScoreUplift => $args->{optimizationScoreUplift},
optimizationScoreUrl => $args->{optimizationScoreUrl},
orders => $args->{orders},
organicClicks => $args->{organicClicks},
organicClicksPerQuery => $args->{organicClicksPerQuery},
organicImpressions => $args->{organicImpressions},
organicImpressionsPerQuery => $args->{organicImpressionsPerQuery},
organicQueries => $args->{organicQueries},
percentNewVisitors => $args->{percentNewVisitors},
phoneCalls => $args->{phoneCalls},
phoneImpressions => $args->{phoneImpressions},
phoneThroughRate => $args->{phoneThroughRate},
platformComparableConversions => $args->{platformComparableConversions},
platformComparableConversionsByConversionDate =>
$args->{platformComparableConversionsByConversionDate},
platformComparableConversionsFromInteractionsRate =>
$args->{platformComparableConversionsFromInteractionsRate},
platformComparableConversionsFromInteractionsValuePerInteraction =>
$args->{platformComparableConversionsFromInteractionsValuePerInteraction},
platformComparableConversionsValue =>
$args->{platformComparableConversionsValue},
platformComparableConversionsValueByConversionDate =>
$args->{platformComparableConversionsValueByConversionDate},
platformComparableConversionsValuePerCost =>
$args->{platformComparableConversionsValuePerCost},
primaryImpressions => $args->{primaryImpressions},
publisherOrganicClicks => $args->{publisherOrganicClicks},
publisherPurchasedClicks => $args->{publisherPurchasedClicks},
publisherUnknownClicks => $args->{publisherUnknownClicks},
relativeCtr => $args->{relativeCtr},
resultsConversionsPurchase => $args->{resultsConversionsPurchase},
revenueMicros => $args->{revenueMicros},
sampleBestPerformanceEntities => $args->{sampleBestPerformanceEntities},
sampleGoodPerformanceEntities => $args->{sampleGoodPerformanceEntities},
sampleLearningPerformanceEntities =>
$args->{sampleLearningPerformanceEntities},
sampleLowPerformanceEntities => $args->{sampleLowPerformanceEntities},
sampleUnratedPerformanceEntities =>
$args->{sampleUnratedPerformanceEntities},
searchAbsoluteTopImpressionShare =>
$args->{searchAbsoluteTopImpressionShare},
searchBudgetLostAbsoluteTopImpressionShare =>
$args->{searchBudgetLostAbsoluteTopImpressionShare},
searchBudgetLostImpressionShare => $args->{searchBudgetLostImpressionShare},
searchBudgetLostTopImpressionShare =>
$args->{searchBudgetLostTopImpressionShare},
searchClickShare => $args->{searchClickShare},
searchExactMatchImpressionShare => $args->{searchExactMatchImpressionShare},
searchImpressionShare => $args->{searchImpressionShare},
searchRankLostAbsoluteTopImpressionShare =>
$args->{searchRankLostAbsoluteTopImpressionShare},
searchRankLostImpressionShare => $args->{searchRankLostImpressionShare},
searchRankLostTopImpressionShare =>
$args->{searchRankLostTopImpressionShare},
searchTopImpressionShare => $args->{searchTopImpressionShare},
searchVolume => $args->{searchVolume},
skAdNetworkInstalls => $args->{skAdNetworkInstalls},
skAdNetworkTotalConversions => $args->{skAdNetworkTotalConversions},
speedScore => $args->{speedScore},
storeVisitsLastClickModelAttributedConversions =>
$args->{storeVisitsLastClickModelAttributedConversions},
topImpressionPercentage => $args->{topImpressionPercentage},
uniqueUsers => $args->{uniqueUsers},
unitsSold => $args->{unitsSold},
validAcceleratedMobilePagesClicksPercentage =>
$args->{validAcceleratedMobilePagesClicksPercentage},
valuePerAllConversions => $args->{valuePerAllConversions},
valuePerAllConversionsByConversionDate =>
$args->{valuePerAllConversionsByConversionDate},
valuePerConversion => $args->{valuePerConversion},
valuePerConversionsByConversionDate =>
$args->{valuePerConversionsByConversionDate},
valuePerCurrentModelAttributedConversion =>
$args->{valuePerCurrentModelAttributedConversion},
valuePerPlatformComparableConversion =>
$args->{valuePerPlatformComparableConversion},
valuePerPlatformComparableConversionsByConversionDate =>
$args->{valuePerPlatformComparableConversionsByConversionDate},
videoQuartileP100Rate => $args->{videoQuartileP100Rate},
videoQuartileP25Rate => $args->{videoQuartileP25Rate},
videoQuartileP50Rate => $args->{videoQuartileP50Rate},
videoQuartileP75Rate => $args->{videoQuartileP75Rate},
videoViewRate => $args->{videoViewRate},
videoViewRateInFeed => $args->{videoViewRateInFeed},
videoViewRateInStream => $args->{videoViewRateInStream},
videoViewRateShorts => $args->{videoViewRateShorts},
videoViews => $args->{videoViews},
viewThroughConversions => $args->{viewThroughConversions},
viewThroughConversionsFromLocationAssetClickToCall =>
$args->{viewThroughConversionsFromLocationAssetClickToCall},
viewThroughConversionsFromLocationAssetDirections =>
$args->{viewThroughConversionsFromLocationAssetDirections},
viewThroughConversionsFromLocationAssetMenu =>
$args->{viewThroughConversionsFromLocationAssetMenu},
viewThroughConversionsFromLocationAssetOrder =>
$args->{viewThroughConversionsFromLocationAssetOrder},
viewThroughConversionsFromLocationAssetOtherEngagement =>
$args->{viewThroughConversionsFromLocationAssetOtherEngagement},
viewThroughConversionsFromLocationAssetStoreVisits =>
$args->{viewThroughConversionsFromLocationAssetStoreVisits},
viewThroughConversionsFromLocationAssetWebsite =>
$args->{viewThroughConversionsFromLocationAssetWebsite}};
# Delete the unassigned fields in this object for a more concise JSON payload
remove_unassigned_fields($self, $args);
bless $self, $class;
return $self;
}
1;