google-ads-googleads 0.4.0 → 0.5.0

data/lib/google/ads/googleads/v0/services/doc/google/protobuf/field_mask.rb

@@ -1,223 +0,0 @@
-# Copyright 2018 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
-#
-#     https://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 Protobuf
-    # +FieldMask+ represents a set of symbolic field paths, for example:
-    #
-    #     paths: "f.a"
-    #     paths: "f.b.d"
-    #
-    # Here +f+ represents a field in some root message, +a+ and +b+
-    # fields in the message found in +f+, and +d+ a field found in the
-    # message in +f.b+.
-    #
-    # Field masks are used to specify a subset of fields that should be
-    # returned by a get operation or modified by an update operation.
-    # Field masks also have a custom JSON encoding (see below).
-    #
-    # = Field Masks in Projections
-    #
-    # When used in the context of a projection, a response message or
-    # sub-message is filtered by the API to only contain those fields as
-    # specified in the mask. For example, if the mask in the previous
-    # example is applied to a response message as follows:
-    #
-    #     f {
-    #       a : 22
-    #       b {
-    #         d : 1
-    #         x : 2
-    #       }
-    #       y : 13
-    #     }
-    #     z: 8
-    #
-    # The result will not contain specific values for fields x,y and z
-    # (their value will be set to the default, and omitted in proto text
-    # output):
-    #
-    #
-    #     f {
-    #       a : 22
-    #       b {
-    #         d : 1
-    #       }
-    #     }
-    #
-    # A repeated field is not allowed except at the last position of a
-    # paths string.
-    #
-    # If a FieldMask object is not present in a get operation, the
-    # operation applies to all fields (as if a FieldMask of all fields
-    # had been specified).
-    #
-    # Note that a field mask does not necessarily apply to the
-    # top-level response message. In case of a REST get operation, the
-    # field mask applies directly to the response, but in case of a REST
-    # list operation, the mask instead applies to each individual message
-    # in the returned resource list. In case of a REST custom method,
-    # other definitions may be used. Where the mask applies will be
-    # clearly documented together with its declaration in the API.  In
-    # any case, the effect on the returned resource/resources is required
-    # behavior for APIs.
-    #
-    # = Field Masks in Update Operations
-    #
-    # A field mask in update operations specifies which fields of the
-    # targeted resource are going to be updated. The API is required
-    # to only change the values of the fields as specified in the mask
-    # and leave the others untouched. If a resource is passed in to
-    # describe the updated values, the API ignores the values of all
-    # fields not covered by the mask.
-    #
-    # If a repeated field is specified for an update operation, the existing
-    # repeated values in the target resource will be overwritten by the new values.
-    # Note that a repeated field is only allowed in the last position of a +paths+
-    # string.
-    #
-    # If a sub-message is specified in the last position of the field mask for an
-    # update operation, then the existing sub-message in the target resource is
-    # overwritten. Given the target message:
-    #
-    #     f {
-    #       b {
-    #         d : 1
-    #         x : 2
-    #       }
-    #       c : 1
-    #     }
-    #
-    # And an update message:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #       }
-    #     }
-    #
-    # then if the field mask is:
-    #
-    #  paths: "f.b"
-    #
-    # then the result will be:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #       }
-    #       c : 1
-    #     }
-    #
-    # However, if the update mask was:
-    #
-    #  paths: "f.b.d"
-    #
-    # then the result would be:
-    #
-    #     f {
-    #       b {
-    #         d : 10
-    #         x : 2
-    #       }
-    #       c : 1
-    #     }
-    #
-    # In order to reset a field's value to the default, the field must
-    # be in the mask and set to the default value in the provided resource.
-    # Hence, in order to reset all fields of a resource, provide a default
-    # instance of the resource and set all fields in the mask, or do
-    # not provide a mask as described below.
-    #
-    # If a field mask is not present on update, the operation applies to
-    # all fields (as if a field mask of all fields has been specified).
-    # Note that in the presence of schema evolution, this may mean that
-    # fields the client does not know and has therefore not filled into
-    # the request will be reset to their default. If this is unwanted
-    # behavior, a specific service may require a client to always specify
-    # a field mask, producing an error if not.
-    #
-    # As with get operations, the location of the resource which
-    # describes the updated values in the request message depends on the
-    # operation kind. In any case, the effect of the field mask is
-    # required to be honored by the API.
-    #
-    # == Considerations for HTTP REST
-    #
-    # The HTTP kind of an update operation which uses a field mask must
-    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
-    # (PUT must only be used for full updates).
-    #
-    # = JSON Encoding of Field Masks
-    #
-    # In JSON, a field mask is encoded as a single string where paths are
-    # separated by a comma. Fields name in each path are converted
-    # to/from lower-camel naming conventions.
-    #
-    # As an example, consider the following message declarations:
-    #
-    #     message Profile {
-    #       User user = 1;
-    #       Photo photo = 2;
-    #     }
-    #     message User {
-    #       string display_name = 1;
-    #       string address = 2;
-    #     }
-    #
-    # In proto a field mask for +Profile+ may look as such:
-    #
-    #     mask {
-    #       paths: "user.display_name"
-    #       paths: "photo"
-    #     }
-    #
-    # In JSON, the same mask is represented as below:
-    #
-    #     {
-    #       mask: "user.displayName,photo"
-    #     }
-    #
-    # = Field Masks and Oneof Fields
-    #
-    # Field masks treat fields in oneofs just as regular fields. Consider the
-    # following message:
-    #
-    #     message SampleMessage {
-    #       oneof test_oneof {
-    #         string name = 4;
-    #         SubMessage sub_message = 9;
-    #       }
-    #     }
-    #
-    # The field mask can be:
-    #
-    #     mask {
-    #       paths: "name"
-    #     }
-    #
-    # Or:
-    #
-    #     mask {
-    #       paths: "sub_message"
-    #     }
-    #
-    # Note that oneof type names ("test_oneof" in this case) cannot be used in
-    # paths.
-    # @!attribute [rw] paths
-    #   @return [Array<String>]
-    #     The set of field mask paths.
-    class FieldMask; end
-  end
-end

