google-apis-adexchangebuyer_v1_2 0.1.0

data/lib/google/apis/adexchangebuyer_v1_2/gem_version.rb

@@ -0,0 +1,28 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Apis
+    module AdexchangebuyerV1_2
+      # Version of the google-apis-adexchangebuyer_v1_2 gem
+      GEM_VERSION = "0.1.0"
+
+      # Version of the code generator used to generate this client
+      GENERATOR_VERSION = "0.1.1"
+
+      # Revision of the discovery document this client was generated from
+      REVISION = "20180222"
+    end
+  end
+end

data/lib/google/apis/adexchangebuyer_v1_2/representations.rb

@@ -0,0 +1,189 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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 AdexchangebuyerV1_2
+      
+      class Account
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class BidderLocation
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AccountsList
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Creative
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+        class Correction
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+        
+        class DisapprovalReason
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+        
+        class FilteringReasons
+          class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+          class Reason
+            class Representation < Google::Apis::Core::JsonRepresentation; end
+          
+            include Google::Apis::Core::JsonObjectSupport
+          end
+        
+          include Google::Apis::Core::JsonObjectSupport
+        end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class CreativesList
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Account
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :bidder_location, as: 'bidderLocation', class: Google::Apis::AdexchangebuyerV1_2::Account::BidderLocation, decorator: Google::Apis::AdexchangebuyerV1_2::Account::BidderLocation::Representation
+      
+          property :cookie_matching_nid, as: 'cookieMatchingNid'
+          property :cookie_matching_url, as: 'cookieMatchingUrl'
+          property :id, as: 'id'
+          property :kind, as: 'kind'
+          property :maximum_active_creatives, as: 'maximumActiveCreatives'
+          property :maximum_total_qps, as: 'maximumTotalQps'
+          property :number_active_creatives, as: 'numberActiveCreatives'
+        end
+        
+        class BidderLocation
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :maximum_qps, as: 'maximumQps'
+            property :region, as: 'region'
+            property :url, as: 'url'
+          end
+        end
+      end
+      
+      class AccountsList
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :items, as: 'items', class: Google::Apis::AdexchangebuyerV1_2::Account, decorator: Google::Apis::AdexchangebuyerV1_2::Account::Representation
+      
+          property :kind, as: 'kind'
+        end
+      end
+      
+      class Creative
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :html_snippet, as: 'HTMLSnippet'
+          property :account_id, as: 'accountId'
+          collection :advertiser_id, as: 'advertiserId'
+          property :advertiser_name, as: 'advertiserName'
+          property :agency_id, :numeric_string => true, as: 'agencyId'
+          property :api_upload_timestamp, as: 'apiUploadTimestamp', type: DateTime
+      
+          collection :attribute, as: 'attribute'
+          property :buyer_creative_id, as: 'buyerCreativeId'
+          collection :click_through_url, as: 'clickThroughUrl'
+          collection :corrections, as: 'corrections', class: Google::Apis::AdexchangebuyerV1_2::Creative::Correction, decorator: Google::Apis::AdexchangebuyerV1_2::Creative::Correction::Representation
+      
+          collection :disapproval_reasons, as: 'disapprovalReasons', class: Google::Apis::AdexchangebuyerV1_2::Creative::DisapprovalReason, decorator: Google::Apis::AdexchangebuyerV1_2::Creative::DisapprovalReason::Representation
+      
+          property :filtering_reasons, as: 'filteringReasons', class: Google::Apis::AdexchangebuyerV1_2::Creative::FilteringReasons, decorator: Google::Apis::AdexchangebuyerV1_2::Creative::FilteringReasons::Representation
+      
+          property :height, as: 'height'
+          collection :impression_tracking_url, as: 'impressionTrackingUrl'
+          property :kind, as: 'kind'
+          collection :product_categories, as: 'productCategories'
+          collection :restricted_categories, as: 'restrictedCategories'
+          collection :sensitive_categories, as: 'sensitiveCategories'
+          property :status, as: 'status'
+          collection :vendor_type, as: 'vendorType'
+          property :version, as: 'version'
+          property :video_url, as: 'videoURL'
+          property :width, as: 'width'
+        end
+        
+        class Correction
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            collection :details, as: 'details'
+            property :reason, as: 'reason'
+          end
+        end
+        
+        class DisapprovalReason
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            collection :details, as: 'details'
+            property :reason, as: 'reason'
+          end
+        end
+        
+        class FilteringReasons
+          # @private
+          class Representation < Google::Apis::Core::JsonRepresentation
+            property :date, as: 'date'
+            collection :reasons, as: 'reasons', class: Google::Apis::AdexchangebuyerV1_2::Creative::FilteringReasons::Reason, decorator: Google::Apis::AdexchangebuyerV1_2::Creative::FilteringReasons::Reason::Representation
+        
+          end
+          
+          class Reason
+            # @private
+            class Representation < Google::Apis::Core::JsonRepresentation
+              property :filtering_count, :numeric_string => true, as: 'filteringCount'
+              property :filtering_status, as: 'filteringStatus'
+            end
+          end
+        end
+      end
+      
+      class CreativesList
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :items, as: 'items', class: Google::Apis::AdexchangebuyerV1_2::Creative, decorator: Google::Apis::AdexchangebuyerV1_2::Creative::Representation
+      
+          property :kind, as: 'kind'
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/adexchangebuyer_v1_2/service.rb

