chiu/google-api-ruby-client
1
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Autogenerated update (2018-09-15)

Browse Source 
Delete:
- adexchangeseller_v1
- adexchangeseller_v1_1
- adexchangeseller_v2_0

Update:
- adexchangebuyer2_v2beta1
- admin_directory_v1
- dataproc_v1
- sqladmin_v1beta4
- youtube_partner_v1
This commit is contained in:
Google APIs committed 2018-09-15 00:36:19 +00:00
1 parent 8faa43b9f7
commit ff14c096f5
29 files changed
+5063 -5197
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

generated/google/apis/adexchangebuyer2_v2beta1.rb
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/ad-exchange/buyer-rest/reference/rest/
module Adexchangebuyer2V2beta1
VERSION = 'V2beta1'
REVISION = '20180906'
REVISION = '20180912'
# Manage your Ad Exchange buyer account configuration
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
generated/google/apis/adexchangebuyer2_v2beta1/classes.rb
+1972
View File
File diff suppressed because it is too large. Load diff
generated/google/apis/adexchangebuyer2_v2beta1/representations.rb
+835
View File
File diff suppressed because it is too large. Load diff
generated/google/apis/adexchangebuyer2_v2beta1/service.rb
+604
View File
@@ -839,6 +839,610 @@ module Google
execute_or_queue_command(command, &block)
end
# List finalized proposals, regardless if a proposal is being renegotiated.
# A filter expression (PQL query) may be specified to filter the results.
# The notes will not be returned.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] filter
# An optional PQL filter query used to query for proposals.
# Nested repeated fields, such as proposal.deals.targetingCriterion,
# cannot be filtered.
# @param [String] filter_syntax
# Syntax the filter is written in. Current implementation defaults to PQL
# but in the future it will be LIST_FILTER.
# @param [Fixnum] page_size
# Requested page size. The server may return fewer results than requested.
# If unspecified, the server will pick an appropriate default.
# @param [String] page_token
# The page token as returned from ListProposalsResponse.
# @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::Adexchangebuyer2V2beta1::ListProposalsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse]
#
# @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_account_finalized_proposals(account_id, filter: nil, filter_syntax: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/finalizedProposals', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse
command.params['accountId'] = account_id unless account_id.nil?
command.query['filter'] = filter unless filter.nil?
command.query['filterSyntax'] = filter_syntax unless filter_syntax.nil?
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
# Gets the requested product by ID.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] product_id
# The ID for the product to get the head revision for.
# @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::Adexchangebuyer2V2beta1::Product] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Product]
#
# @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_account_product(account_id, product_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/products/{productId}', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Product::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Product
command.params['accountId'] = account_id unless account_id.nil?
command.params['productId'] = product_id unless product_id.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 all products visible to the buyer (optionally filtered by the
# specified PQL query).
# @param [String] account_id
# Account ID of the buyer.
# @param [String] filter
# An optional PQL query used to query for products. See
# https://developers.google.com/doubleclick-publishers/docs/pqlreference
# for documentation about PQL and examples.
# Nested repeated fields, such as product.targetingCriterion.inclusions,
# cannot be filtered.
# @param [Fixnum] page_size
# Requested page size. The server may return fewer results than requested.
# If unspecified, the server will pick an appropriate default.
# @param [String] page_token
# The page token as returned from ListProductsResponse.
# @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::Adexchangebuyer2V2beta1::ListProductsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::ListProductsResponse]
#
# @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_account_products(account_id, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/products', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListProductsResponse::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListProductsResponse
command.params['accountId'] = account_id unless account_id.nil?
command.query['filter'] = filter unless filter.nil?
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
# Mark the proposal as accepted at the given revision number. If the number
# does not match the server's revision number an `ABORTED` error message will
# be returned. This call updates the proposal_state from `PROPOSED` to
# `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The ID of the proposal to accept.
# @param [Google::Apis::Adexchangebuyer2V2beta1::AcceptProposalRequest] accept_proposal_request_object
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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 accept_proposal(account_id, proposal_id, accept_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:accept', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::AcceptProposalRequest::Representation
command.request_object = accept_proposal_request_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create a new note and attach it to the proposal. The note is assigned
# a unique ID by the server.
# The proposal revision number will not increase when associated with a
# new note.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The ID of the proposal to attach the note to.
# @param [Google::Apis::Adexchangebuyer2V2beta1::AddNoteRequest] add_note_request_object
# @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::Adexchangebuyer2V2beta1::Note] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Note]
#
# @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 add_proposal_note(account_id, proposal_id, add_note_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:addNote', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::AddNoteRequest::Representation
command.request_object = add_note_request_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Note::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Note
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Cancel an ongoing negotiation on a proposal. This does not cancel or end
# serving for the deals if the proposal has been finalized, but only cancels
# a negotiation unilaterally.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The ID of the proposal to cancel negotiation for.
# @param [Google::Apis::Adexchangebuyer2V2beta1::CancelNegotiationRequest] cancel_negotiation_request_object
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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 cancel_proposal_negotiation(account_id, proposal_id, cancel_negotiation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:cancelNegotiation', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::CancelNegotiationRequest::Representation
command.request_object = cancel_negotiation_request_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update the given proposal to indicate that setup has been completed.
# This method is called by the buyer when the line items have been created
# on their end for a finalized proposal and all the required creatives
# have been uploaded using the creatives API. This call updates the
# `is_setup_completed` bit on the proposal and also notifies the seller.
# The server will advance the revision number of the most recent proposal.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The ID of the proposal to mark as setup completed.
# @param [Google::Apis::Adexchangebuyer2V2beta1::CompleteSetupRequest] complete_setup_request_object
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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 complete_proposal_setup(account_id, proposal_id, complete_setup_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:completeSetup', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::CompleteSetupRequest::Representation
command.request_object = complete_setup_request_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Create the given proposal. Each created proposal and any deals it contains
# are assigned a unique ID by the server.
# @param [String] account_id
# Account ID of the buyer.
# @param [Google::Apis::Adexchangebuyer2V2beta1::Proposal] proposal_object
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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 create_account_proposal(account_id, proposal_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.request_object = proposal_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a proposal given its ID. The proposal is returned at its head
# revision.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The unique ID of the proposal
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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_account_proposal(account_id, proposal_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/proposals/{proposalId}', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.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 proposals. A filter expression (PQL query) may be specified to
# filter the results. To retrieve all finalized proposals, regardless if a
# proposal is being renegotiated, see the FinalizedProposals resource.
# Note that Bidder/ChildSeat relationships differ from the usual behavior.
# A Bidder account can only see its child seats' proposals by specifying
# the ChildSeat's accountId in the request path.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] filter
# An optional PQL filter query used to query for proposals.
# Nested repeated fields, such as proposal.deals.targetingCriterion,
# cannot be filtered.
# @param [String] filter_syntax
# Syntax the filter is written in. Current implementation defaults to PQL
# but in the future it will be LIST_FILTER.
# @param [Fixnum] page_size
# Requested page size. The server may return fewer results than requested.
# If unspecified, the server will pick an appropriate default.
# @param [String] page_token
# The page token as returned from ListProposalsResponse.
# @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::Adexchangebuyer2V2beta1::ListProposalsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse]
#
# @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_account_proposals(account_id, filter: nil, filter_syntax: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/proposals', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListProposalsResponse
command.params['accountId'] = account_id unless account_id.nil?
command.query['filter'] = filter unless filter.nil?
command.query['filterSyntax'] = filter_syntax unless filter_syntax.nil?
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
# Update the given proposal to pause serving.
# This method will set the
# `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all
# deals in the proposal.
# It is a no-op to pause an already-paused proposal.
# It is an error to call PauseProposal for a proposal that is not
# finalized or renegotiating.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The ID of the proposal to pause.
# @param [Google::Apis::Adexchangebuyer2V2beta1::PauseProposalRequest] pause_proposal_request_object
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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 pause_proposal(account_id, proposal_id, pause_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:pause', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::PauseProposalRequest::Representation
command.request_object = pause_proposal_request_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update the given proposal to resume serving.
# This method will set the
# `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all
# deals in the proposal.
# Note that if the `has_seller_paused` bit is also set, serving will not
# resume until the seller also resumes.
# It is a no-op to resume an already-running proposal.
# It is an error to call ResumeProposal for a proposal that is not
# finalized or renegotiating.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The ID of the proposal to resume.
# @param [Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalRequest] resume_proposal_request_object
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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 resume_proposal(account_id, proposal_id, resume_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/proposals/{proposalId}:resume', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::ResumeProposalRequest::Representation
command.request_object = resume_proposal_request_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Update the given proposal at the client known revision number. If the
# server revision has advanced since the passed-in
# `proposal.proposal_revision`, an `ABORTED` error message will be returned.
# Only the buyer-modifiable fields of the proposal will be updated.
# Note that the deals in the proposal will be updated to match the passed-in
# copy.
# If a passed-in deal does not have a `deal_id`, the server will assign a new
# unique ID and create the deal.
# If passed-in deal has a `deal_id`, it will be updated to match the
# passed-in copy.
# Any existing deals not present in the passed-in proposal will be deleted.
# It is an error to pass in a deal with a `deal_id` not present at head.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] proposal_id
# The unique ID of the proposal.
# @param [Google::Apis::Adexchangebuyer2V2beta1::Proposal] proposal_object
# @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::Adexchangebuyer2V2beta1::Proposal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::Proposal]
#
# @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 update_account_proposal(account_id, proposal_id, proposal_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v2beta1/accounts/{accountId}/proposals/{proposalId}', options)
command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.request_object = proposal_object
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Proposal::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Proposal
command.params['accountId'] = account_id unless account_id.nil?
command.params['proposalId'] = proposal_id unless proposal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the requested publisher profile by id.
# @param [String] account_id
# Account ID of the buyer.
# @param [String] publisher_profile_id
# The id for the publisher profile to get.
# @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::Adexchangebuyer2V2beta1::PublisherProfile] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::PublisherProfile]
#
# @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_account_publisher_profile(account_id, publisher_profile_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/publisherProfiles/{publisherProfileId}', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::PublisherProfile::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::PublisherProfile
command.params['accountId'] = account_id unless account_id.nil?
command.params['publisherProfileId'] = publisher_profile_id unless publisher_profile_id.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 all publisher profiles visible to the buyer
# @param [String] account_id
# Account ID of the buyer.
# @param [Fixnum] page_size
# Specify the number of results to include per page.
# @param [String] page_token
# The page token as return from ListPublisherProfilesResponse.
# @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::Adexchangebuyer2V2beta1::ListPublisherProfilesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::Adexchangebuyer2V2beta1::ListPublisherProfilesResponse]
#
# @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_account_publisher_profiles(account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/publisherProfiles', options)
command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListPublisherProfilesResponse::Representation
command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListPublisherProfilesResponse
command.params['accountId'] = account_id unless account_id.nil?
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
# Creates the specified filter set for the account with the given account ID.
# @param [String] owner_name
# Name of the owner (bidder or account) of the filter set to be created.
generated/google/apis/adexchangeseller_v1.rb
-37
View File
@@ -1,37 +0,0 @@
# 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/adexchangeseller_v1/service.rb'
require 'google/apis/adexchangeseller_v1/classes.rb'
require 'google/apis/adexchangeseller_v1/representations.rb'
module Google
module Apis
# Ad Exchange Seller API
#
# Accesses the inventory of Ad Exchange seller users and generates reports.
#
# @see https://developers.google.com/ad-exchange/seller-rest/
module AdexchangesellerV1
VERSION = 'V1'
REVISION = '20180708'
# View and manage your Ad Exchange data
AUTH_ADEXCHANGE_SELLER = 'https://www.googleapis.com/auth/adexchange.seller'
# View your Ad Exchange data
AUTH_ADEXCHANGE_SELLER_READONLY = 'https://www.googleapis.com/auth/adexchange.seller.readonly'
end
end
end
generated/google/apis/adexchangeseller_v1/classes.rb
-557
View File
@@ -1,557 +0,0 @@
# 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 AdexchangesellerV1
#
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 adexchangeseller#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)
@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)
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::AdexchangesellerV1::AdClient>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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
# 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 adexchangeseller#adUnit.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Name of this ad unit.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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)
@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)
@status = args[:status] if args.key?(:status)
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::AdexchangesellerV1::AdUnit>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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 adexchangeseller#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::AdexchangesellerV1::CustomChannel::TargetingInfo]
attr_accessor :targeting_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@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)
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
# ads). 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 are:
# TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
# 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)
@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)
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::AdexchangesellerV1::CustomChannel>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
end
end
#
class Report
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 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::AdexchangesellerV1::Report::Header>]
attr_accessor :headers
# Kind this is, in this case adexchangeseller#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 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 [Fixnum]
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)
@averages = args[:averages] if args.key?(:averages)
@headers = args[:headers] if args.key?(:headers)
@kind = args[:kind] if args.key?(:kind)
@rows = args[:rows] if args.key?(:rows)
@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)
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)
@currency = args[:currency] if args.key?(:currency)
@name = args[:name] if args.key?(:name)
@type = args[:type] if args.key?(:type)
end
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 adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
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::AdexchangesellerV1::SavedReport>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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 adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@url_pattern = args[:url_pattern] if args.key?(:url_pattern)
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::AdexchangesellerV1::UrlChannel>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
end
end
end
end
end
generated/google/apis/adexchangeseller_v1/representations.rb
-248
View File
@@ -1,248 +0,0 @@
# 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 AdexchangesellerV1
class AdClient
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdClients
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdUnit
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdUnits
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CustomChannel
class Representation < Google::Apis::Core::JsonRepresentation; end
class TargetingInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class CustomChannels
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Report
class Representation < Google::Apis::Core::JsonRepresentation; end
class Header
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class SavedReport
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SavedReports
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlChannel
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlChannels
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdClient
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :arc_opt_in, as: 'arcOptIn'
property :id, as: 'id'
property :kind, as: 'kind'
property :product_code, as: 'productCode'
property :supports_reporting, as: 'supportsReporting'
end
end
class AdClients
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::AdClient, decorator: Google::Apis::AdexchangesellerV1::AdClient::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class AdUnit
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
property :status, as: 'status'
end
end
class AdUnits
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::AdUnit, decorator: Google::Apis::AdexchangesellerV1::AdUnit::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class CustomChannel
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
property :targeting_info, as: 'targetingInfo', class: Google::Apis::AdexchangesellerV1::CustomChannel::TargetingInfo, decorator: Google::Apis::AdexchangesellerV1::CustomChannel::TargetingInfo::Representation
end
class TargetingInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ads_appear_on, as: 'adsAppearOn'
property :description, as: 'description'
property :location, as: 'location'
property :site_language, as: 'siteLanguage'
end
end
end
class CustomChannels
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::CustomChannel, decorator: Google::Apis::AdexchangesellerV1::CustomChannel::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class Report
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :averages, as: 'averages'
collection :headers, as: 'headers', class: Google::Apis::AdexchangesellerV1::Report::Header, decorator: Google::Apis::AdexchangesellerV1::Report::Header::Representation
property :kind, as: 'kind'
collection :rows, as: 'rows', :class => Array do
include Representable::JSON::Collection
items
end
property :total_matched_rows, :numeric_string => true, as: 'totalMatchedRows'
collection :totals, as: 'totals'
collection :warnings, as: 'warnings'
end
class Header
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :currency, as: 'currency'
property :name, as: 'name'
property :type, as: 'type'
end
end
end
class SavedReport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
end
end
class SavedReports
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::SavedReport, decorator: Google::Apis::AdexchangesellerV1::SavedReport::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class UrlChannel
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :url_pattern, as: 'urlPattern'
end
end
class UrlChannels
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1::UrlChannel, decorator: Google::Apis::AdexchangesellerV1::UrlChannel::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
end
end
end
generated/google/apis/adexchangeseller_v1/service.rb
-544
View File
@@ -1,544 +0,0 @@
# 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 AdexchangesellerV1
# Ad Exchange Seller API
#
# Accesses the inventory of Ad Exchange seller users and generates reports.
#
# @example
# require 'google/apis/adexchangeseller_v1'
#
# Adexchangeseller = Google::Apis::AdexchangesellerV1 # Alias the module
# service = Adexchangeseller::AdExchangeSellerService.new
#
# @see https://developers.google.com/ad-exchange/seller-rest/
class AdExchangeSellerService < 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]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'adexchangeseller/v1/')
@batch_path = 'batch/adexchangeseller/v1'
end
# List all ad clients in this Ad Exchange account.
# @param [Fixnum] max_results
# The maximum number of ad clients to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through ad clients. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::AdClients] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::AdClients]
#
# @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_adclients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients', options)
command.response_representation = Google::Apis::AdexchangesellerV1::AdClients::Representation
command.response_class = Google::Apis::AdexchangesellerV1::AdClients
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified ad unit in the specified ad client.
# @param [String] ad_client_id
# Ad client for which to get the ad unit.
# @param [String] ad_unit_id
# Ad unit to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::AdUnit] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::AdUnit]
#
# @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_adunit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1::AdUnit::Representation
command.response_class = Google::Apis::AdexchangesellerV1::AdUnit
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all ad units in the specified ad client for this Ad Exchange account.
# @param [String] ad_client_id
# Ad client for which to list ad units.
# @param [Boolean] include_inactive
# Whether to include inactive ad units. Default: true.
# @param [Fixnum] max_results
# The maximum number of ad units to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through ad units. To retrieve the next page,
# set this parameter to the value of "nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::AdUnits] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::AdUnits]
#
# @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_adunits(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/adunits', options)
command.response_representation = Google::Apis::AdexchangesellerV1::AdUnits::Representation
command.response_class = Google::Apis::AdexchangesellerV1::AdUnits
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all custom channels which the specified ad unit belongs to.
# @param [String] ad_client_id
# Ad client which contains the ad unit.
# @param [String] ad_unit_id
# Ad unit for which to list custom channels.
# @param [Fixnum] max_results
# The maximum number of custom channels to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through custom channels. To retrieve the
# next page, set this parameter to the value of "nextPageToken" from the
# previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::CustomChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::CustomChannels]
#
# @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_adunit_customchannels(ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}/customchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV1::CustomChannels
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Get the specified custom channel from the specified ad client.
# @param [String] ad_client_id
# Ad client which contains the custom channel.
# @param [String] custom_channel_id
# Custom channel to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::CustomChannel] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::CustomChannel]
#
# @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_customchannel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannel::Representation
command.response_class = Google::Apis::AdexchangesellerV1::CustomChannel
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all custom channels in the specified ad client for this Ad Exchange
# account.
# @param [String] ad_client_id
# Ad client for which to list custom channels.
# @param [Fixnum] max_results
# The maximum number of custom channels to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through custom channels. To retrieve the
# next page, set this parameter to the value of "nextPageToken" from the
# previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::CustomChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::CustomChannels]
#
# @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_customchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV1::CustomChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV1::CustomChannels
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all ad units in the specified custom channel.
# @param [String] ad_client_id
# Ad client which contains the custom channel.
# @param [String] custom_channel_id
# Custom channel for which to list ad units.
# @param [Boolean] include_inactive
# Whether to include inactive ad units. Default: true.
# @param [Fixnum] max_results
# The maximum number of ad units to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through ad units. To retrieve the next page,
# set this parameter to the value of "nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::AdUnits] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::AdUnits]
#
# @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_customchannel_adunits(ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}/adunits', options)
command.response_representation = Google::Apis::AdexchangesellerV1::AdUnits::Representation
command.response_class = Google::Apis::AdexchangesellerV1::AdUnits
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Generate an Ad Exchange report based on the report request sent in the query
# parameters. Returns the result as JSON; to retrieve output in CSV format
# specify "alt=csv" as a query parameter.
# @param [String] start_date
# Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
# @param [String] end_date
# End of the date range to report on in "YYYY-MM-DD" format, inclusive.
# @param [Array<String>, String] dimension
# Dimensions to base the report on.
# @param [Array<String>, String] filter
# Filters to be run on the report.
# @param [String] locale
# Optional locale to use for translating report output to a local language.
# Defaults to "en_US" if not specified.
# @param [Fixnum] max_results
# The maximum number of rows of report data to return.
# @param [Array<String>, String] metric
# Numeric columns to include in the report.
# @param [Array<String>, String] sort
# The name of a dimension or metric to sort the resulting report on, optionally
# prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is
# specified, the column is sorted ascending.
# @param [Fixnum] start_index
# Index of the first row of report data to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [IO, String] download_dest
# IO stream or filename to receive content download
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::Report] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::Report]
#
# @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 generate_report(start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
if download_dest.nil?
command = make_simple_command(:get, 'reports', options)
else
command = make_download_command(:get, 'reports', options)
command.download_dest = download_dest
end
command.response_representation = Google::Apis::AdexchangesellerV1::Report::Representation
command.response_class = Google::Apis::AdexchangesellerV1::Report
command.query['dimension'] = dimension unless dimension.nil?
command.query['endDate'] = end_date unless end_date.nil?
command.query['filter'] = filter unless filter.nil?
command.query['locale'] = locale unless locale.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['metric'] = metric unless metric.nil?
command.query['sort'] = sort unless sort.nil?
command.query['startDate'] = start_date unless start_date.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Generate an Ad Exchange report based on the saved report ID sent in the query
# parameters.
# @param [String] saved_report_id
# The saved report to retrieve.
# @param [String] locale
# Optional locale to use for translating report output to a local language.
# Defaults to "en_US" if not specified.
# @param [Fixnum] max_results
# The maximum number of rows of report data to return.
# @param [Fixnum] start_index
# Index of the first row of report data to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::Report] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::Report]
#
# @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 generate_report_saved(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'reports/{savedReportId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1::Report::Representation
command.response_class = Google::Apis::AdexchangesellerV1::Report
command.params['savedReportId'] = saved_report_id unless saved_report_id.nil?
command.query['locale'] = locale unless locale.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all saved reports in this Ad Exchange account.
# @param [Fixnum] max_results
# The maximum number of saved reports to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through saved reports. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::SavedReports] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::SavedReports]
#
# @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_report_saveds(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'reports/saved', options)
command.response_representation = Google::Apis::AdexchangesellerV1::SavedReports::Representation
command.response_class = Google::Apis::AdexchangesellerV1::SavedReports
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all URL channels in the specified ad client for this Ad Exchange account.
# @param [String] ad_client_id
# Ad client for which to list URL channels.
# @param [Fixnum] max_results
# The maximum number of URL channels to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through URL channels. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1::UrlChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1::UrlChannels]
#
# @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_urlchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/urlchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV1::UrlChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV1::UrlChannels
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.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?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end
end
end
generated/google/apis/adexchangeseller_v1_1.rb
-37
View File
@@ -1,37 +0,0 @@
# 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/adexchangeseller_v1_1/service.rb'
require 'google/apis/adexchangeseller_v1_1/classes.rb'
require 'google/apis/adexchangeseller_v1_1/representations.rb'
module Google
module Apis
# Ad Exchange Seller API
#
# Accesses the inventory of Ad Exchange seller users and generates reports.
#
# @see https://developers.google.com/ad-exchange/seller-rest/
module AdexchangesellerV1_1
VERSION = 'V1_1'
REVISION = '20180708'
# View and manage your Ad Exchange data
AUTH_ADEXCHANGE_SELLER = 'https://www.googleapis.com/auth/adexchange.seller'
# View your Ad Exchange data
AUTH_ADEXCHANGE_SELLER_READONLY = 'https://www.googleapis.com/auth/adexchange.seller.readonly'
end
end
end
generated/google/apis/adexchangeseller_v1_1/classes.rb
-842
View File
@@ -1,842 +0,0 @@
# 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 AdexchangesellerV1_1
#
class Account
include Google::Apis::Core::Hashable
# Unique identifier of this account.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adexchangeseller#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
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
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 adexchangeseller#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)
@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)
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::AdexchangesellerV1_1::AdClient>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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
# 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 adexchangeseller#adUnit.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Name of this ad unit.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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)
@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)
@status = args[:status] if args.key?(:status)
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::AdexchangesellerV1_1::AdUnit>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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
# Kind of resource this is, in this case adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@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)
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::AdexchangesellerV1_1::Alert>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
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 adexchangeseller#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::AdexchangesellerV1_1::CustomChannel::TargetingInfo]
attr_accessor :targeting_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@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)
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
# ads). 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 are:
# TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
# 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)
@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)
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::AdexchangesellerV1_1::CustomChannel>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
end
end
#
class Metadata
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdexchangesellerV1_1::ReportingMetadataEntry>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
end
end
#
class PreferredDeal
include Google::Apis::Core::Hashable
# The name of the advertiser this deal is for.
# Corresponds to the JSON property `advertiserName`
# @return [String]
attr_accessor :advertiser_name
# The name of the buyer network this deal is for.
# Corresponds to the JSON property `buyerNetworkName`
# @return [String]
attr_accessor :buyer_network_name
# The currency code that applies to the fixed_cpm value. If not set then assumed
# to be USD.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
# Time when this deal stops being active in seconds since the epoch (GMT). If
# not set then this deal is valid until manually disabled by the publisher.
# Corresponds to the JSON property `endTime`
# @return [Fixnum]
attr_accessor :end_time
# The fixed price for this preferred deal. In cpm micros of currency according
# to currencyCode. If set, then this preferred deal is eligible for the fixed
# price tier of buying (highest priority, pay exactly the configured fixed price)
# .
# Corresponds to the JSON property `fixedCpm`
# @return [Fixnum]
attr_accessor :fixed_cpm
# Unique identifier of this preferred deal.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Kind of resource this is, in this case adexchangeseller#preferredDeal.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Time when this deal becomes active in seconds since the epoch (GMT). If not
# set then this deal is active immediately upon creation.
# Corresponds to the JSON property `startTime`
# @return [Fixnum]
attr_accessor :start_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
@buyer_network_name = args[:buyer_network_name] if args.key?(:buyer_network_name)
@currency_code = args[:currency_code] if args.key?(:currency_code)
@end_time = args[:end_time] if args.key?(:end_time)
@fixed_cpm = args[:fixed_cpm] if args.key?(:fixed_cpm)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@start_time = args[:start_time] if args.key?(:start_time)
end
end
#
class PreferredDeals
include Google::Apis::Core::Hashable
# The preferred deals returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdexchangesellerV1_1::PreferredDeal>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#preferredDeals.
# 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)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
end
end
#
class Report
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 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::AdexchangesellerV1_1::Report::Header>]
attr_accessor :headers
# Kind this is, in this case adexchangeseller#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 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 [Fixnum]
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)
@averages = args[:averages] if args.key?(:averages)
@headers = args[:headers] if args.key?(:headers)
@kind = args[:kind] if args.key?(:kind)
@rows = args[:rows] if args.key?(:rows)
@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)
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)
@currency = args[:currency] if args.key?(:currency)
@name = args[:name] if args.key?(:name)
@type = args[:type] if args.key?(:type)
end
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 adexchangeseller#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)
@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)
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 adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
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::AdexchangesellerV1_1::SavedReport>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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 adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@url_pattern = args[:url_pattern] if args.key?(:url_pattern)
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::AdexchangesellerV1_1::UrlChannel>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
end
end
end
end
end
generated/google/apis/adexchangeseller_v1_1/representations.rb
-364
View File
@@ -1,364 +0,0 @@
# 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 AdexchangesellerV1_1
class Account
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdClient
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdClients
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdUnit
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdUnits
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Alert
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Alerts
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CustomChannel
class Representation < Google::Apis::Core::JsonRepresentation; end
class TargetingInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class CustomChannels
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Metadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PreferredDeal
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PreferredDeals
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Report
class Representation < Google::Apis::Core::JsonRepresentation; end
class Header
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class ReportingMetadataEntry
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SavedReport
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SavedReports
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlChannel
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlChannels
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Account
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
end
end
class AdClient
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :arc_opt_in, as: 'arcOptIn'
property :id, as: 'id'
property :kind, as: 'kind'
property :product_code, as: 'productCode'
property :supports_reporting, as: 'supportsReporting'
end
end
class AdClients
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::AdClient, decorator: Google::Apis::AdexchangesellerV1_1::AdClient::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class AdUnit
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
property :status, as: 'status'
end
end
class AdUnits
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::AdUnit, decorator: Google::Apis::AdexchangesellerV1_1::AdUnit::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class Alert
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :message, as: 'message'
property :severity, as: 'severity'
property :type, as: 'type'
end
end
class Alerts
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::Alert, decorator: Google::Apis::AdexchangesellerV1_1::Alert::Representation
property :kind, as: 'kind'
end
end
class CustomChannel
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
property :targeting_info, as: 'targetingInfo', class: Google::Apis::AdexchangesellerV1_1::CustomChannel::TargetingInfo, decorator: Google::Apis::AdexchangesellerV1_1::CustomChannel::TargetingInfo::Representation
end
class TargetingInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ads_appear_on, as: 'adsAppearOn'
property :description, as: 'description'
property :location, as: 'location'
property :site_language, as: 'siteLanguage'
end
end
end
class CustomChannels
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::CustomChannel, decorator: Google::Apis::AdexchangesellerV1_1::CustomChannel::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class Metadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::ReportingMetadataEntry, decorator: Google::Apis::AdexchangesellerV1_1::ReportingMetadataEntry::Representation
property :kind, as: 'kind'
end
end
class PreferredDeal
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :advertiser_name, as: 'advertiserName'
property :buyer_network_name, as: 'buyerNetworkName'
property :currency_code, as: 'currencyCode'
property :end_time, :numeric_string => true, as: 'endTime'
property :fixed_cpm, :numeric_string => true, as: 'fixedCpm'
property :id, :numeric_string => true, as: 'id'
property :kind, as: 'kind'
property :start_time, :numeric_string => true, as: 'startTime'
end
end
class PreferredDeals
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::PreferredDeal, decorator: Google::Apis::AdexchangesellerV1_1::PreferredDeal::Representation
property :kind, as: 'kind'
end
end
class Report
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :averages, as: 'averages'
collection :headers, as: 'headers', class: Google::Apis::AdexchangesellerV1_1::Report::Header, decorator: Google::Apis::AdexchangesellerV1_1::Report::Header::Representation
property :kind, as: 'kind'
collection :rows, as: 'rows', :class => Array do
include Representable::JSON::Collection
items
end
property :total_matched_rows, :numeric_string => true, as: 'totalMatchedRows'
collection :totals, as: 'totals'
collection :warnings, as: 'warnings'
end
class Header
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :currency, as: 'currency'
property :name, as: 'name'
property :type, as: 'type'
end
end
end
class ReportingMetadataEntry
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :compatible_dimensions, as: 'compatibleDimensions'
collection :compatible_metrics, as: 'compatibleMetrics'
property :id, as: 'id'
property :kind, as: 'kind'
collection :required_dimensions, as: 'requiredDimensions'
collection :required_metrics, as: 'requiredMetrics'
collection :supported_products, as: 'supportedProducts'
end
end
class SavedReport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
end
end
class SavedReports
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::SavedReport, decorator: Google::Apis::AdexchangesellerV1_1::SavedReport::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class UrlChannel
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :url_pattern, as: 'urlPattern'
end
end
class UrlChannels
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV1_1::UrlChannel, decorator: Google::Apis::AdexchangesellerV1_1::UrlChannel::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
end
end
end
generated/google/apis/adexchangeseller_v1_1/service.rb
-735
View File
@@ -1,735 +0,0 @@
# 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 AdexchangesellerV1_1
# Ad Exchange Seller API
#
# Accesses the inventory of Ad Exchange seller users and generates reports.
#
# @example
# require 'google/apis/adexchangeseller_v1_1'
#
# Adexchangeseller = Google::Apis::AdexchangesellerV1_1 # Alias the module
# service = Adexchangeseller::AdExchangeSellerService.new
#
# @see https://developers.google.com/ad-exchange/seller-rest/
class AdExchangeSellerService < 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]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'adexchangeseller/v1.1/')
@batch_path = 'batch/adexchangeseller/v1.1'
end
# Get information about the selected Ad Exchange account.
# @param [String] account_id
# Account to get information about. Tip: 'myaccount' is a valid ID.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::Account] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::Account]
#
# @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_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::Account::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::Account
command.params['accountId'] = account_id unless account_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all ad clients in this Ad Exchange account.
# @param [Fixnum] max_results
# The maximum number of ad clients to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through ad clients. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::AdClients] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::AdClients]
#
# @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_adclients(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::AdClients::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::AdClients
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Gets the specified ad unit in the specified ad client.
# @param [String] ad_client_id
# Ad client for which to get the ad unit.
# @param [String] ad_unit_id
# Ad unit to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::AdUnit] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::AdUnit]
#
# @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_adunit(ad_client_id, ad_unit_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::AdUnit::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::AdUnit
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all ad units in the specified ad client for this Ad Exchange account.
# @param [String] ad_client_id
# Ad client for which to list ad units.
# @param [Boolean] include_inactive
# Whether to include inactive ad units. Default: true.
# @param [Fixnum] max_results
# The maximum number of ad units to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through ad units. To retrieve the next page,
# set this parameter to the value of "nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::AdUnits] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::AdUnits]
#
# @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_adunits(ad_client_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/adunits', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::AdUnits::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::AdUnits
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all custom channels which the specified ad unit belongs to.
# @param [String] ad_client_id
# Ad client which contains the ad unit.
# @param [String] ad_unit_id
# Ad unit for which to list custom channels.
# @param [Fixnum] max_results
# The maximum number of custom channels to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through custom channels. To retrieve the
# next page, set this parameter to the value of "nextPageToken" from the
# previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::CustomChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::CustomChannels]
#
# @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_adunit_customchannels(ad_client_id, ad_unit_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/adunits/{adUnitId}/customchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::CustomChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::CustomChannels
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['adUnitId'] = ad_unit_id unless ad_unit_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the alerts for this Ad Exchange account.
# @param [String] locale
# The locale to use for translating alert messages. The account locale will be
# used if this is not supplied. The AdSense default (English) will be used if
# the supplied locale is invalid or unsupported.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::Alerts] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::Alerts]
#
# @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_alerts(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'alerts', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::Alerts::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::Alerts
command.query['locale'] = locale unless locale.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Get the specified custom channel from the specified ad client.
# @param [String] ad_client_id
# Ad client which contains the custom channel.
# @param [String] custom_channel_id
# Custom channel to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::CustomChannel] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::CustomChannel]
#
# @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_customchannel(ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::CustomChannel::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::CustomChannel
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all custom channels in the specified ad client for this Ad Exchange
# account.
# @param [String] ad_client_id
# Ad client for which to list custom channels.
# @param [Fixnum] max_results
# The maximum number of custom channels to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through custom channels. To retrieve the
# next page, set this parameter to the value of "nextPageToken" from the
# previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::CustomChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::CustomChannels]
#
# @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_customchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::CustomChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::CustomChannels
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all ad units in the specified custom channel.
# @param [String] ad_client_id
# Ad client which contains the custom channel.
# @param [String] custom_channel_id
# Custom channel for which to list ad units.
# @param [Boolean] include_inactive
# Whether to include inactive ad units. Default: true.
# @param [Fixnum] max_results
# The maximum number of ad units to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through ad units. To retrieve the next page,
# set this parameter to the value of "nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::AdUnits] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::AdUnits]
#
# @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_customchannel_adunits(ad_client_id, custom_channel_id, include_inactive: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/customchannels/{customChannelId}/adunits', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::AdUnits::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::AdUnits
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
command.query['includeInactive'] = include_inactive unless include_inactive.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the metadata for the dimensions available to this AdExchange account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::Metadata] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::Metadata]
#
# @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_metadatum_dimensions(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'metadata/dimensions', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::Metadata::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::Metadata
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the metadata for the metrics available to this AdExchange account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::Metadata] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::Metadata]
#
# @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_metadatum_metrics(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'metadata/metrics', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::Metadata::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::Metadata
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Get information about the selected Ad Exchange Preferred Deal.
# @param [String] deal_id
# Preferred deal to get information about.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::PreferredDeal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::PreferredDeal]
#
# @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_preferreddeal(deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'preferreddeals/{dealId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::PreferredDeal::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::PreferredDeal
command.params['dealId'] = deal_id unless deal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the preferred deals for this Ad Exchange account.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::PreferredDeals] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::PreferredDeals]
#
# @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_preferreddeals(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'preferreddeals', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::PreferredDeals::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::PreferredDeals
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Generate an Ad Exchange report based on the report request sent in the query
# parameters. Returns the result as JSON; to retrieve output in CSV format
# specify "alt=csv" as a query parameter.
# @param [String] start_date
# Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
# @param [String] end_date
# End of the date range to report on in "YYYY-MM-DD" format, inclusive.
# @param [Array<String>, String] dimension
# Dimensions to base the report on.
# @param [Array<String>, String] filter
# Filters to be run on the report.
# @param [String] locale
# Optional locale to use for translating report output to a local language.
# Defaults to "en_US" if not specified.
# @param [Fixnum] max_results
# The maximum number of rows of report data to return.
# @param [Array<String>, String] metric
# Numeric columns to include in the report.
# @param [Array<String>, String] sort
# The name of a dimension or metric to sort the resulting report on, optionally
# prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is
# specified, the column is sorted ascending.
# @param [Fixnum] start_index
# Index of the first row of report data to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [IO, String] download_dest
# IO stream or filename to receive content download
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::Report] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::Report]
#
# @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 generate_report(start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
if download_dest.nil?
command = make_simple_command(:get, 'reports', options)
else
command = make_download_command(:get, 'reports', options)
command.download_dest = download_dest
end
command.response_representation = Google::Apis::AdexchangesellerV1_1::Report::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::Report
command.query['dimension'] = dimension unless dimension.nil?
command.query['endDate'] = end_date unless end_date.nil?
command.query['filter'] = filter unless filter.nil?
command.query['locale'] = locale unless locale.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['metric'] = metric unless metric.nil?
command.query['sort'] = sort unless sort.nil?
command.query['startDate'] = start_date unless start_date.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Generate an Ad Exchange report based on the saved report ID sent in the query
# parameters.
# @param [String] saved_report_id
# The saved report to retrieve.
# @param [String] locale
# Optional locale to use for translating report output to a local language.
# Defaults to "en_US" if not specified.
# @param [Fixnum] max_results
# The maximum number of rows of report data to return.
# @param [Fixnum] start_index
# Index of the first row of report data to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::Report] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::Report]
#
# @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 generate_report_saved(saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'reports/{savedReportId}', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::Report::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::Report
command.params['savedReportId'] = saved_report_id unless saved_report_id.nil?
command.query['locale'] = locale unless locale.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all saved reports in this Ad Exchange account.
# @param [Fixnum] max_results
# The maximum number of saved reports to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through saved reports. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::SavedReports] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::SavedReports]
#
# @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_report_saveds(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'reports/saved', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::SavedReports::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::SavedReports
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all URL channels in the specified ad client for this Ad Exchange account.
# @param [String] ad_client_id
# Ad client for which to list URL channels.
# @param [Fixnum] max_results
# The maximum number of URL channels to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through URL channels. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV1_1::UrlChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV1_1::UrlChannels]
#
# @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_urlchannels(ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'adclients/{adClientId}/urlchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV1_1::UrlChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV1_1::UrlChannels
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.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?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end
end
end
generated/google/apis/adexchangeseller_v2_0.rb
-37
View File
@@ -1,37 +0,0 @@
# 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/adexchangeseller_v2_0/service.rb'
require 'google/apis/adexchangeseller_v2_0/classes.rb'
require 'google/apis/adexchangeseller_v2_0/representations.rb'
module Google
module Apis
# Ad Exchange Seller API
#
# Accesses the inventory of Ad Exchange seller users and generates reports.
#
# @see https://developers.google.com/ad-exchange/seller-rest/
module AdexchangesellerV2_0
VERSION = 'V2_0'
REVISION = '20180708'
# View and manage your Ad Exchange data
AUTH_ADEXCHANGE_SELLER = 'https://www.googleapis.com/auth/adexchange.seller'
# View your Ad Exchange data
AUTH_ADEXCHANGE_SELLER_READONLY = 'https://www.googleapis.com/auth/adexchange.seller.readonly'
end
end
end
generated/google/apis/adexchangeseller_v2_0/classes.rb
-792
View File
@@ -1,792 +0,0 @@
# 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 AdexchangesellerV2_0
#
class Account
include Google::Apis::Core::Hashable
# Unique identifier of this account.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Kind of resource this is, in this case adexchangeseller#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
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
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::AdexchangesellerV2_0::Account>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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 adexchangeseller#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)
@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)
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::AdexchangesellerV2_0::AdClient>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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
# Kind of resource this is, in this case adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@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)
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::AdexchangesellerV2_0::Alert>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
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 adexchangeseller#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::AdexchangesellerV2_0::CustomChannel::TargetingInfo]
attr_accessor :targeting_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@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)
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
# ads). 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 are:
# TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
# 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)
@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)
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::AdexchangesellerV2_0::CustomChannel>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
end
end
#
class Metadata
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdexchangesellerV2_0::ReportingMetadataEntry>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
end
end
#
class PreferredDeal
include Google::Apis::Core::Hashable
# The name of the advertiser this deal is for.
# Corresponds to the JSON property `advertiserName`
# @return [String]
attr_accessor :advertiser_name
# The name of the buyer network this deal is for.
# Corresponds to the JSON property `buyerNetworkName`
# @return [String]
attr_accessor :buyer_network_name
# The currency code that applies to the fixed_cpm value. If not set then assumed
# to be USD.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
# Time when this deal stops being active in seconds since the epoch (GMT). If
# not set then this deal is valid until manually disabled by the publisher.
# Corresponds to the JSON property `endTime`
# @return [Fixnum]
attr_accessor :end_time
# The fixed price for this preferred deal. In cpm micros of currency according
# to currencyCode. If set, then this preferred deal is eligible for the fixed
# price tier of buying (highest priority, pay exactly the configured fixed price)
# .
# Corresponds to the JSON property `fixedCpm`
# @return [Fixnum]
attr_accessor :fixed_cpm
# Unique identifier of this preferred deal.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Kind of resource this is, in this case adexchangeseller#preferredDeal.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Time when this deal becomes active in seconds since the epoch (GMT). If not
# set then this deal is active immediately upon creation.
# Corresponds to the JSON property `startTime`
# @return [Fixnum]
attr_accessor :start_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@advertiser_name = args[:advertiser_name] if args.key?(:advertiser_name)
@buyer_network_name = args[:buyer_network_name] if args.key?(:buyer_network_name)
@currency_code = args[:currency_code] if args.key?(:currency_code)
@end_time = args[:end_time] if args.key?(:end_time)
@fixed_cpm = args[:fixed_cpm] if args.key?(:fixed_cpm)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@start_time = args[:start_time] if args.key?(:start_time)
end
end
#
class PreferredDeals
include Google::Apis::Core::Hashable
# The preferred deals returned in this list response.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::AdexchangesellerV2_0::PreferredDeal>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#preferredDeals.
# 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)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
end
end
#
class Report
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 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::AdexchangesellerV2_0::Report::Header>]
attr_accessor :headers
# Kind this is, in this case adexchangeseller#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 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 [Fixnum]
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)
@averages = args[:averages] if args.key?(:averages)
@headers = args[:headers] if args.key?(:headers)
@kind = args[:kind] if args.key?(:kind)
@rows = args[:rows] if args.key?(:rows)
@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)
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)
@currency = args[:currency] if args.key?(:currency)
@name = args[:name] if args.key?(:name)
@type = args[:type] if args.key?(:type)
end
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 adexchangeseller#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)
@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)
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 adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
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::AdexchangesellerV2_0::SavedReport>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
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 adexchangeseller#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)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@url_pattern = args[:url_pattern] if args.key?(:url_pattern)
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::AdexchangesellerV2_0::UrlChannel>]
attr_accessor :items
# Kind of list this is, in this case adexchangeseller#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)
@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)
end
end
end
end
end
generated/google/apis/adexchangeseller_v2_0/representations.rb
-347
View File
@@ -1,347 +0,0 @@
# 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 AdexchangesellerV2_0
class Account
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Accounts
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdClient
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class AdClients
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Alert
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Alerts
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CustomChannel
class Representation < Google::Apis::Core::JsonRepresentation; end
class TargetingInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class CustomChannels
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Metadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PreferredDeal
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PreferredDeals
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Report
class Representation < Google::Apis::Core::JsonRepresentation; end
class Header
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class ReportingMetadataEntry
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SavedReport
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SavedReports
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlChannel
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class UrlChannels
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Account
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
end
end
class Accounts
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::Account, decorator: Google::Apis::AdexchangesellerV2_0::Account::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class AdClient
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :arc_opt_in, as: 'arcOptIn'
property :id, as: 'id'
property :kind, as: 'kind'
property :product_code, as: 'productCode'
property :supports_reporting, as: 'supportsReporting'
end
end
class AdClients
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::AdClient, decorator: Google::Apis::AdexchangesellerV2_0::AdClient::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class Alert
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :message, as: 'message'
property :severity, as: 'severity'
property :type, as: 'type'
end
end
class Alerts
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::Alert, decorator: Google::Apis::AdexchangesellerV2_0::Alert::Representation
property :kind, as: 'kind'
end
end
class CustomChannel
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
property :targeting_info, as: 'targetingInfo', class: Google::Apis::AdexchangesellerV2_0::CustomChannel::TargetingInfo, decorator: Google::Apis::AdexchangesellerV2_0::CustomChannel::TargetingInfo::Representation
end
class TargetingInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :ads_appear_on, as: 'adsAppearOn'
property :description, as: 'description'
property :location, as: 'location'
property :site_language, as: 'siteLanguage'
end
end
end
class CustomChannels
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::CustomChannel, decorator: Google::Apis::AdexchangesellerV2_0::CustomChannel::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class Metadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::ReportingMetadataEntry, decorator: Google::Apis::AdexchangesellerV2_0::ReportingMetadataEntry::Representation
property :kind, as: 'kind'
end
end
class PreferredDeal
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :advertiser_name, as: 'advertiserName'
property :buyer_network_name, as: 'buyerNetworkName'
property :currency_code, as: 'currencyCode'
property :end_time, :numeric_string => true, as: 'endTime'
property :fixed_cpm, :numeric_string => true, as: 'fixedCpm'
property :id, :numeric_string => true, as: 'id'
property :kind, as: 'kind'
property :start_time, :numeric_string => true, as: 'startTime'
end
end
class PreferredDeals
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::PreferredDeal, decorator: Google::Apis::AdexchangesellerV2_0::PreferredDeal::Representation
property :kind, as: 'kind'
end
end
class Report
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :averages, as: 'averages'
collection :headers, as: 'headers', class: Google::Apis::AdexchangesellerV2_0::Report::Header, decorator: Google::Apis::AdexchangesellerV2_0::Report::Header::Representation
property :kind, as: 'kind'
collection :rows, as: 'rows', :class => Array do
include Representable::JSON::Collection
items
end
property :total_matched_rows, :numeric_string => true, as: 'totalMatchedRows'
collection :totals, as: 'totals'
collection :warnings, as: 'warnings'
end
class Header
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :currency, as: 'currency'
property :name, as: 'name'
property :type, as: 'type'
end
end
end
class ReportingMetadataEntry
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :compatible_dimensions, as: 'compatibleDimensions'
collection :compatible_metrics, as: 'compatibleMetrics'
property :id, as: 'id'
property :kind, as: 'kind'
collection :required_dimensions, as: 'requiredDimensions'
collection :required_metrics, as: 'requiredMetrics'
collection :supported_products, as: 'supportedProducts'
end
end
class SavedReport
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :name, as: 'name'
end
end
class SavedReports
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::SavedReport, decorator: Google::Apis::AdexchangesellerV2_0::SavedReport::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class UrlChannel
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
property :url_pattern, as: 'urlPattern'
end
end
class UrlChannels
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::AdexchangesellerV2_0::UrlChannel, decorator: Google::Apis::AdexchangesellerV2_0::UrlChannel::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
end
end
end
generated/google/apis/adexchangeseller_v2_0/service.rb
-638
View File
@@ -1,638 +0,0 @@
# 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 AdexchangesellerV2_0
# Ad Exchange Seller API
#
# Accesses the inventory of Ad Exchange seller users and generates reports.
#
# @example
# require 'google/apis/adexchangeseller_v2_0'
#
# Adexchangeseller = Google::Apis::AdexchangesellerV2_0 # Alias the module
# service = Adexchangeseller::AdExchangeSellerService.new
#
# @see https://developers.google.com/ad-exchange/seller-rest/
class AdExchangeSellerService < 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]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'adexchangeseller/v2.0/')
@batch_path = 'batch/adexchangeseller/v2.0'
end
# Get information about the selected Ad Exchange account.
# @param [String] account_id
# Account to get information about. Tip: 'myaccount' is a valid ID.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::Account] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::Account]
#
# @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_account(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::Account::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::Account
command.params['accountId'] = account_id unless account_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all accounts available to this Ad Exchange account.
# @param [Fixnum] max_results
# The maximum number of accounts to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through accounts. To retrieve the next page,
# set this parameter to the value of "nextPageToken" from the previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::Accounts] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::Accounts]
#
# @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_accounts(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::Accounts::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::Accounts
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all ad clients in this Ad Exchange account.
# @param [String] account_id
# Account to which the ad client belongs.
# @param [Fixnum] max_results
# The maximum number of ad clients to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through ad clients. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::AdClients] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::AdClients]
#
# @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_account_ad_clients(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/adclients', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::AdClients::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::AdClients
command.params['accountId'] = account_id unless account_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the alerts for this Ad Exchange account.
# @param [String] account_id
# Account owning the alerts.
# @param [String] locale
# The locale to use for translating alert messages. The account locale will be
# used if this is not supplied. The AdSense default (English) will be used if
# the supplied locale is invalid or unsupported.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::Alerts] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::Alerts]
#
# @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_account_alerts(account_id, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/alerts', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::Alerts::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::Alerts
command.params['accountId'] = account_id unless account_id.nil?
command.query['locale'] = locale unless locale.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Get the specified custom channel from the specified ad client.
# @param [String] account_id
# Account to which the ad client belongs.
# @param [String] ad_client_id
# Ad client which contains the custom channel.
# @param [String] custom_channel_id
# Custom channel to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::CustomChannel] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::CustomChannel]
#
# @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_account_custom_channel(account_id, ad_client_id, custom_channel_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannel::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannel
command.params['accountId'] = account_id unless account_id.nil?
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.params['customChannelId'] = custom_channel_id unless custom_channel_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all custom channels in the specified ad client for this Ad Exchange
# account.
# @param [String] account_id
# Account to which the ad client belongs.
# @param [String] ad_client_id
# Ad client for which to list custom channels.
# @param [Fixnum] max_results
# The maximum number of custom channels to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through custom channels. To retrieve the
# next page, set this parameter to the value of "nextPageToken" from the
# previous response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::CustomChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::CustomChannels]
#
# @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_account_custom_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/customchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::CustomChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::CustomChannels
command.params['accountId'] = account_id unless account_id.nil?
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the metadata for the dimensions available to this AdExchange account.
# @param [String] account_id
# Account with visibility to the dimensions.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::Metadata] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::Metadata]
#
# @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_account_metadata_dimensions(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/metadata/dimensions', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata
command.params['accountId'] = account_id unless account_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the metadata for the metrics available to this AdExchange account.
# @param [String] account_id
# Account with visibility to the metrics.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::Metadata] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::Metadata]
#
# @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_account_metadata_metrics(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/metadata/metrics', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::Metadata::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::Metadata
command.params['accountId'] = account_id unless account_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Get information about the selected Ad Exchange Preferred Deal.
# @param [String] account_id
# Account owning the deal.
# @param [String] deal_id
# Preferred deal to get information about.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::PreferredDeal] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::PreferredDeal]
#
# @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_account_preferred_deal(account_id, deal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/preferreddeals/{dealId}', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeal::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeal
command.params['accountId'] = account_id unless account_id.nil?
command.params['dealId'] = deal_id unless deal_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List the preferred deals for this Ad Exchange account.
# @param [String] account_id
# Account owning the deals.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::PreferredDeals] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::PreferredDeals]
#
# @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_account_preferred_deals(account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/preferreddeals', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::PreferredDeals::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::PreferredDeals
command.params['accountId'] = account_id unless account_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Generate an Ad Exchange report based on the report request sent in the query
# parameters. Returns the result as JSON; to retrieve output in CSV format
# specify "alt=csv" as a query parameter.
# @param [String] account_id
# Account which owns the generated report.
# @param [String] start_date
# Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
# @param [String] end_date
# End of the date range to report on in "YYYY-MM-DD" format, inclusive.
# @param [Array<String>, String] dimension
# Dimensions to base the report on.
# @param [Array<String>, String] filter
# Filters to be run on the report.
# @param [String] locale
# Optional locale to use for translating report output to a local language.
# Defaults to "en_US" if not specified.
# @param [Fixnum] max_results
# The maximum number of rows of report data to return.
# @param [Array<String>, String] metric
# Numeric columns to include in the report.
# @param [Array<String>, String] sort
# The name of a dimension or metric to sort the resulting report on, optionally
# prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is
# specified, the column is sorted ascending.
# @param [Fixnum] start_index
# Index of the first row of report data to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [IO, String] download_dest
# IO stream or filename to receive content download
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::Report] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::Report]
#
# @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 generate_account_report(account_id, start_date, end_date, dimension: nil, filter: nil, locale: nil, max_results: nil, metric: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
if download_dest.nil?
command = make_simple_command(:get, 'accounts/{accountId}/reports', options)
else
command = make_download_command(:get, 'accounts/{accountId}/reports', options)
command.download_dest = download_dest
end
command.response_representation = Google::Apis::AdexchangesellerV2_0::Report::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::Report
command.params['accountId'] = account_id unless account_id.nil?
command.query['dimension'] = dimension unless dimension.nil?
command.query['endDate'] = end_date unless end_date.nil?
command.query['filter'] = filter unless filter.nil?
command.query['locale'] = locale unless locale.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['metric'] = metric unless metric.nil?
command.query['sort'] = sort unless sort.nil?
command.query['startDate'] = start_date unless start_date.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Generate an Ad Exchange report based on the saved report ID sent in the query
# parameters.
# @param [String] account_id
# Account owning the saved report.
# @param [String] saved_report_id
# The saved report to retrieve.
# @param [String] locale
# Optional locale to use for translating report output to a local language.
# Defaults to "en_US" if not specified.
# @param [Fixnum] max_results
# The maximum number of rows of report data to return.
# @param [Fixnum] start_index
# Index of the first row of report data to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::Report] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::Report]
#
# @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 generate_account_saved_report(account_id, saved_report_id, locale: nil, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/reports/{savedReportId}', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::Report::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::Report
command.params['accountId'] = account_id unless account_id.nil?
command.params['savedReportId'] = saved_report_id unless saved_report_id.nil?
command.query['locale'] = locale unless locale.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['startIndex'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all saved reports in this Ad Exchange account.
# @param [String] account_id
# Account owning the saved reports.
# @param [Fixnum] max_results
# The maximum number of saved reports to include in the response, used for
# paging.
# @param [String] page_token
# A continuation token, used to page through saved reports. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::SavedReports] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::SavedReports]
#
# @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_account_saved_reports(account_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/reports/saved', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::SavedReports::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::SavedReports
command.params['accountId'] = account_id unless account_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# List all URL channels in the specified ad client for this Ad Exchange account.
# @param [String] account_id
# Account to which the ad client belongs.
# @param [String] ad_client_id
# Ad client for which to list URL channels.
# @param [Fixnum] max_results
# The maximum number of URL channels to include in the response, used for paging.
# @param [String] page_token
# A continuation token, used to page through URL channels. To retrieve the next
# page, set this parameter to the value of "nextPageToken" from the previous
# response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AdexchangesellerV2_0::UrlChannels] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AdexchangesellerV2_0::UrlChannels]
#
# @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_account_url_channels(account_id, ad_client_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'accounts/{accountId}/adclients/{adClientId}/urlchannels', options)
command.response_representation = Google::Apis::AdexchangesellerV2_0::UrlChannels::Representation
command.response_class = Google::Apis::AdexchangesellerV2_0::UrlChannels
command.params['accountId'] = account_id unless account_id.nil?
command.params['adClientId'] = ad_client_id unless ad_client_id.nil?
command.query['maxResults'] = max_results unless max_results.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?
command.query['userIp'] = user_ip unless user_ip.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?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end
end
end
generated/google/apis/admin_directory_v1.rb
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/admin-sdk/directory/
module AdminDirectoryV1
VERSION = 'DirectoryV1'
REVISION = '20180705'
REVISION = '20180911'
# View and manage customer related information
AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer'
generated/google/apis/admin_directory_v1/classes.rb
+8 -2
View File
@@ -1527,6 +1527,11 @@ module Google
class Member
include Google::Apis::Core::Hashable
# Delivery settings of member
# Corresponds to the JSON property `delivery_settings`
# @return [String]
attr_accessor :delivery_settings
# Email of member (Read-only)
# Corresponds to the JSON property `email`
# @return [String]
@@ -1569,6 +1574,7 @@ module Google
# Update properties of this object
def update!(**args)
@delivery_settings = args[:delivery_settings] if args.key?(:delivery_settings)
@email = args[:email] if args.key?(:email)
@etag = args[:etag] if args.key?(:etag)
@id = args[:id] if args.key?(:id)
@@ -2896,7 +2902,7 @@ module Google
# @return [Array<String>]
attr_accessor :aliases
# Indicates if user is archived
# Indicates if user is archived.
# Corresponds to the JSON property `archived`
# @return [Boolean]
attr_accessor :archived
@@ -3085,7 +3091,7 @@ module Google
# @return [Object]
attr_accessor :ssh_public_keys
# Indicates if user is suspended
# Indicates if user is suspended.
# Corresponds to the JSON property `suspended`
# @return [Boolean]
attr_accessor :suspended
generated/google/apis/admin_directory_v1/representations.rb
+1
View File
@@ -889,6 +889,7 @@ module Google
class Member
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :delivery_settings, as: 'delivery_settings'
property :email, as: 'email'
property :etag, as: 'etag'
property :id, as: 'id'
generated/google/apis/dataproc_v1.rb
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/dataproc/
module DataprocV1
VERSION = 'V1'
REVISION = '20180824'
REVISION = '20180910'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
generated/google/apis/dataproc_v1/classes.rb
+475
View File
@@ -423,6 +423,33 @@ module Google
end
end
# A selector that chooses target cluster for jobs based on metadata.
class ClusterSelector
include Google::Apis::Core::Hashable
# Required. The cluster labels. Cluster must have all labels to match.
# Corresponds to the JSON property `clusterLabels`
# @return [Hash<String,String>]
attr_accessor :cluster_labels
# Optional. The zone where workflow process executes. This parameter does not
# affect the selection of the cluster.If unspecified, the zone of the first
# cluster matching the selector is used.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cluster_labels = args[:cluster_labels] if args.key?(:cluster_labels)
@zone = args[:zone] if args.key?(:zone)
end
end
# The status of a cluster and its instances.
class ClusterStatus
include Google::Apis::Core::Hashable
@@ -945,6 +972,46 @@ module Google
end
end
# A request to instantiate a workflow template.
class InstantiateWorkflowTemplateRequest
include Google::Apis::Core::Hashable
# Optional. Map from parameter names to values that should be used for those
# parameters.
# Corresponds to the JSON property `parameters`
# @return [Hash<String,String>]
attr_accessor :parameters
# Optional. A tag that prevents multiple concurrent workflow instances with the
# same tag from running. This mitigates risk of concurrent instances started due
# to retries.It is recommended to always set this value to a UUID (https://en.
# wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only
# letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
# maximum length is 40 characters.
# Corresponds to the JSON property `requestId`
# @return [String]
attr_accessor :request_id
# Optional. The version of workflow template to instantiate. If specified, the
# workflow will be instantiated only if the current version of the workflow
# template has the supplied version.This option cannot be used to instantiate a
# previous version of workflow template.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@parameters = args[:parameters] if args.key?(:parameters)
@request_id = args[:request_id] if args.key?(:request_id)
@version = args[:version] if args.key?(:version)
end
end
# A Cloud Dataproc job resource.
class Job
include Google::Apis::Core::Hashable
@@ -1260,6 +1327,33 @@ module Google
end
end
# A response to a request to list workflow templates in a project.
class ListWorkflowTemplatesResponse
include Google::Apis::Core::Hashable
# Output only. This token is included in the response if there are more results
# to fetch. To fetch additional results, provide this value as the page_token in
# a subsequent <code>ListWorkflowTemplatesRequest</code>.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# Output only. WorkflowTemplates list.
# Corresponds to the JSON property `templates`
# @return [Array<Google::Apis::DataprocV1::WorkflowTemplate>]
attr_accessor :templates
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)
@templates = args[:templates] if args.key?(:templates)
end
end
# The runtime logging config of the job.
class LoggingConfig
include Google::Apis::Core::Hashable
@@ -1281,6 +1375,44 @@ module Google
end
end
# Cluster that is managed by the workflow.
class ManagedCluster
include Google::Apis::Core::Hashable
# Required. The cluster name prefix. A unique cluster name will be formed by
# appending a random suffix.The name must contain only lower-case letters (a-z),
# numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end
# with hyphen. Must consist of between 2 and 35 characters.
# Corresponds to the JSON property `clusterName`
# @return [String]
attr_accessor :cluster_name
# The cluster config.
# Corresponds to the JSON property `config`
# @return [Google::Apis::DataprocV1::ClusterConfig]
attr_accessor :config
# Optional. The labels to associate with this cluster.Label keys must be between
# 1 and 63 characters long, and must conform to the following PCRE regular
# expression: \p`Ll`\p`Lo``0,62`Label values must be between 1 and 63 characters
# long, and must conform to the following PCRE regular expression: \p`Ll`\p`Lo`\
# p`N`_-`0,63`No more than 32 labels can be associated with a given cluster.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cluster_name = args[:cluster_name] if args.key?(:cluster_name)
@config = args[:config] if args.key?(:config)
@labels = args[:labels] if args.key?(:labels)
end
end
# Specifies the resources used to actively manage an instance group.
class ManagedGroupConfig
include Google::Apis::Core::Hashable
@@ -1426,6 +1558,122 @@ module Google
end
end
# A job executed by the workflow.
class OrderedJob
include Google::Apis::Core::Hashable
# A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.
# apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/
# MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/
# docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).
# Corresponds to the JSON property `hadoopJob`
# @return [Google::Apis::DataprocV1::HadoopJob]
attr_accessor :hadoop_job
# A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/)
# queries on YARN.
# Corresponds to the JSON property `hiveJob`
# @return [Google::Apis::DataprocV1::HiveJob]
attr_accessor :hive_job
# Optional. The labels to associate with this job.Label keys must be between 1
# and 63 characters long, and must conform to the following regular expression: \
# p`Ll`\p`Lo``0,62`Label values must be between 1 and 63 characters long, and
# must conform to the following regular expression: \p`Ll`\p`Lo`\p`N`_-`0,63`No
# more than 32 labels can be associated with a given job.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries
# on YARN.
# Corresponds to the JSON property `pigJob`
# @return [Google::Apis::DataprocV1::PigJob]
attr_accessor :pig_job
# Optional. The optional list of prerequisite job step_ids. If not specified,
# the job will start at the beginning of workflow.
# Corresponds to the JSON property `prerequisiteStepIds`
# @return [Array<String>]
attr_accessor :prerequisite_step_ids
# A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/
# 0.9.0/python-programming-guide.html) applications on YARN.
# Corresponds to the JSON property `pysparkJob`
# @return [Google::Apis::DataprocV1::PySparkJob]
attr_accessor :pyspark_job
# Job scheduling options.
# Corresponds to the JSON property `scheduling`
# @return [Google::Apis::DataprocV1::JobScheduling]
attr_accessor :scheduling
# A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/)
# applications on YARN.
# Corresponds to the JSON property `sparkJob`
# @return [Google::Apis::DataprocV1::SparkJob]
attr_accessor :spark_job
# A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/
# ) queries.
# Corresponds to the JSON property `sparkSqlJob`
# @return [Google::Apis::DataprocV1::SparkSqlJob]
attr_accessor :spark_sql_job
# Required. The step id. The id must be unique among all jobs within the
# template.The step id is used as prefix for job id, as job goog-dataproc-
# workflow-step-id label, and in prerequisiteStepIds field from other steps.The
# id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and
# hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of
# between 3 and 50 characters.
# Corresponds to the JSON property `stepId`
# @return [String]
attr_accessor :step_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hadoop_job = args[:hadoop_job] if args.key?(:hadoop_job)
@hive_job = args[:hive_job] if args.key?(:hive_job)
@labels = args[:labels] if args.key?(:labels)
@pig_job = args[:pig_job] if args.key?(:pig_job)
@prerequisite_step_ids = args[:prerequisite_step_ids] if args.key?(:prerequisite_step_ids)
@pyspark_job = args[:pyspark_job] if args.key?(:pyspark_job)
@scheduling = args[:scheduling] if args.key?(:scheduling)
@spark_job = args[:spark_job] if args.key?(:spark_job)
@spark_sql_job = args[:spark_sql_job] if args.key?(:spark_sql_job)
@step_id = args[:step_id] if args.key?(:step_id)
end
end
# Configuration for parameter validation.
class ParameterValidation
include Google::Apis::Core::Hashable
# Validation based on regular expressions.
# Corresponds to the JSON property `regex`
# @return [Google::Apis::DataprocV1::RegexValidation]
attr_accessor :regex
# Validation based on a list of allowed values.
# Corresponds to the JSON property `values`
# @return [Google::Apis::DataprocV1::ValueValidation]
attr_accessor :values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@regex = args[:regex] if args.key?(:regex)
@values = args[:values] if args.key?(:values)
end
end
# A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries
# on YARN.
class PigJob
@@ -1667,6 +1915,27 @@ module Google
end
end
# Validation based on regular expressions.
class RegexValidation
include Google::Apis::Core::Hashable
# Required. RE2 regular expressions used to validate the parameter's value. The
# value must match the regex in its entirety (substring matches are not
# sufficient).
# Corresponds to the JSON property `regexes`
# @return [Array<String>]
attr_accessor :regexes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@regexes = args[:regexes] if args.key?(:regexes)
end
end
# Request message for SetIamPolicy method.
class SetIamPolicyRequest
include Google::Apis::Core::Hashable
@@ -1982,6 +2251,82 @@ module Google
end
end
# A configurable parameter that replaces one or more fields in the template.
# Parameterizable fields: - Labels - File uris - Job properties - Job arguments -
# Script variables - Main class (in HadoopJob and SparkJob) - Zone (in
# ClusterSelector)
class TemplateParameter
include Google::Apis::Core::Hashable
# Optional. Brief description of the parameter. Must not exceed 1024 characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Required. Paths to all fields that the parameter replaces. A field is allowed
# to appear in at most one parameter's list of field paths.A field path is
# similar in syntax to a google.protobuf.FieldMask. For example, a field path
# that references the zone field of a workflow template's cluster selector would
# be specified as <code>placement.clusterSelector.zone</code>.Also, field paths
# can reference fields using the following syntax:
# Values in maps can be referenced by key. Examples<br>
# labels'key'
# placement.clusterSelector.clusterLabels'key'
# placement.managedCluster.labels'key'
# placement.clusterSelector.clusterLabels'key'
# jobsstep-id.labels'key'
# Jobs in the jobs list can be referenced by step-id. Examples:<br>
# jobsstep-id.hadoopJob.mainJarFileUri
# jobsstep-id.hiveJob.queryFileUri
# jobsstep-id.pySparkJob.mainPythonFileUri
# jobsstep-id.hadoopJob.jarFileUris0
# jobsstep-id.hadoopJob.archiveUris0
# jobsstep-id.hadoopJob.fileUris0
# jobsstep-id.pySparkJob.pythonFileUris0
# Items in repeated fields can be referenced by a zero-based index. Example:<br>
# jobsstep-id.sparkJob.args0
# Other examples:
# jobsstep-id.hadoopJob.properties'key'
# jobsstep-id.hadoopJob.args0
# jobsstep-id.hiveJob.scriptVariables'key'
# jobsstep-id.hadoopJob.mainJarFileUri
# placement.clusterSelector.zoneIt may not be possible to parameterize maps and
# repeated fields in their entirety since only individual map values and
# individual items in repeated fields can be referenced. For example, the
# following field paths are invalid:
# placement.clusterSelector.clusterLabels
# jobsstep-id.sparkJob.args
# Corresponds to the JSON property `fields`
# @return [Array<String>]
attr_accessor :fields
# Required. Parameter name. The parameter name is used as the key, and paired
# with the parameter value, which are passed to the template when the template
# is instantiated. The name must contain only capital letters (A-Z), numbers (0-
# 9), and underscores (_), and must not start with a number. The maximum length
# is 40 characters.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Configuration for parameter validation.
# Corresponds to the JSON property `validation`
# @return [Google::Apis::DataprocV1::ParameterValidation]
attr_accessor :validation
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@fields = args[:fields] if args.key?(:fields)
@name = args[:name] if args.key?(:name)
@validation = args[:validation] if args.key?(:validation)
end
end
# Request message for TestIamPermissions method.
class TestIamPermissionsRequest
include Google::Apis::Core::Hashable
@@ -2022,6 +2367,25 @@ module Google
end
end
# Validation based on a list of allowed values.
class ValueValidation
include Google::Apis::Core::Hashable
# Required. List of allowed values for the parameter.
# Corresponds to the JSON property `values`
# @return [Array<String>]
attr_accessor :values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@values = args[:values] if args.key?(:values)
end
end
# The workflow graph.
class WorkflowGraph
include Google::Apis::Core::Hashable
@@ -2145,6 +2509,117 @@ module Google
end
end
# A Cloud Dataproc workflow template resource.
class WorkflowTemplate
include Google::Apis::Core::Hashable
# Output only. The time template was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Required. The template id.The id must contain only letters (a-z, A-Z), numbers
# (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore
# or hyphen. Must consist of between 3 and 50 characters.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Required. The Directed Acyclic Graph of Jobs to submit.
# Corresponds to the JSON property `jobs`
# @return [Array<Google::Apis::DataprocV1::OrderedJob>]
attr_accessor :jobs
# Optional. The labels to associate with this template. These labels will be
# propagated to all jobs and clusters created by the workflow instance.Label
# keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://
# www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must
# contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/
# rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Output only. The "resource name" of the template, as described in https://
# cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Optional. Template parameters whose values are substituted into the template.
# Values for parameters must be provided when the template is instantiated.
# Corresponds to the JSON property `parameters`
# @return [Array<Google::Apis::DataprocV1::TemplateParameter>]
attr_accessor :parameters
# Specifies workflow execution target.Either managed_cluster or cluster_selector
# is required.
# Corresponds to the JSON property `placement`
# @return [Google::Apis::DataprocV1::WorkflowTemplatePlacement]
attr_accessor :placement
# Output only. The time template was last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
# Optional. Used to perform a consistent read-modify-write.This field should be
# left blank for a CreateWorkflowTemplate request. It is required for an
# UpdateWorkflowTemplate request, and must match the current server version. A
# typical update template flow would fetch the current template with a
# GetWorkflowTemplate request, which will return the current template with the
# version field filled in with the current server version. The user updates
# other fields in the template, then returns it as part of the
# UpdateWorkflowTemplate request.
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@id = args[:id] if args.key?(:id)
@jobs = args[:jobs] if args.key?(:jobs)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@parameters = args[:parameters] if args.key?(:parameters)
@placement = args[:placement] if args.key?(:placement)
@update_time = args[:update_time] if args.key?(:update_time)
@version = args[:version] if args.key?(:version)
end
end
# Specifies workflow execution target.Either managed_cluster or cluster_selector
# is required.
class WorkflowTemplatePlacement
include Google::Apis::Core::Hashable
# A selector that chooses target cluster for jobs based on metadata.
# Corresponds to the JSON property `clusterSelector`
# @return [Google::Apis::DataprocV1::ClusterSelector]
attr_accessor :cluster_selector
# Cluster that is managed by the workflow.
# Corresponds to the JSON property `managedCluster`
# @return [Google::Apis::DataprocV1::ManagedCluster]
attr_accessor :managed_cluster
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cluster_selector = args[:cluster_selector] if args.key?(:cluster_selector)
@managed_cluster = args[:managed_cluster] if args.key?(:managed_cluster)
end
end
# A YARN application created by a job. Application information is a subset of <
# code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
# Beta Feature: This report is available for testing purposes only. It may be
generated/google/apis/dataproc_v1/representations.rb
+188
View File
@@ -76,6 +76,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ClusterSelector
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ClusterStatus
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -148,6 +154,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class InstantiateWorkflowTemplateRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Job
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -196,12 +208,24 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ListWorkflowTemplatesResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class LoggingConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ManagedCluster
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ManagedGroupConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -220,6 +244,18 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class OrderedJob
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ParameterValidation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class PigJob
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -244,6 +280,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class RegexValidation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SetIamPolicyRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -280,6 +322,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class TemplateParameter
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class TestIamPermissionsRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -292,6 +340,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class ValueValidation
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class WorkflowGraph
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -310,6 +364,18 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class WorkflowTemplate
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class WorkflowTemplatePlacement
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class YarnApplication
class Representation < Google::Apis::Core::JsonRepresentation; end
@@ -422,6 +488,14 @@ module Google
end
end
class ClusterSelector
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :cluster_labels, as: 'clusterLabels'
property :zone, as: 'zone'
end
end
class ClusterStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -542,6 +616,15 @@ module Google
end
end
class InstantiateWorkflowTemplateRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
hash :parameters, as: 'parameters'
property :request_id, as: 'requestId'
property :version, as: 'version'
end
end
class Job
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -635,6 +718,15 @@ module Google
end
end
class ListWorkflowTemplatesResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :templates, as: 'templates', class: Google::Apis::DataprocV1::WorkflowTemplate, decorator: Google::Apis::DataprocV1::WorkflowTemplate::Representation
end
end
class LoggingConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -642,6 +734,16 @@ module Google
end
end
class ManagedCluster
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :cluster_name, as: 'clusterName'
property :config, as: 'config', class: Google::Apis::DataprocV1::ClusterConfig, decorator: Google::Apis::DataprocV1::ClusterConfig::Representation
hash :labels, as: 'labels'
end
end
class ManagedGroupConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -670,6 +772,39 @@ module Google
end
end
class OrderedJob
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :hadoop_job, as: 'hadoopJob', class: Google::Apis::DataprocV1::HadoopJob, decorator: Google::Apis::DataprocV1::HadoopJob::Representation
property :hive_job, as: 'hiveJob', class: Google::Apis::DataprocV1::HiveJob, decorator: Google::Apis::DataprocV1::HiveJob::Representation
hash :labels, as: 'labels'
property :pig_job, as: 'pigJob', class: Google::Apis::DataprocV1::PigJob, decorator: Google::Apis::DataprocV1::PigJob::Representation
collection :prerequisite_step_ids, as: 'prerequisiteStepIds'
property :pyspark_job, as: 'pysparkJob', class: Google::Apis::DataprocV1::PySparkJob, decorator: Google::Apis::DataprocV1::PySparkJob::Representation
property :scheduling, as: 'scheduling', class: Google::Apis::DataprocV1::JobScheduling, decorator: Google::Apis::DataprocV1::JobScheduling::Representation
property :spark_job, as: 'sparkJob', class: Google::Apis::DataprocV1::SparkJob, decorator: Google::Apis::DataprocV1::SparkJob::Representation
property :spark_sql_job, as: 'sparkSqlJob', class: Google::Apis::DataprocV1::SparkSqlJob, decorator: Google::Apis::DataprocV1::SparkSqlJob::Representation
property :step_id, as: 'stepId'
end
end
class ParameterValidation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :regex, as: 'regex', class: Google::Apis::DataprocV1::RegexValidation, decorator: Google::Apis::DataprocV1::RegexValidation::Representation
property :values, as: 'values', class: Google::Apis::DataprocV1::ValueValidation, decorator: Google::Apis::DataprocV1::ValueValidation::Representation
end
end
class PigJob
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -717,6 +852,13 @@ module Google
end
end
class RegexValidation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :regexes, as: 'regexes'
end
end
class SetIamPolicyRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -780,6 +922,17 @@ module Google
end
end
class TemplateParameter
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :description, as: 'description'
collection :fields, as: 'fields'
property :name, as: 'name'
property :validation, as: 'validation', class: Google::Apis::DataprocV1::ParameterValidation, decorator: Google::Apis::DataprocV1::ParameterValidation::Representation
end
end
class TestIamPermissionsRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -794,6 +947,13 @@ module Google
end
end
class ValueValidation
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :values, as: 'values'
end
end
class WorkflowGraph
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@@ -830,6 +990,34 @@ module Google
end
end
class WorkflowTemplate
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :create_time, as: 'createTime'
property :id, as: 'id'
collection :jobs, as: 'jobs', class: Google::Apis::DataprocV1::OrderedJob, decorator: Google::Apis::DataprocV1::OrderedJob::Representation
hash :labels, as: 'labels'
property :name, as: 'name'
collection :parameters, as: 'parameters', class: Google::Apis::DataprocV1::TemplateParameter, decorator: Google::Apis::DataprocV1::TemplateParameter::Representation
property :placement, as: 'placement', class: Google::Apis::DataprocV1::WorkflowTemplatePlacement, decorator: Google::Apis::DataprocV1::WorkflowTemplatePlacement::Representation
property :update_time, as: 'updateTime'
property :version, as: 'version'
end
end
class WorkflowTemplatePlacement
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :cluster_selector, as: 'clusterSelector', class: Google::Apis::DataprocV1::ClusterSelector, decorator: Google::Apis::DataprocV1::ClusterSelector::Representation
property :managed_cluster, as: 'managedCluster', class: Google::Apis::DataprocV1::ManagedCluster, decorator: Google::Apis::DataprocV1::ManagedCluster::Representation
end
end
class YarnApplication
# @private
class Representation < Google::Apis::Core::JsonRepresentation
generated/google/apis/dataproc_v1/service.rb
+550
View File
@@ -47,6 +47,115 @@ module Google
@batch_path = 'batch'
end
# Creates new workflow template.
# @param [String] parent
# Required. The "resource name" of the region, as described in https://cloud.
# google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`
# @param [Google::Apis::DataprocV1::WorkflowTemplate] workflow_template_object
# @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::DataprocV1::WorkflowTemplate] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::WorkflowTemplate]
#
# @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 create_project_location_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates', options)
command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.request_object = workflow_template_object
command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.response_class = Google::Apis::DataprocV1::WorkflowTemplate
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a workflow template. It does not cancel in-progress workflows.
# @param [String] name
# Required. The "resource name" of the workflow template, as described in https:/
# /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Fixnum] version
# Optional. The version of workflow template to delete. If specified, will only
# delete the template if the current server version matches specified version.
# @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::DataprocV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::Empty]
#
# @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 delete_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataprocV1::Empty::Representation
command.response_class = Google::Apis::DataprocV1::Empty
command.params['name'] = name unless name.nil?
command.query['version'] = version unless version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the latest workflow template.Can retrieve previously instantiated
# template by specifying optional version parameter.
# @param [String] name
# Required. The "resource name" of the workflow template, as described in https:/
# /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Fixnum] version
# Optional. The version of workflow template to retrieve. Only previously
# instatiated versions can be retrieved.If unspecified, retrieves the current
# version.
# @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::DataprocV1::WorkflowTemplate] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::WorkflowTemplate]
#
# @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_project_location_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.response_class = Google::Apis::DataprocV1::WorkflowTemplate
command.params['name'] = name unless name.nil?
command.query['version'] = version unless version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
@@ -82,6 +191,136 @@ module Google
execute_or_queue_command(command, &block)
end
# Instantiates a template and begins execution.The returned Operation can be
# used to track execution of workflow by polling operations.get. The Operation
# will complete when entire workflow is finished.The running workflow can be
# aborted via operations.cancel. This will cause any inflight jobs to be
# cancelled and workflow-owned clusters to be deleted.The Operation.metadata
# will be WorkflowMetadata.On successful completion, Operation.response will be
# Empty.
# @param [String] name
# Required. The "resource name" of the workflow template, as described in https:/
# /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Google::Apis::DataprocV1::InstantiateWorkflowTemplateRequest] instantiate_workflow_template_request_object
# @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::DataprocV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::Operation]
#
# @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 instantiate_project_location_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:instantiate', options)
command.request_representation = Google::Apis::DataprocV1::InstantiateWorkflowTemplateRequest::Representation
command.request_object = instantiate_workflow_template_request_object
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
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
# Instantiates a template and begins execution.This method is equivalent to
# executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate,
# DeleteWorkflowTemplate.The returned Operation can be used to track execution
# of workflow by polling operations.get. The Operation will complete when entire
# workflow is finished.The running workflow can be aborted via operations.cancel.
# This will cause any inflight jobs to be cancelled and workflow-owned clusters
# to be deleted.The Operation.metadata will be WorkflowMetadata.On successful
# completion, Operation.response will be Empty.
# @param [String] parent
# Required. The "resource name" of the workflow template region, as described in
# https://cloud.google.com/apis/design/resource_names of the form projects/`
# project_id`/regions/`region`
# @param [Google::Apis::DataprocV1::WorkflowTemplate] workflow_template_object
# @param [String] request_id
# Optional. A tag that prevents multiple concurrent workflow instances with the
# same tag from running. This mitigates risk of concurrent instances started due
# to retries.It is recommended to always set this value to a UUID (https://en.
# wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only
# letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
# maximum length is 40 characters.
# @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::DataprocV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::Operation]
#
# @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 instantiate_project_location_workflow_template_inline(parent, workflow_template_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates:instantiateInline', options)
command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.request_object = workflow_template_object
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
command.params['parent'] = parent unless parent.nil?
command.query['requestId'] = request_id unless request_id.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 workflows that match the specified filter in the request.
# @param [String] parent
# Required. The "resource name" of the region, as described in https://cloud.
# google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`
# @param [Fixnum] page_size
# Optional. The maximum number of results to return in each response.
# @param [String] page_token
# Optional. The page token, returned by a previous call, to request the next
# page of results.
# @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::DataprocV1::ListWorkflowTemplatesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::ListWorkflowTemplatesResponse]
#
# @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_project_location_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/workflowTemplates', options)
command.response_representation = Google::Apis::DataprocV1::ListWorkflowTemplatesResponse::Representation
command.response_class = Google::Apis::DataprocV1::ListWorkflowTemplatesResponse
command.params['parent'] = parent unless parent.nil?
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
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# @param [String] resource
@@ -155,6 +394,42 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates (replaces) workflow template. The updated template must contain
# version that matches the current server version.
# @param [String] name
# Output only. The "resource name" of the template, as described in https://
# cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Google::Apis::DataprocV1::WorkflowTemplate] workflow_template_object
# @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::DataprocV1::WorkflowTemplate] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::WorkflowTemplate]
#
# @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 update_project_location_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.request_object = workflow_template_object
command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.response_class = Google::Apis::DataprocV1::WorkflowTemplate
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
# Creates a cluster in a project.
# @param [String] project_id
# Required. The ID of the Google Cloud Platform project that the cluster belongs
@@ -1191,6 +1466,115 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates new workflow template.
# @param [String] parent
# Required. The "resource name" of the region, as described in https://cloud.
# google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`
# @param [Google::Apis::DataprocV1::WorkflowTemplate] workflow_template_object
# @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::DataprocV1::WorkflowTemplate] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::WorkflowTemplate]
#
# @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 create_project_region_workflow_template(parent, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates', options)
command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.request_object = workflow_template_object
command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.response_class = Google::Apis::DataprocV1::WorkflowTemplate
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a workflow template. It does not cancel in-progress workflows.
# @param [String] name
# Required. The "resource name" of the workflow template, as described in https:/
# /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Fixnum] version
# Optional. The version of workflow template to delete. If specified, will only
# delete the template if the current server version matches specified version.
# @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::DataprocV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::Empty]
#
# @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 delete_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataprocV1::Empty::Representation
command.response_class = Google::Apis::DataprocV1::Empty
command.params['name'] = name unless name.nil?
command.query['version'] = version unless version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the latest workflow template.Can retrieve previously instantiated
# template by specifying optional version parameter.
# @param [String] name
# Required. The "resource name" of the workflow template, as described in https:/
# /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Fixnum] version
# Optional. The version of workflow template to retrieve. Only previously
# instatiated versions can be retrieved.If unspecified, retrieves the current
# version.
# @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::DataprocV1::WorkflowTemplate] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::WorkflowTemplate]
#
# @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_project_region_workflow_template(name, version: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.response_class = Google::Apis::DataprocV1::WorkflowTemplate
command.params['name'] = name unless name.nil?
command.query['version'] = version unless version.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
@@ -1226,6 +1610,136 @@ module Google
execute_or_queue_command(command, &block)
end
# Instantiates a template and begins execution.The returned Operation can be
# used to track execution of workflow by polling operations.get. The Operation
# will complete when entire workflow is finished.The running workflow can be
# aborted via operations.cancel. This will cause any inflight jobs to be
# cancelled and workflow-owned clusters to be deleted.The Operation.metadata
# will be WorkflowMetadata.On successful completion, Operation.response will be
# Empty.
# @param [String] name
# Required. The "resource name" of the workflow template, as described in https:/
# /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Google::Apis::DataprocV1::InstantiateWorkflowTemplateRequest] instantiate_workflow_template_request_object
# @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::DataprocV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::Operation]
#
# @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 instantiate_project_region_workflow_template(name, instantiate_workflow_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:instantiate', options)
command.request_representation = Google::Apis::DataprocV1::InstantiateWorkflowTemplateRequest::Representation
command.request_object = instantiate_workflow_template_request_object
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
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
# Instantiates a template and begins execution.This method is equivalent to
# executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate,
# DeleteWorkflowTemplate.The returned Operation can be used to track execution
# of workflow by polling operations.get. The Operation will complete when entire
# workflow is finished.The running workflow can be aborted via operations.cancel.
# This will cause any inflight jobs to be cancelled and workflow-owned clusters
# to be deleted.The Operation.metadata will be WorkflowMetadata.On successful
# completion, Operation.response will be Empty.
# @param [String] parent
# Required. The "resource name" of the workflow template region, as described in
# https://cloud.google.com/apis/design/resource_names of the form projects/`
# project_id`/regions/`region`
# @param [Google::Apis::DataprocV1::WorkflowTemplate] workflow_template_object
# @param [String] request_id
# Optional. A tag that prevents multiple concurrent workflow instances with the
# same tag from running. This mitigates risk of concurrent instances started due
# to retries.It is recommended to always set this value to a UUID (https://en.
# wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only
# letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The
# maximum length is 40 characters.
# @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::DataprocV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::Operation]
#
# @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 instantiate_project_region_workflow_template_inline(parent, workflow_template_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/workflowTemplates:instantiateInline', options)
command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.request_object = workflow_template_object
command.response_representation = Google::Apis::DataprocV1::Operation::Representation
command.response_class = Google::Apis::DataprocV1::Operation
command.params['parent'] = parent unless parent.nil?
command.query['requestId'] = request_id unless request_id.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 workflows that match the specified filter in the request.
# @param [String] parent
# Required. The "resource name" of the region, as described in https://cloud.
# google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`
# @param [Fixnum] page_size
# Optional. The maximum number of results to return in each response.
# @param [String] page_token
# Optional. The page token, returned by a previous call, to request the next
# page of results.
# @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::DataprocV1::ListWorkflowTemplatesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::ListWorkflowTemplatesResponse]
#
# @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_project_region_workflow_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/workflowTemplates', options)
command.response_representation = Google::Apis::DataprocV1::ListWorkflowTemplatesResponse::Representation
command.response_class = Google::Apis::DataprocV1::ListWorkflowTemplatesResponse
command.params['parent'] = parent unless parent.nil?
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
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# @param [String] resource
@@ -1298,6 +1812,42 @@ module Google
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates (replaces) workflow template. The updated template must contain
# version that matches the current server version.
# @param [String] name
# Output only. The "resource name" of the template, as described in https://
# cloud.google.com/apis/design/resource_names of the form projects/`project_id`/
# regions/`region`/workflowTemplates/`template_id`
# @param [Google::Apis::DataprocV1::WorkflowTemplate] workflow_template_object
# @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::DataprocV1::WorkflowTemplate] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1::WorkflowTemplate]
#
# @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 update_project_region_workflow_template(name, workflow_template_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1/{+name}', options)
command.request_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.request_object = workflow_template_object
command.response_representation = Google::Apis::DataprocV1::WorkflowTemplate::Representation
command.response_class = Google::Apis::DataprocV1::WorkflowTemplate
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
protected
generated/google/apis/sqladmin_v1beta4.rb
+1 -1
View File
@@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/sql/docs/reference/latest
module SqladminV1beta4
VERSION = 'V1beta4'
REVISION = '20180907'
REVISION = '20180912'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
generated/google/apis/sqladmin_v1beta4/service.rb
+3 -3
View File
@@ -1739,11 +1739,11 @@ module Google
# Project ID of the project that contains the instance.
# @param [String] instance
# Database instance ID. This does not include the project ID.
# @param [String] host
# Host of the user in the instance.
# @param [String] name
# Name of the user in the instance.
# @param [Google::Apis::SqladminV1beta4::User] user_object
# @param [String] host
# Host of the user in the instance.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1763,7 +1763,7 @@ module Google
# @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 update_user(project, instance, host, name, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def update_user(project, instance, name, user_object = nil, host: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'projects/{project}/instances/{instance}/users', options)
command.request_representation = Google::Apis::SqladminV1beta4::User::Representation
command.request_object = user_object
generated/google/apis/testing_v1/classes.rb
+1 -8
View File
@@ -300,7 +300,7 @@ module Google
# @return [String]
attr_accessor :form
# Whether this device is a phone, tablet, wearable, etc.
# Whther this device is a phone, tablet, wearable, etc.
# @OutputOnly
# Corresponds to the JSON property `formFactor`
# @return [String]
@@ -1184,12 +1184,6 @@ module Google
# @return [Array<String>]
attr_accessor :device_capabilities
# Whether this device is a phone, tablet, wearable, etc.
# @OutputOnly
# Corresponds to the JSON property `formFactor`
# @return [String]
attr_accessor :form_factor
# Output only. The unique opaque id for this model.
# Use this for invoking the TestExecutionService.
# Corresponds to the JSON property `id`
@@ -1220,7 +1214,6 @@ module Google
# Update properties of this object
def update!(**args)
@device_capabilities = args[:device_capabilities] if args.key?(:device_capabilities)
@form_factor = args[:form_factor] if args.key?(:form_factor)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@supported_version_ids = args[:supported_version_ids] if args.key?(:supported_version_ids)
generated/google/apis/testing_v1/representations.rb
-1
View File
@@ -688,7 +688,6 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :device_capabilities, as: 'deviceCapabilities'
property :form_factor, as: 'formFactor'
property :id, as: 'id'
property :name, as: 'name'
collection :supported_version_ids, as: 'supportedVersionIds'
generated/google/apis/youtube_partner_v1.rb
+1 -1
View File
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/youtube/partner/
module YoutubePartnerV1
VERSION = 'V1'
REVISION = '20180903'
REVISION = '20180910'
# View and manage your assets and associated content on YouTube
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'