data/lib/google/ads/googleads/v0/services/doc/google/protobuf/wrappers.rb

@@ -1,89 +0,0 @@
-# Copyright 2018 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
-#
-#     https://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 Protobuf
-    # Wrapper message for +double+.
-    #
-    # The JSON representation for +DoubleValue+ is JSON number.
-    # @!attribute [rw] value
-    #   @return [Float]
-    #     The double value.
-    class DoubleValue; end
-
-    # Wrapper message for +float+.
-    #
-    # The JSON representation for +FloatValue+ is JSON number.
-    # @!attribute [rw] value
-    #   @return [Float]
-    #     The float value.
-    class FloatValue; end
-
-    # Wrapper message for +int64+.
-    #
-    # The JSON representation for +Int64Value+ is JSON string.
-    # @!attribute [rw] value
-    #   @return [Integer]
-    #     The int64 value.
-    class Int64Value; end
-
-    # Wrapper message for +uint64+.
-    #
-    # The JSON representation for +UInt64Value+ is JSON string.
-    # @!attribute [rw] value
-    #   @return [Integer]
-    #     The uint64 value.
-    class UInt64Value; end
-
-    # Wrapper message for +int32+.
-    #
-    # The JSON representation for +Int32Value+ is JSON number.
-    # @!attribute [rw] value
-    #   @return [Integer]
-    #     The int32 value.
-    class Int32Value; end
-
-    # Wrapper message for +uint32+.
-    #
-    # The JSON representation for +UInt32Value+ is JSON number.
-    # @!attribute [rw] value
-    #   @return [Integer]
-    #     The uint32 value.
-    class UInt32Value; end
-
-    # Wrapper message for +bool+.
-    #
-    # The JSON representation for +BoolValue+ is JSON +true+ and +false+.
-    # @!attribute [rw] value
-    #   @return [true, false]
-    #     The bool value.
-    class BoolValue; end
-
-    # Wrapper message for +string+.
-    #
-    # The JSON representation for +StringValue+ is JSON string.
-    # @!attribute [rw] value
-    #   @return [String]
-    #     The string value.
-    class StringValue; end
-
-    # Wrapper message for +bytes+.
-    #
-    # The JSON representation for +BytesValue+ is JSON string.
-    # @!attribute [rw] value
-    #   @return [String]
-    #     The bytes value.
-    class BytesValue; end
-  end
-end