@@ -0,0 +1,315 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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 AdexchangebuyerV1_2
+      # Ad Exchange Buyer API
+      #
+      # Accesses your bidding-account information, submits creatives for validation,
+      #  finds available direct deals, and retrieves performance reports.
+      #
+      # @example
+      #    require 'google/apis/adexchangebuyer_v1_2'
+      #
+      #    Adexchangebuyer = Google::Apis::AdexchangebuyerV1_2 # Alias the module
+      #    service = Adexchangebuyer::AdExchangeBuyerService.new
+      #
+      # @see https://developers.google.com/ad-exchange/buyer-rest
+      class AdExchangeBuyerService < 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/', 'adexchangebuyer/v1.2/',
+                client_name: 'google-apis-adexchangebuyer_v1_2',
+                client_version: Google::Apis::AdexchangebuyerV1_2::GEM_VERSION)
+          @batch_path = 'batch/adexchangebuyer/v1.2'
+        end
+        
+        # Gets one account by ID.
+        # @param [Fixnum] id
+        #   The account 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::AdexchangebuyerV1_2::Account] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdexchangebuyerV1_2::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(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'accounts/{id}', options)
+          command.response_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
+          command.response_class = Google::Apis::AdexchangebuyerV1_2::Account
+          command.params['id'] = id unless 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
+        
+        # Retrieves the authenticated user's list of accounts.
+        # @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::AdexchangebuyerV1_2::AccountsList] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdexchangebuyerV1_2::AccountsList]
+        #
+        # @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(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'accounts', options)
+          command.response_representation = Google::Apis::AdexchangebuyerV1_2::AccountsList::Representation
+          command.response_class = Google::Apis::AdexchangebuyerV1_2::AccountsList
+          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
+        
+        # Updates an existing account. This method supports patch semantics.
+        # @param [Fixnum] id
+        #   The account id
+        # @param [Google::Apis::AdexchangebuyerV1_2::Account] account_object
+        # @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::AdexchangebuyerV1_2::Account] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdexchangebuyerV1_2::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 patch_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'accounts/{id}', options)
+          command.request_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
+          command.request_object = account_object
+          command.response_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
+          command.response_class = Google::Apis::AdexchangebuyerV1_2::Account
+          command.params['id'] = id unless 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
+        
+        # Updates an existing account.
+        # @param [Fixnum] id
+        #   The account id
+        # @param [Google::Apis::AdexchangebuyerV1_2::Account] account_object
+        # @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::AdexchangebuyerV1_2::Account] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdexchangebuyerV1_2::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 update_account(id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:put, 'accounts/{id}', options)
+          command.request_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
+          command.request_object = account_object
+          command.response_representation = Google::Apis::AdexchangebuyerV1_2::Account::Representation
+          command.response_class = Google::Apis::AdexchangebuyerV1_2::Account
+          command.params['id'] = id unless 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
+        
+        # Gets the status for a single creative. A creative will be available 30-40
+        # minutes after submission.
+        # @param [Fixnum] account_id
+        #   The id for the account that will serve this creative.
+        # @param [String] buyer_creative_id
+        #   The buyer-specific id for this creative.
+        # @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::AdexchangebuyerV1_2::Creative] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdexchangebuyerV1_2::Creative]
+        #
+        # @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_creative(account_id, buyer_creative_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'creatives/{accountId}/{buyerCreativeId}', options)
+          command.response_representation = Google::Apis::AdexchangebuyerV1_2::Creative::Representation
+          command.response_class = Google::Apis::AdexchangebuyerV1_2::Creative
+          command.params['accountId'] = account_id unless account_id.nil?
+          command.params['buyerCreativeId'] = buyer_creative_id unless buyer_creative_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
+        
+        # Submit a new creative.
+        # @param [Google::Apis::AdexchangebuyerV1_2::Creative] creative_object
+        # @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::AdexchangebuyerV1_2::Creative] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdexchangebuyerV1_2::Creative]
+        #
+        # @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 insert_creative(creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:post, 'creatives', options)
+          command.request_representation = Google::Apis::AdexchangebuyerV1_2::Creative::Representation
+          command.request_object = creative_object
+          command.response_representation = Google::Apis::AdexchangebuyerV1_2::Creative::Representation
+          command.response_class = Google::Apis::AdexchangebuyerV1_2::Creative
+          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
+        
+        # Retrieves a list of the authenticated user's active creatives. A creative will
+        # be available 30-40 minutes after submission.
+        # @param [Fixnum] max_results
+        #   Maximum number of entries returned on one result page. If not set, the default
+        #   is 100. Optional.
+        # @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. Optional.
+        # @param [String] status_filter
+        #   When specified, only creatives having the given status are returned.
+        # @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::AdexchangebuyerV1_2::CreativesList] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdexchangebuyerV1_2::CreativesList]
+        #
+        # @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_creatives(max_results: nil, page_token: nil, status_filter: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
+          command = make_simple_command(:get, 'creatives', options)
+          command.response_representation = Google::Apis::AdexchangebuyerV1_2::CreativesList::Representation
+          command.response_class = Google::Apis::AdexchangebuyerV1_2::CreativesList
+          command.query['maxResults'] = max_results unless max_results.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['statusFilter'] = status_filter unless status_filter.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