File Coverage

blib/lib/Google/Ads/AdWords/Constants.pm

Criterion	Covered	Total	%
statement	57	57	100.0
branch			n/a
condition			n/a
subroutine	19	19	100.0
pod			n/a
total	76	76	100.0

# Copyright 2011, Google Inc. All Rights Reserved.
#
# 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.
#
# Module to store package-level constants and default values.

package Google::Ads::AdWords::Constants;

use strict;
use warnings;
use version;

use File::HomeDir;
use File::Spec::Functions;

# Main version number that the rest of the modules pick up off of.
our $VERSION = qv("4.18.0");

use constant DEFAULT_PROPERTIES_FILE =>
  catfile(File::HomeDir->my_home, "adwords.properties");
use constant DEFAULT_USER_AGENT => "unknown";

# In this format string, the first %s is the URL prefix, the second is the
# version, and the third is service name.
use constant PROXY_FORMAT_STRING => "%s/api/adwords/%s/%s/%s";

# Default current version used if the client is created without the version
# parameter.
use constant DEFAULT_VERSION => "v201708";

# Default alternate URL that points to production servers.
use constant DEFAULT_ALTERNATE_URL => "https://adwords.google.com";

# Default validation header value passed to the servers.
use constant DEFAULT_VALIDATE_ONLY => "false";

# Default OAuth scope for AdWords
use constant DEFAULT_OAUTH_SCOPE => "https://www.googleapis.com/auth/adwords";

# Maximum number of request stats to keep in memory, any overflow will result
# on droppping older requests stats out of memory.
use constant MAX_NUM_OF_REQUEST_STATS => 500;

# Mapping of services to namespace group, required to figure out the service
# url endpoints.
our %SERVICE_TO_GROUP = (
  AccountLabelService             => "mcm",
  AdCustomizerFeedService         => "cm",
  AdGroupAdService                => "cm",
  AdGroupBidModifierService       => "cm",
  AdGroupCriterionService         => "cm",
  AdGroupExtensionSettingService  => "cm",
  AdGroupFeedService              => "cm",
  AdGroupService                  => "cm",
  AdParamService                  => "cm",
  AdwordsUserListService          => "rm",
  AlertService                    => "mcm",
  BatchJobService                 => 'cm',
  BiddingStrategyService          => "cm",
  BudgetOrderService              => "billing",
  BudgetService                   => "cm",
  CampaignAdExtensionService      => "cm",
  CampaignBidModifierService      => "cm",
  CampaignCriterionService        => "cm",
  CampaignExtensionSettingService => "cm",
  CampaignFeedService             => "cm",
  CampaignGroupService            => "cm",
  CampaignGroupPerformanceTargetService => "cm",
  CampaignService                 => "cm",
  CampaignSharedSetService        => "cm",
  ConstantDataService             => "cm",
  ConversionTrackerService        => "cm",
  CustomerService                 => "mcm",
  CustomerExtensionSettingService => "cm",
  CustomerFeedService             => "cm",
  CustomerSyncService             => "ch",
  CustomerNegativeCriterionService => "cm",
  DataService                     => "cm",
  DraftAsyncErrorService          => "cm",
  DraftService                    => "cm",
  ExperimentService               => "cm",
  FeedItemService                 => "cm",
  FeedMappingService              => "cm",
  FeedService                     => "cm",
  GeoLocationService              => "cm",
  LabelService                    => "cm",
  LocationCriterionService        => "cm",
  ManagedCustomerService          => "mcm",
  MediaService                    => "cm",
  OfflineCallConversionFeedService => "cm",
  OfflineConversionFeedService    => "cm",
  OfflineDataUploadService        => "rm",
  ReportDefinitionService         => "cm",
  SharedCriterionService          => "cm",
  SharedSetService                => "cm",
  TargetingIdeaService            => "o",
  TrafficEstimatorService         => "o",
  TrialAsyncErrorService          => "cm",
  TrialService                    => "cm"
);

# Useful constant to translate micros to dollars and viceversa.
use constant MICROS_PER_DOLLAR => 1000000;

########## Reporting Utilities ##########

use constant ADHOC_REPORT_DOWNLOAD_URL => "%s/api/adwords/reportdownload/%s";
use constant LWP_DEFAULT_TIMEOUT => 300;    # 5 minutes.
use constant REPORT_SCRUBBED_HEADERS => qw(DeveloperToken Authorization);

########## Paging Utilities ##########

# A default number of entries to be retrieved per page.
use constant DEFAULT_PAGE_SIZE => 100;

# Regular expression representing the LIMIT portion of an AWQL query.
# Group 1 => The SELECT clause before LIMIT
# Group 2 => Offset defined by LIMIT
# Group 3 => Page Size defined by LIMIT
# Example: LIMIT 1,3
use constant QUERY_LIMIT_REGEX => qr/(.*)LIMIT\s+(\d+)\s*,\s*(\d+).*/;

return 1;