data/lib/google/ads/googleads/v0/services/doc/google/rpc/status.rb

@@ -1,83 +0,0 @@
-# Copyright 2018 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
-#
-#     https://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 Rpc
-    # The +Status+ type defines a logical error model that is suitable for different
-    # programming environments, including REST APIs and RPC APIs. It is used by
-    # [gRPC](https://github.com/grpc). The error model is designed to be:
-    #
-    # * Simple to use and understand for most users
-    # * Flexible enough to meet unexpected needs
-    #
-    # = Overview
-    #
-    # The +Status+ message contains three pieces of data: error code, error message,
-    # and error details. The error code should be an enum value of
-    # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
-    # error message should be a developer-facing English message that helps
-    # developers *understand* and *resolve* the error. If a localized user-facing
-    # error message is needed, put the localized message in the error details or
-    # localize it in the client. The optional error details may contain arbitrary
-    # information about the error. There is a predefined set of error detail types
-    # in the package +google.rpc+ that can be used for common error conditions.
-    #
-    # = Language mapping
-    #
-    # The +Status+ message is the logical representation of the error model, but it
-    # is not necessarily the actual wire format. When the +Status+ message is
-    # exposed in different client libraries and different wire protocols, it can be
-    # mapped differently. For example, it will likely be mapped to some exceptions
-    # in Java, but more likely mapped to some error codes in C.
-    #
-    # = Other uses
-    #
-    # The error model and the +Status+ message can be used in a variety of
-    # environments, either with or without APIs, to provide a
-    # consistent developer experience across different environments.
-    #
-    # Example uses of this error model include:
-    #
-    # * Partial errors. If a service needs to return partial errors to the client,
-    #   it may embed the +Status+ in the normal response to indicate the partial
-    #   errors.
-    #
-    # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a +Status+ message for error reporting.
-    #
-    # * Batch operations. If a client uses batch request and batch response, the
-    #   +Status+ message should be used directly inside batch response, one for
-    #   each error sub-response.
-    #
-    # * Asynchronous operations. If an API call embeds asynchronous operation
-    #   results in its response, the status of those operations should be
-    #   represented directly using the +Status+ message.
-    #
-    # * Logging. If some API errors are stored in logs, the message +Status+ could
-    #   be used directly after any stripping needed for security/privacy reasons.
-    # @!attribute [rw] code
-    #   @return [Integer]
-    #     The status code, which should be an enum value of {Google::Rpc::Code}.
-    # @!attribute [rw] message
-    #   @return [String]
-    #     A developer-facing error message, which should be in English. Any
-    #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized by the client.
-    # @!attribute [rw] details
-    #   @return [Array<Google::Protobuf::Any>]
-    #     A list of messages that carry the error details.  There is a common set of
-    #     message types for APIs to use.
-    class Status; end
-  end
-end

data/lib/google/ads/googleads/v0/services/doc/overview.rb

@@ -1,82 +0,0 @@
-# Copyright 2018 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
-#
-#     https://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 Ads
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Google Ads API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
-    #
-    # [Google Ads API][Product Documentation]:
-    # Manage your AdWords accounts, campaigns, and reports with this REST-based
-    # API.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Google Ads API.](https://console.cloud.google.com/apis/library/googleads.googleapis.com)
-    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-ads-googleads
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Google Ads API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/googleads
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-    # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
-    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```
-    #
-    module Googleads
-      module V0
-        module Services
-        end
-      end
-    end
-  end
-end