google-api-ruby-client/generated/google/apis/adsense_v1_4/classes.rb

1281 lines
45 KiB
Ruby
Raw Normal View History

2015-06-23 23:05:46 +00:00
# Copyright 2015 Google Inc.
#
# 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.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module AdsenseV1_4
#
class Account
include Google::Apis::Core::Hashable
2015-12-03 01:10:07 +00:00
#
# Corresponds to the JSON property `creation_time`
# @return [String]
attr_accessor :creation_time
2015-06-23 23:05:46 +00:00
# Unique identifier of this account.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#account.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Name of this account.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Whether this account is premium.
# Corresponds to the JSON property `premium`
# @return [Boolean]
attr_accessor :premium
alias_method :premium?, :premium
# Sub accounts of the this account.
# Corresponds to the JSON property `subAccounts`
# @return [Array<Google::Apis::AdsenseV1_4::Account>]
attr_accessor :sub_accounts
# AdSense timezone of this account.
# Corresponds to the JSON property `timezone`
# @return [String]
attr_accessor :timezone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@creation_time = args[:creation_time] if args.key?(:creation_time)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@premium = args[:premium] if args.key?(:premium)
@sub_accounts = args[:sub_accounts] if args.key?(:sub_accounts)
@timezone = args[:timezone] if args.key?(:timezone)
2015-06-23 23:05:46 +00:00
end
end
#
class Accounts
include Google::Apis::Core::Hashable
# ETag of this response for caching purposes.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# The accounts returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::Account>]
attr_accessor :items
# Kind of list this is, in this case adsense#accounts.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Continuation token used to page through accounts. To retrieve the next page of
# results, set the next request's "pageToken" value to this.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2015-06-23 23:05:46 +00:00
end
end
#
class AdClient
include Google::Apis::Core::Hashable
# Whether this ad client is opted in to ARC.
# Corresponds to the JSON property `arcOptIn`
# @return [Boolean]
attr_accessor :arc_opt_in
alias_method :arc_opt_in?, :arc_opt_in
# Unique identifier of this ad client.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#adClient.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# This ad client's product code, which corresponds to the PRODUCT_CODE report
# dimension.
# Corresponds to the JSON property `productCode`
# @return [String]
attr_accessor :product_code
# Whether this ad client supports being reported on.
# Corresponds to the JSON property `supportsReporting`
# @return [Boolean]
attr_accessor :supports_reporting
alias_method :supports_reporting?, :supports_reporting
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@arc_opt_in = args[:arc_opt_in] if args.key?(:arc_opt_in)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@product_code = args[:product_code] if args.key?(:product_code)
@supports_reporting = args[:supports_reporting] if args.key?(:supports_reporting)
2015-06-23 23:05:46 +00:00
end
end
#
class AdClients
include Google::Apis::Core::Hashable
# ETag of this response for caching purposes.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# The ad clients returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::AdClient>]
attr_accessor :items
# Kind of list this is, in this case adsense#adClients.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Continuation token used to page through ad clients. To retrieve the next page
# of results, set the next request's "pageToken" value to this.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2015-06-23 23:05:46 +00:00
end
end
#
class AdCode
include Google::Apis::Core::Hashable
# The ad code snippet.
# Corresponds to the JSON property `adCode`
# @return [String]
attr_accessor :ad_code
# Kind this is, in this case adsense#adCode.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@ad_code = args[:ad_code] if args.key?(:ad_code)
@kind = args[:kind] if args.key?(:kind)
2015-06-23 23:05:46 +00:00
end
end
#
class AdStyle
include Google::Apis::Core::Hashable
# The colors which are included in the style. These are represented as six
# hexadecimal characters, similar to HTML color codes, but without the leading
# hash.
# Corresponds to the JSON property `colors`
# @return [Google::Apis::AdsenseV1_4::AdStyle::Colors]
attr_accessor :colors
# The style of the corners in the ad.
# Corresponds to the JSON property `corners`
# @return [String]
attr_accessor :corners
# The font which is included in the style.
# Corresponds to the JSON property `font`
# @return [Google::Apis::AdsenseV1_4::AdStyle::Font]
attr_accessor :font
# Kind this is, in this case adsense#adStyle.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@colors = args[:colors] if args.key?(:colors)
@corners = args[:corners] if args.key?(:corners)
@font = args[:font] if args.key?(:font)
@kind = args[:kind] if args.key?(:kind)
2015-06-23 23:05:46 +00:00
end
# The colors which are included in the style. These are represented as six
# hexadecimal characters, similar to HTML color codes, but without the leading
# hash.
class Colors
include Google::Apis::Core::Hashable
# The color of the ad background.
# Corresponds to the JSON property `background`
# @return [String]
attr_accessor :background
# The color of the ad border.
# Corresponds to the JSON property `border`
# @return [String]
attr_accessor :border
# The color of the ad text.
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
# The color of the ad title.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# The color of the ad url.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@background = args[:background] if args.key?(:background)
@border = args[:border] if args.key?(:border)
@text = args[:text] if args.key?(:text)
@title = args[:title] if args.key?(:title)
@url = args[:url] if args.key?(:url)
2015-06-23 23:05:46 +00:00
end
end
# The font which is included in the style.
class Font
include Google::Apis::Core::Hashable
# The family of the font.
# Corresponds to the JSON property `family`
# @return [String]
attr_accessor :family
# The size of the font.
# Corresponds to the JSON property `size`
# @return [String]
attr_accessor :size
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@family = args[:family] if args.key?(:family)
@size = args[:size] if args.key?(:size)
2015-06-23 23:05:46 +00:00
end
end
end
#
class AdUnit
include Google::Apis::Core::Hashable
# Identity code of this ad unit, not necessarily unique across ad clients.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
2016-01-29 22:32:46 +00:00
# Settings specific to content ads (AFC) and highend mobile content ads (AFMC -
# deprecated).
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `contentAdsSettings`
# @return [Google::Apis::AdsenseV1_4::AdUnit::ContentAdsSettings]
attr_accessor :content_ads_settings
# Custom style information specific to this ad unit.
# Corresponds to the JSON property `customStyle`
# @return [Google::Apis::AdsenseV1_4::AdStyle]
attr_accessor :custom_style
2016-01-29 22:32:46 +00:00
# Settings specific to feed ads (AFF) - deprecated.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `feedAdsSettings`
# @return [Google::Apis::AdsenseV1_4::AdUnit::FeedAdsSettings]
attr_accessor :feed_ads_settings
# Unique identifier of this ad unit. This should be considered an opaque
# identifier; it is not safe to rely on it being in any particular format.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#adUnit.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
2016-01-29 22:32:46 +00:00
# Settings specific to WAP mobile content ads (AFMC) - deprecated.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `mobileContentAdsSettings`
# @return [Google::Apis::AdsenseV1_4::AdUnit::MobileContentAdsSettings]
attr_accessor :mobile_content_ads_settings
# Name of this ad unit.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# ID of the saved ad style which holds this ad unit's style information.
# Corresponds to the JSON property `savedStyleId`
# @return [String]
attr_accessor :saved_style_id
# Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and
# does not yet have any activity associated with it.
# ACTIVE: Indicates that there has been activity on this ad unit in the last
# seven days.
# INACTIVE: Indicates that there has been no activity on this ad unit in the
# last seven days.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@code = args[:code] if args.key?(:code)
@content_ads_settings = args[:content_ads_settings] if args.key?(:content_ads_settings)
@custom_style = args[:custom_style] if args.key?(:custom_style)
@feed_ads_settings = args[:feed_ads_settings] if args.key?(:feed_ads_settings)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@mobile_content_ads_settings = args[:mobile_content_ads_settings] if args.key?(:mobile_content_ads_settings)
@name = args[:name] if args.key?(:name)
@saved_style_id = args[:saved_style_id] if args.key?(:saved_style_id)
@status = args[:status] if args.key?(:status)
2015-06-23 23:05:46 +00:00
end
2016-01-29 22:32:46 +00:00
# Settings specific to content ads (AFC) and highend mobile content ads (AFMC -
# deprecated).
2015-06-23 23:05:46 +00:00
class ContentAdsSettings
include Google::Apis::Core::Hashable
# The backup option to be used in instances where no ad is available.
# Corresponds to the JSON property `backupOption`
# @return [Google::Apis::AdsenseV1_4::AdUnit::ContentAdsSettings::BackupOption]
attr_accessor :backup_option
# Size of this ad unit.
# Corresponds to the JSON property `size`
# @return [String]
attr_accessor :size
# Type of this ad unit.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@backup_option = args[:backup_option] if args.key?(:backup_option)
@size = args[:size] if args.key?(:size)
@type = args[:type] if args.key?(:type)
2015-06-23 23:05:46 +00:00
end
# The backup option to be used in instances where no ad is available.
class BackupOption
include Google::Apis::Core::Hashable
# Color to use when type is set to COLOR.
# Corresponds to the JSON property `color`
# @return [String]
attr_accessor :color
# Type of the backup option. Possible values are BLANK, COLOR and URL.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# URL to use when type is set to URL.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@color = args[:color] if args.key?(:color)
@type = args[:type] if args.key?(:type)
@url = args[:url] if args.key?(:url)
2015-06-23 23:05:46 +00:00
end
end
end
2016-01-29 22:32:46 +00:00
# Settings specific to feed ads (AFF) - deprecated.
2015-06-23 23:05:46 +00:00
class FeedAdsSettings
include Google::Apis::Core::Hashable
# The position of the ads relative to the feed entries.
# Corresponds to the JSON property `adPosition`
# @return [String]
attr_accessor :ad_position
# The frequency at which ads should appear in the feed (i.e. every N entries).
# Corresponds to the JSON property `frequency`
# @return [Fixnum]
attr_accessor :frequency
# The minimum length an entry should be in order to have attached ads.
# Corresponds to the JSON property `minimumWordCount`
# @return [Fixnum]
attr_accessor :minimum_word_count
# The type of ads which should appear.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@ad_position = args[:ad_position] if args.key?(:ad_position)
@frequency = args[:frequency] if args.key?(:frequency)
@minimum_word_count = args[:minimum_word_count] if args.key?(:minimum_word_count)
@type = args[:type] if args.key?(:type)
2015-06-23 23:05:46 +00:00
end
end
2016-01-29 22:32:46 +00:00
# Settings specific to WAP mobile content ads (AFMC) - deprecated.
2015-06-23 23:05:46 +00:00
class MobileContentAdsSettings
include Google::Apis::Core::Hashable
# The markup language to use for this ad unit.
# Corresponds to the JSON property `markupLanguage`
# @return [String]
attr_accessor :markup_language
# The scripting language to use for this ad unit.
# Corresponds to the JSON property `scriptingLanguage`
# @return [String]
attr_accessor :scripting_language
# Size of this ad unit.
# Corresponds to the JSON property `size`
# @return [String]
attr_accessor :size
# Type of this ad unit.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@markup_language = args[:markup_language] if args.key?(:markup_language)
@scripting_language = args[:scripting_language] if args.key?(:scripting_language)
@size = args[:size] if args.key?(:size)
@type = args[:type] if args.key?(:type)
2015-06-23 23:05:46 +00:00
end
end
end
#
class AdUnits
include Google::Apis::Core::Hashable
# ETag of this response for caching purposes.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# The ad units returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::AdUnit>]
attr_accessor :items
# Kind of list this is, in this case adsense#adUnits.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Continuation token used to page through ad units. To retrieve the next page of
# results, set the next request's "pageToken" value to this.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2015-06-23 23:05:46 +00:00
end
end
#
class GenerateReportResponse
include Google::Apis::Core::Hashable
# The averages of the report. This is the same length as any other row in the
# report; cells corresponding to dimension columns are empty.
# Corresponds to the JSON property `averages`
# @return [Array<String>]
attr_accessor :averages
# The requested end date in yyyy-mm-dd format.
# Corresponds to the JSON property `endDate`
# @return [String]
attr_accessor :end_date
# The header information of the columns requested in the report. This is a list
# of headers; one for each dimension in the request, followed by one for each
# metric in the request.
# Corresponds to the JSON property `headers`
# @return [Array<Google::Apis::AdsenseV1_4::GenerateReportResponse::Header>]
attr_accessor :headers
# Kind this is, in this case adsense#report.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The output rows of the report. Each row is a list of cells; one for each
# dimension in the request, followed by one for each metric in the request. The
# dimension cells contain strings, and the metric cells contain numbers.
# Corresponds to the JSON property `rows`
# @return [Array<Array<String>>]
attr_accessor :rows
# The requested start date in yyyy-mm-dd format.
# Corresponds to the JSON property `startDate`
# @return [String]
attr_accessor :start_date
# The total number of rows matched by the report request. Fewer rows may be
# returned in the response due to being limited by the row count requested or
# the report row limit.
# Corresponds to the JSON property `totalMatchedRows`
# @return [String]
attr_accessor :total_matched_rows
# The totals of the report. This is the same length as any other row in the
# report; cells corresponding to dimension columns are empty.
# Corresponds to the JSON property `totals`
# @return [Array<String>]
attr_accessor :totals
# Any warnings associated with generation of the report.
# Corresponds to the JSON property `warnings`
# @return [Array<String>]
attr_accessor :warnings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@averages = args[:averages] if args.key?(:averages)
@end_date = args[:end_date] if args.key?(:end_date)
@headers = args[:headers] if args.key?(:headers)
@kind = args[:kind] if args.key?(:kind)
@rows = args[:rows] if args.key?(:rows)
@start_date = args[:start_date] if args.key?(:start_date)
@total_matched_rows = args[:total_matched_rows] if args.key?(:total_matched_rows)
@totals = args[:totals] if args.key?(:totals)
@warnings = args[:warnings] if args.key?(:warnings)
2015-06-23 23:05:46 +00:00
end
#
class Header
include Google::Apis::Core::Hashable
# The currency of this column. Only present if the header type is
# METRIC_CURRENCY.
# Corresponds to the JSON property `currency`
# @return [String]
attr_accessor :currency
# The name of the header.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or
# METRIC_CURRENCY.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@currency = args[:currency] if args.key?(:currency)
@name = args[:name] if args.key?(:name)
@type = args[:type] if args.key?(:type)
2015-06-23 23:05:46 +00:00
end
end
end
#
class Alert
include Google::Apis::Core::Hashable
# Unique identifier of this alert. This should be considered an opaque
# identifier; it is not safe to rely on it being in any particular format.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Whether this alert can be dismissed.
# Corresponds to the JSON property `isDismissible`
# @return [Boolean]
attr_accessor :is_dismissible
alias_method :is_dismissible?, :is_dismissible
# Kind of resource this is, in this case adsense#alert.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The localized alert message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
# Severity of this alert. Possible values: INFO, WARNING, SEVERE.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3,
# ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY,
# GRAYLISTED_PUBLISHER, API_HOLD.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@id = args[:id] if args.key?(:id)
@is_dismissible = args[:is_dismissible] if args.key?(:is_dismissible)
@kind = args[:kind] if args.key?(:kind)
@message = args[:message] if args.key?(:message)
@severity = args[:severity] if args.key?(:severity)
@type = args[:type] if args.key?(:type)
2015-06-23 23:05:46 +00:00
end
end
#
class Alerts
include Google::Apis::Core::Hashable
# The alerts returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::Alert>]
attr_accessor :items
# Kind of list this is, in this case adsense#alerts.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
2015-06-23 23:05:46 +00:00
end
end
#
class CustomChannel
include Google::Apis::Core::Hashable
# Code of this custom channel, not necessarily unique across ad clients.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# Unique identifier of this custom channel. This should be considered an opaque
# identifier; it is not safe to rely on it being in any particular format.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#customChannel.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Name of this custom channel.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The targeting information of this custom channel, if activated.
# Corresponds to the JSON property `targetingInfo`
# @return [Google::Apis::AdsenseV1_4::CustomChannel::TargetingInfo]
attr_accessor :targeting_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@code = args[:code] if args.key?(:code)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@targeting_info = args[:targeting_info] if args.key?(:targeting_info)
2015-06-23 23:05:46 +00:00
end
# The targeting information of this custom channel, if activated.
class TargetingInfo
include Google::Apis::Core::Hashable
# The name used to describe this channel externally.
# Corresponds to the JSON property `adsAppearOn`
# @return [String]
attr_accessor :ads_appear_on
# The external description of the channel.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The locations in which ads appear. (Only valid for content and mobile content
2016-01-29 22:32:46 +00:00
# ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER,
# TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT,
# BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile
# content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
2015-06-23 23:05:46 +00:00
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# The language of the sites ads will be displayed on.
# Corresponds to the JSON property `siteLanguage`
# @return [String]
attr_accessor :site_language
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@ads_appear_on = args[:ads_appear_on] if args.key?(:ads_appear_on)
@description = args[:description] if args.key?(:description)
@location = args[:location] if args.key?(:location)
@site_language = args[:site_language] if args.key?(:site_language)
2015-06-23 23:05:46 +00:00
end
end
end
#
class CustomChannels
include Google::Apis::Core::Hashable
# ETag of this response for caching purposes.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# The custom channels returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::CustomChannel>]
attr_accessor :items
# Kind of list this is, in this case adsense#customChannels.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Continuation token used to page through custom channels. To retrieve the next
# page of results, set the next request's "pageToken" value to this.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2015-06-23 23:05:46 +00:00
end
end
#
class Metadata
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::ReportingMetadataEntry>]
attr_accessor :items
# Kind of list this is, in this case adsense#metadata.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
2015-06-23 23:05:46 +00:00
end
end
#
class Payment
include Google::Apis::Core::Hashable
# Unique identifier of this Payment.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#payment.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The amount to be paid.
# Corresponds to the JSON property `paymentAmount`
# @return [String]
attr_accessor :payment_amount
# The currency code for the amount to be paid.
# Corresponds to the JSON property `paymentAmountCurrencyCode`
# @return [String]
attr_accessor :payment_amount_currency_code
# The date this payment was/will be credited to the user, or none if the payment
# threshold has not been met.
# Corresponds to the JSON property `paymentDate`
# @return [String]
attr_accessor :payment_date
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@payment_amount = args[:payment_amount] if args.key?(:payment_amount)
@payment_amount_currency_code = args[:payment_amount_currency_code] if args.key?(:payment_amount_currency_code)
@payment_date = args[:payment_date] if args.key?(:payment_date)
2015-06-23 23:05:46 +00:00
end
end
#
class Payments
include Google::Apis::Core::Hashable
# The list of Payments for the account. One or both of a) the account's most
# recent payment; and b) the account's upcoming payment.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::Payment>]
attr_accessor :items
# Kind of list this is, in this case adsense#payments.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
2015-06-23 23:05:46 +00:00
end
end
#
class ReportingMetadataEntry
include Google::Apis::Core::Hashable
# For metrics this is a list of dimension IDs which the metric is compatible
# with, for dimensions it is a list of compatibility groups the dimension
# belongs to.
# Corresponds to the JSON property `compatibleDimensions`
# @return [Array<String>]
attr_accessor :compatible_dimensions
# The names of the metrics the dimension or metric this reporting metadata entry
# describes is compatible with.
# Corresponds to the JSON property `compatibleMetrics`
# @return [Array<String>]
attr_accessor :compatible_metrics
# Unique identifier of this reporting metadata entry, corresponding to the name
# of the appropriate dimension or metric.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#reportingMetadataEntry.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The names of the dimensions which the dimension or metric this reporting
# metadata entry describes requires to also be present in order for the report
# to be valid. Omitting these will not cause an error or warning, but may result
# in data which cannot be correctly interpreted.
# Corresponds to the JSON property `requiredDimensions`
# @return [Array<String>]
attr_accessor :required_dimensions
# The names of the metrics which the dimension or metric this reporting metadata
# entry describes requires to also be present in order for the report to be
# valid. Omitting these will not cause an error or warning, but may result in
# data which cannot be correctly interpreted.
# Corresponds to the JSON property `requiredMetrics`
# @return [Array<String>]
attr_accessor :required_metrics
# The codes of the projects supported by the dimension or metric this reporting
# metadata entry describes.
# Corresponds to the JSON property `supportedProducts`
# @return [Array<String>]
attr_accessor :supported_products
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@compatible_dimensions = args[:compatible_dimensions] if args.key?(:compatible_dimensions)
@compatible_metrics = args[:compatible_metrics] if args.key?(:compatible_metrics)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@required_dimensions = args[:required_dimensions] if args.key?(:required_dimensions)
@required_metrics = args[:required_metrics] if args.key?(:required_metrics)
@supported_products = args[:supported_products] if args.key?(:supported_products)
2015-06-23 23:05:46 +00:00
end
end
#
class SavedAdStyle
include Google::Apis::Core::Hashable
# The AdStyle itself.
# Corresponds to the JSON property `adStyle`
# @return [Google::Apis::AdsenseV1_4::AdStyle]
attr_accessor :ad_style
# Unique identifier of this saved ad style. This should be considered an opaque
# identifier; it is not safe to rely on it being in any particular format.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#savedAdStyle.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The user selected name of this SavedAdStyle.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@ad_style = args[:ad_style] if args.key?(:ad_style)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
2015-06-23 23:05:46 +00:00
end
end
#
class SavedAdStyles
include Google::Apis::Core::Hashable
# ETag of this response for caching purposes.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# The saved ad styles returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::SavedAdStyle>]
attr_accessor :items
# Kind of list this is, in this case adsense#savedAdStyles.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Continuation token used to page through ad units. To retrieve the next page of
# results, set the next request's "pageToken" value to this.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2015-06-23 23:05:46 +00:00
end
end
#
class SavedReport
include Google::Apis::Core::Hashable
# Unique identifier of this saved report.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#savedReport.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# This saved report's name.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
2015-06-23 23:05:46 +00:00
end
end
#
class SavedReports
include Google::Apis::Core::Hashable
# ETag of this response for caching purposes.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# The saved reports returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::SavedReport>]
attr_accessor :items
# Kind of list this is, in this case adsense#savedReports.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Continuation token used to page through saved reports. To retrieve the next
# page of results, set the next request's "pageToken" value to this.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2015-06-23 23:05:46 +00:00
end
end
#
class UrlChannel
include Google::Apis::Core::Hashable
# Unique identifier of this URL channel. This should be considered an opaque
# identifier; it is not safe to rely on it being in any particular format.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adsense#urlChannel.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# URL Pattern of this URL channel. Does not include "http://" or "https://".
# Example: www.example.com/home
# Corresponds to the JSON property `urlPattern`
# @return [String]
attr_accessor :url_pattern
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@url_pattern = args[:url_pattern] if args.key?(:url_pattern)
2015-06-23 23:05:46 +00:00
end
end
#
class UrlChannels
include Google::Apis::Core::Hashable
# ETag of this response for caching purposes.
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# The URL channels returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdsenseV1_4::UrlChannel>]
attr_accessor :items
# Kind of list this is, in this case adsense#urlChannels.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Continuation token used to page through URL channels. To retrieve the next
# page of results, set the next request's "pageToken" value to this.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
2016-01-29 22:32:46 +00:00
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2015-06-23 23:05:46 +00:00
end
end
end
end
end