Autogenerated update (2020-07-01)
Update: - cloudidentity_v1beta1 - dataflow_v1b3 - dataproc_v1 - dataproc_v1beta2 - dialogflow_v2 - dialogflow_v2beta1 - managedidentities_v1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - ml_v1
This commit is contained in:
Google APIs committed
1 parent
f136f456ff
commit
fe73ddc884
37 files changed
+1332
-115
No files matched your search
@@ -0,0 +1,306 @@
|
||||
# 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 GmailpostmastertoolsV1beta1
|
||||
|
||||
# Metric on a particular delivery error type.
|
||||
class DeliveryError
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The class of delivery error.
|
||||
# Corresponds to the JSON property `errorClass`
|
||||
# @return [String]
|
||||
attr_accessor :error_class
|
||||
|
||||
# The ratio of messages where the error occurred vs all authenticated
|
||||
# traffic.
|
||||
# Corresponds to the JSON property `errorRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :error_ratio
|
||||
|
||||
# The type of delivery error.
|
||||
# Corresponds to the JSON property `errorType`
|
||||
# @return [String]
|
||||
attr_accessor :error_type
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@error_class = args[:error_class] if args.key?(:error_class)
|
||||
@error_ratio = args[:error_ratio] if args.key?(:error_ratio)
|
||||
@error_type = args[:error_type] if args.key?(:error_type)
|
||||
end
|
||||
end
|
||||
|
||||
# A registered domain resource in the Postmaster API.
|
||||
class Domain
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Timestamp when the user registered this domain. Assigned by
|
||||
# the server.
|
||||
# Corresponds to the JSON property `createTime`
|
||||
# @return [String]
|
||||
attr_accessor :create_time
|
||||
|
||||
# The resource name of the Domain.
|
||||
# Domain names have the form `domains/`domain_name``, where domain_name
|
||||
# is the fully qualified domain name (i.e., mymail.mydomain.com).
|
||||
# Corresponds to the JSON property `name`
|
||||
# @return [String]
|
||||
attr_accessor :name
|
||||
|
||||
# User’s permission for this domain. Assigned by the server.
|
||||
# Corresponds to the JSON property `permission`
|
||||
# @return [String]
|
||||
attr_accessor :permission
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@create_time = args[:create_time] if args.key?(:create_time)
|
||||
@name = args[:name] if args.key?(:name)
|
||||
@permission = args[:permission] if args.key?(:permission)
|
||||
end
|
||||
end
|
||||
|
||||
# [Feedback loop](https://support.google.com/mail/answer/6254652) identifier
|
||||
# information.
|
||||
class FeedbackLoop
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Feedback loop identifier that uniquely identifies individual campaigns.
|
||||
# Corresponds to the JSON property `id`
|
||||
# @return [String]
|
||||
attr_accessor :id
|
||||
|
||||
# The ratio of user marked spam messages with the identifier vs the total
|
||||
# number of inboxed messages with that identifier.
|
||||
# Corresponds to the JSON property `spamRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :spam_ratio
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@id = args[:id] if args.key?(:id)
|
||||
@spam_ratio = args[:spam_ratio] if args.key?(:spam_ratio)
|
||||
end
|
||||
end
|
||||
|
||||
# IP Reputation information for a set of IPs in a specific reputation category.
|
||||
class IpReputation
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Total number of unique IPs in this reputation category. This metric only
|
||||
# pertains to traffic that passed [SPF](http://www.openspf.org/) or
|
||||
# [DKIM](http://www.dkim.org/).
|
||||
# Corresponds to the JSON property `numIps`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :num_ips
|
||||
|
||||
# The reputation category this IP reputation represents.
|
||||
# Corresponds to the JSON property `reputation`
|
||||
# @return [String]
|
||||
attr_accessor :reputation
|
||||
|
||||
# A sample of IPs in this reputation category.
|
||||
# Corresponds to the JSON property `sampleIps`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :sample_ips
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@num_ips = args[:num_ips] if args.key?(:num_ips)
|
||||
@reputation = args[:reputation] if args.key?(:reputation)
|
||||
@sample_ips = args[:sample_ips] if args.key?(:sample_ips)
|
||||
end
|
||||
end
|
||||
|
||||
# Response message for ListDomains.
|
||||
class ListDomainsResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The list of domains.
|
||||
# Corresponds to the JSON property `domains`
|
||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::Domain>]
|
||||
attr_accessor :domains
|
||||
|
||||
# Token to retrieve the next page of results, or empty if there are no
|
||||
# more results in the list.
|
||||
# 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)
|
||||
@domains = args[:domains] if args.key?(:domains)
|
||||
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
||||
end
|
||||
end
|
||||
|
||||
# Response message for ListTrafficStats.
|
||||
class ListTrafficStatsResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Token to retrieve the next page of results, or empty if there are no
|
||||
# more results in the list.
|
||||
# Corresponds to the JSON property `nextPageToken`
|
||||
# @return [String]
|
||||
attr_accessor :next_page_token
|
||||
|
||||
# The list of TrafficStats.
|
||||
# Corresponds to the JSON property `trafficStats`
|
||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats>]
|
||||
attr_accessor :traffic_stats
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
||||
@traffic_stats = args[:traffic_stats] if args.key?(:traffic_stats)
|
||||
end
|
||||
end
|
||||
|
||||
# Email traffic statistics pertaining to a specific date.
|
||||
class TrafficStats
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Delivery errors for the domain. This metric only pertains to traffic that
|
||||
# passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
|
||||
# Corresponds to the JSON property `deliveryErrors`
|
||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError>]
|
||||
attr_accessor :delivery_errors
|
||||
|
||||
# The ratio of mail that successfully authenticated with DKIM vs. all mail
|
||||
# that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed
|
||||
# mail is excluded.
|
||||
# Corresponds to the JSON property `dkimSuccessRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :dkim_success_ratio
|
||||
|
||||
# The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks
|
||||
# vs all mail received from the domain that successfully authenticated with
|
||||
# either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
|
||||
# Corresponds to the JSON property `dmarcSuccessRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :dmarc_success_ratio
|
||||
|
||||
# Reputation of the domain.
|
||||
# Corresponds to the JSON property `domainReputation`
|
||||
# @return [String]
|
||||
attr_accessor :domain_reputation
|
||||
|
||||
# The ratio of incoming mail (to Gmail), that passed secure transport (TLS)
|
||||
# vs all mail received from that domain. This metric only pertains to traffic
|
||||
# that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
|
||||
# Corresponds to the JSON property `inboundEncryptionRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :inbound_encryption_ratio
|
||||
|
||||
# Reputation information pertaining to the IP addresses of the email servers
|
||||
# for the domain. There is exactly one entry for each reputation category
|
||||
# except
|
||||
# REPUTATION_CATEGORY_UNSPECIFIED.
|
||||
# Corresponds to the JSON property `ipReputations`
|
||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::IpReputation>]
|
||||
attr_accessor :ip_reputations
|
||||
|
||||
# The resource name of the traffic statistics. Traffic statistic names have
|
||||
# the form `domains/`domain`/trafficStats/`date``, where
|
||||
# domain_name is the fully qualified domain name (i.e., mymail.mydomain.com)
|
||||
# of the domain this traffic statistics pertains to and date is the date in
|
||||
# yyyymmdd format that these statistics corresponds to.
|
||||
# For example: domains/mymail.mydomain.com/trafficStats/20160807
|
||||
# Corresponds to the JSON property `name`
|
||||
# @return [String]
|
||||
attr_accessor :name
|
||||
|
||||
# The ratio of outgoing mail (from Gmail) that was accepted over secure
|
||||
# transport (TLS).
|
||||
# Corresponds to the JSON property `outboundEncryptionRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :outbound_encryption_ratio
|
||||
|
||||
# Spammy [Feedback loop identifiers]
|
||||
# (https://support.google.com/mail/answer/6254652) with their individual spam
|
||||
# rates. This metric only pertains to traffic that is authenticated by
|
||||
# [DKIM](http://www.dkim.org/).
|
||||
# Corresponds to the JSON property `spammyFeedbackLoops`
|
||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop>]
|
||||
attr_accessor :spammy_feedback_loops
|
||||
|
||||
# The ratio of mail that successfully authenticated with SPF vs. all mail
|
||||
# that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed
|
||||
# mail is excluded.
|
||||
# Corresponds to the JSON property `spfSuccessRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :spf_success_ratio
|
||||
|
||||
# The ratio of user-report spam vs. email that was sent to the inbox. This
|
||||
# metric only pertains to emails authenticated by
|
||||
# [DKIM](http://www.dkim.org/).
|
||||
# Corresponds to the JSON property `userReportedSpamRatio`
|
||||
# @return [Float]
|
||||
attr_accessor :user_reported_spam_ratio
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@delivery_errors = args[:delivery_errors] if args.key?(:delivery_errors)
|
||||
@dkim_success_ratio = args[:dkim_success_ratio] if args.key?(:dkim_success_ratio)
|
||||
@dmarc_success_ratio = args[:dmarc_success_ratio] if args.key?(:dmarc_success_ratio)
|
||||
@domain_reputation = args[:domain_reputation] if args.key?(:domain_reputation)
|
||||
@inbound_encryption_ratio = args[:inbound_encryption_ratio] if args.key?(:inbound_encryption_ratio)
|
||||
@ip_reputations = args[:ip_reputations] if args.key?(:ip_reputations)
|
||||
@name = args[:name] if args.key?(:name)
|
||||
@outbound_encryption_ratio = args[:outbound_encryption_ratio] if args.key?(:outbound_encryption_ratio)
|
||||
@spammy_feedback_loops = args[:spammy_feedback_loops] if args.key?(:spammy_feedback_loops)
|
||||
@spf_success_ratio = args[:spf_success_ratio] if args.key?(:spf_success_ratio)
|
||||
@user_reported_spam_ratio = args[:user_reported_spam_ratio] if args.key?(:user_reported_spam_ratio)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,141 @@
|
||||
# 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 GmailpostmastertoolsV1beta1
|
||||
|
||||
class DeliveryError
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Domain
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class FeedbackLoop
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class IpReputation
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ListDomainsResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ListTrafficStatsResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class TrafficStats
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class DeliveryError
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :error_class, as: 'errorClass'
|
||||
property :error_ratio, as: 'errorRatio'
|
||||
property :error_type, as: 'errorType'
|
||||
end
|
||||
end
|
||||
|
||||
class Domain
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :create_time, as: 'createTime'
|
||||
property :name, as: 'name'
|
||||
property :permission, as: 'permission'
|
||||
end
|
||||
end
|
||||
|
||||
class FeedbackLoop
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :id, as: 'id'
|
||||
property :spam_ratio, as: 'spamRatio'
|
||||
end
|
||||
end
|
||||
|
||||
class IpReputation
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :num_ips, :numeric_string => true, as: 'numIps'
|
||||
property :reputation, as: 'reputation'
|
||||
collection :sample_ips, as: 'sampleIps'
|
||||
end
|
||||
end
|
||||
|
||||
class ListDomainsResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :domains, as: 'domains', class: Google::Apis::GmailpostmastertoolsV1beta1::Domain, decorator: Google::Apis::GmailpostmastertoolsV1beta1::Domain::Representation
|
||||
|
||||
property :next_page_token, as: 'nextPageToken'
|
||||
end
|
||||
end
|
||||
|
||||
class ListTrafficStatsResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :next_page_token, as: 'nextPageToken'
|
||||
collection :traffic_stats, as: 'trafficStats', class: Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats, decorator: Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class TrafficStats
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :delivery_errors, as: 'deliveryErrors', class: Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError, decorator: Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError::Representation
|
||||
|
||||
property :dkim_success_ratio, as: 'dkimSuccessRatio'
|
||||
property :dmarc_success_ratio, as: 'dmarcSuccessRatio'
|
||||
property :domain_reputation, as: 'domainReputation'
|
||||
property :inbound_encryption_ratio, as: 'inboundEncryptionRatio'
|
||||
collection :ip_reputations, as: 'ipReputations', class: Google::Apis::GmailpostmastertoolsV1beta1::IpReputation, decorator: Google::Apis::GmailpostmastertoolsV1beta1::IpReputation::Representation
|
||||
|
||||
property :name, as: 'name'
|
||||
property :outbound_encryption_ratio, as: 'outboundEncryptionRatio'
|
||||
collection :spammy_feedback_loops, as: 'spammyFeedbackLoops', class: Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop, decorator: Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop::Representation
|
||||
|
||||
property :spf_success_ratio, as: 'spfSuccessRatio'
|
||||
property :user_reported_spam_ratio, as: 'userReportedSpamRatio'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,236 @@
|
||||
# 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 '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 GmailpostmastertoolsV1beta1
|
||||
# Gmail Postmaster Tools API
|
||||
#
|
||||
# The Gmail Postmaster API is a RESTful API that provides programmatic access to
|
||||
# email traffic metrics (like spam reports, delivery errors etc) otherwise
|
||||
# available through the Gmail Postmaster Tools UI currently.
|
||||
#
|
||||
# @example
|
||||
# require 'google/apis/gmailpostmastertools_v1beta1'
|
||||
#
|
||||
# Gmailpostmastertools = Google::Apis::GmailpostmastertoolsV1beta1 # Alias the module
|
||||
# service = Gmailpostmastertools::PostmasterToolsService.new
|
||||
#
|
||||
# @see https://developers.google.com/gmail/postmaster
|
||||
class PostmasterToolsService < Google::Apis::Core::BaseService
|
||||
# @return [String]
|
||||
# API key. Your API key identifies your project and provides you with API access,
|
||||
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
||||
attr_accessor :key
|
||||
|
||||
# @return [String]
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
attr_accessor :quota_user
|
||||
|
||||
def initialize
|
||||
super('https://gmailpostmastertools.googleapis.com/', '')
|
||||
@batch_path = 'batch'
|
||||
end
|
||||
|
||||
# Gets a specific domain registered by the client.
|
||||
# Returns NOT_FOUND if the domain does not exist.
|
||||
# @param [String] name
|
||||
# The resource name of the domain. It should have the form
|
||||
# `domains/`domain_name``, where domain_name is the fully qualified
|
||||
# domain name.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::Domain] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::GmailpostmastertoolsV1beta1::Domain]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def get_domain(name, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
||||
command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::Domain::Representation
|
||||
command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::Domain
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Lists the domains that have been registered by the client. The order of
|
||||
# domains in the response is unspecified and non-deterministic. Newly created
|
||||
# domains will not necessarily be added to the end of this list.
|
||||
# @param [Fixnum] page_size
|
||||
# Requested page size. Server may return fewer domains than requested.
|
||||
# If unspecified, server will pick an appropriate default.
|
||||
# @param [String] page_token
|
||||
# The next_page_token value returned from a previous List request, if any.
|
||||
# This is the value of
|
||||
# ListDomainsResponse.next_page_token
|
||||
# returned from the previous call to `ListDomains` method.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def list_domains(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/domains', options)
|
||||
command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse::Representation
|
||||
command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse
|
||||
command.query['pageSize'] = page_size unless page_size.nil?
|
||||
command.query['pageToken'] = page_token unless page_token.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Get traffic statistics for a domain on a specific date.
|
||||
# Returns PERMISSION_DENIED if user does not have permission to access
|
||||
# TrafficStats for the domain.
|
||||
# @param [String] name
|
||||
# The resource name of the traffic statistics to get.
|
||||
# E.g., domains/mymail.mydomain.com/trafficStats/20160807.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def get_domain_traffic_stat(name, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
||||
command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats::Representation
|
||||
command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# List traffic statistics for all available days.
|
||||
# Returns PERMISSION_DENIED if user does not have permission to access
|
||||
# TrafficStats for the domain.
|
||||
# @param [String] parent
|
||||
# The resource name of the domain whose traffic statistics we'd like to list.
|
||||
# It should have the form `domains/`domain_name``, where domain_name is
|
||||
# the fully qualified domain name.
|
||||
# @param [Fixnum] end_date_day
|
||||
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
||||
# if specifying a year by itself or a year and month where the day is not
|
||||
# significant.
|
||||
# @param [Fixnum] end_date_month
|
||||
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a
|
||||
# month and day.
|
||||
# @param [Fixnum] end_date_year
|
||||
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
||||
# a year.
|
||||
# @param [Fixnum] page_size
|
||||
# Requested page size. Server may return fewer TrafficStats than
|
||||
# requested. If unspecified, server will pick an appropriate default.
|
||||
# @param [String] page_token
|
||||
# The next_page_token value returned from a previous List request, if any.
|
||||
# This is the value of
|
||||
# ListTrafficStatsResponse.next_page_token
|
||||
# returned from the previous call to `ListTrafficStats` method.
|
||||
# @param [Fixnum] start_date_day
|
||||
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
||||
# if specifying a year by itself or a year and month where the day is not
|
||||
# significant.
|
||||
# @param [Fixnum] start_date_month
|
||||
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a
|
||||
# month and day.
|
||||
# @param [Fixnum] start_date_year
|
||||
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
||||
# a year.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def list_domain_traffic_stats(parent, end_date_day: nil, end_date_month: nil, end_date_year: nil, page_size: nil, page_token: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/{+parent}/trafficStats', options)
|
||||
command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse::Representation
|
||||
command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse
|
||||
command.params['parent'] = parent unless parent.nil?
|
||||
command.query['endDate.day'] = end_date_day unless end_date_day.nil?
|
||||
command.query['endDate.month'] = end_date_month unless end_date_month.nil?
|
||||
command.query['endDate.year'] = end_date_year unless end_date_year.nil?
|
||||
command.query['pageSize'] = page_size unless page_size.nil?
|
||||
command.query['pageToken'] = page_token unless page_token.nil?
|
||||
command.query['startDate.day'] = start_date_day unless start_date_day.nil?
|
||||
command.query['startDate.month'] = start_date_month unless start_date_month.nil?
|
||||
command.query['startDate.year'] = start_date_year unless start_date_year.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def apply_command_defaults(command)
|
||||
command.query['key'] = key unless key.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in new issue
Block a user