google-ads-googleads 0.3.0 → 0.4.0

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/shared_criterion.rb

@@ -0,0 +1,46 @@
+# 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
+    module Googleads
+      module V0
+        module Resources
+          # A criterion belonging to a shared set.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the shared criterion.
+          #     Shared set resource names have the form:
+          #
+          #     +customers/{customer_id}/sharedCriteria/{shared_set_id}_{criterion_id}+
+          # @!attribute [rw] shared_set
+          #   @return [Google::Protobuf::StringValue]
+          #     The shared set to which the shared criterion belongs.
+          # @!attribute [rw] criterion_id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of the criterion.
+          #
+          #     This field is ignored for mutates.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::CriterionTypeEnum::CriterionType]
+          #     The type of the criterion.
+          # @!attribute [rw] keyword
+          #   @return [Google::Ads::Googleads::V0::Common::KeywordInfo]
+          #     Keyword.
+          class SharedCriterion; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/resources/shared_set.rb

@@ -0,0 +1,56 @@
+# 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
+    module Googleads
+      module V0
+        module Resources
+          # SharedSets are used for sharing criterion exclusions across multiple
+          # campaigns.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the shared set.
+          #     Shared set resource names have the form:
+          #
+          #     +customers/{customer_id}/sharedSets/{shared_set_id}+
+          # @!attribute [rw] id
+          #   @return [Google::Protobuf::Int64Value]
+          #     The ID of this shared set. Read only.
+          # @!attribute [rw] type
+          #   @return [Google::Ads::Googleads::V0::Enums::SharedSetTypeEnum::SharedSetType]
+          #     The type of this shared set: each shared set holds only a single kind
+          #     of entity. Required. Immutable.
+          # @!attribute [rw] name
+          #   @return [Google::Protobuf::StringValue]
+          #     The name of this shared set. Required.
+          #     Shared Sets must have names that are unique among active shared sets of
+          #     the same type.
+          #     The length of this string should be between 1 and 255 UTF-8 bytes,
+          #     inclusive.
+          # @!attribute [rw] status
+          #   @return [Google::Ads::Googleads::V0::Enums::SharedSetStatusEnum::SharedSetStatus]
+          #     The status of this shared set. Read only.
+          # @!attribute [rw] member_count
+          #   @return [Google::Protobuf::Int64Value]
+          #     The number of shared criteria within this shared set. Read only.
+          # @!attribute [rw] reference_count
+          #   @return [Google::Protobuf::Int64Value]
+          #     The number of campaigns associated with this shared set. Read only.
+          class SharedSet; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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
+    module Googleads
+      module V0
+        module Services
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupAdService::GetAdGroupAd AdGroupAdService::GetAdGroupAd}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the ad to fetch.
+          class GetAdGroupAdRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupAdService::MutateAdGroupAds AdGroupAdService::MutateAdGroupAds}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose ads are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::AdGroupAdOperation>]
+          #     The list of operations to perform on individual ads.
+          class MutateAdGroupAdsRequest; end
+
+          # A single operation (create, update, remove) on an ad group ad.
+          # @!attribute [rw] update_mask
+          #   @return [Google::Protobuf::FieldMask]
+          #     FieldMask that determines which resource fields are modified in an update.
+          # @!attribute [rw] create
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupAd]
+          #     Create operation: No resource name is expected for the new ad.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupAd]
+          #     Update operation: The ad is expected to have a valid resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed ad is expected,
+          #     in this format:
+          #
+          #     +customers/{customer_id}/adGroupAds/{ad_group_id}_{ad_id}+
+          class AdGroupAdOperation; end
+
+          # Response message for an ad group ad mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateAdGroupAdResult>]
+          #     All results for the mutate.
+          class MutateAdGroupAdsResponse; end
+
+          # The result for the ad mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name returned for successful operations.
+          class MutateAdGroupAdResult; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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
+    module Googleads
+      module V0
+        module Services
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupBidModifierService::GetAdGroupBidModifier AdGroupBidModifierService::GetAdGroupBidModifier}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the ad group bid modifier to fetch.
+          class GetAdGroupBidModifierRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupBidModifierService::MutateAdGroupBidModifiers AdGroupBidModifierService::MutateAdGroupBidModifiers}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     ID of the customer whose ad group bid modifiers are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::AdGroupBidModifierOperation>]
+          #     The list of operations to perform on individual ad group bid modifiers.
+          class MutateAdGroupBidModifiersRequest; end
+
+          # A single operation (create, remove, update) on an ad group bid modifier.
+          # @!attribute [rw] update_mask
+          #   @return [Google::Protobuf::FieldMask]
+          #     FieldMask that determines which resource fields are modified in an update.
+          # @!attribute [rw] create
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupBidModifier]
+          #     Create operation: No resource name is expected for the new ad group bid
+          #     modifier.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupBidModifier]
+          #     Update operation: The ad group bid modifier is expected to have a valid
+          #     resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed ad group bid modifier
+          #     is expected, in this format:
+          #
+          #
+          #     +customers/{customer_id}/adGroupBidModifiers/{ad_group_id}_{criterion_id}+
+          class AdGroupBidModifierOperation; end
+
+          # Response message for ad group bid modifiers mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateAdGroupBidModifierResult>]
+          #     All results for the mutate.
+          class MutateAdGroupBidModifiersResponse; end
+
+          # The result for the criterion mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateAdGroupBidModifierResult; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# 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
+    module Googleads
+      module V0
+        module Services
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupCriterionService::GetAdGroupCriterion AdGroupCriterionService::GetAdGroupCriterion}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the criterion to fetch.
+          class GetAdGroupCriterionRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupCriterionService::MutateAdGroupCriteria AdGroupCriterionService::MutateAdGroupCriteria}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     ID of the customer whose criteria are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::AdGroupCriterionOperation>]
+          #     The list of operations to perform on individual criteria.
+          class MutateAdGroupCriteriaRequest; end
+
+          # A single operation (create, remove, update) on an ad group criterion.
+          # @!attribute [rw] update_mask
+          #   @return [Google::Protobuf::FieldMask]
+          #     FieldMask that determines which resource fields are modified in an update.
+          # @!attribute [rw] create
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupCriterion]
+          #     Create operation: No resource name is expected for the new criterion.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroupCriterion]
+          #     Update operation: The criterion is expected to have a valid resource
+          #     name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed criterion is expected,
+          #     in this format:
+          #
+          #     +customers/{customer_id}/adGroupCriteria/{ad_group_id}_{criterion_id}+
+          class AdGroupCriterionOperation; end
+
+          # Response message for an ad group criterion mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateAdGroupCriterionResult>]
+          #     All results for the mutate.
+          class MutateAdGroupCriteriaResponse; end
+
+          # The result for the criterion mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateAdGroupCriterionResult; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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
+    module Googleads
+      module V0
+        module Services
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupService::GetAdGroup AdGroupService::GetAdGroup}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the ad group to fetch.
+          class GetAdGroupRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::AdGroupService::MutateAdGroups AdGroupService::MutateAdGroups}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose ad groups are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::AdGroupOperation>]
+          #     The list of operations to perform on individual ad groups.
+          class MutateAdGroupsRequest; end
+
+          # A single operation (create, update, remove) on an ad group.
+          # @!attribute [rw] update_mask
+          #   @return [Google::Protobuf::FieldMask]
+          #     FieldMask that determines which resource fields are modified in an update.
+          # @!attribute [rw] create
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroup]
+          #     Create operation: No resource name is expected for the new ad group.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::AdGroup]
+          #     Update operation: The ad group is expected to have a valid resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed ad group is expected,
+          #     in this format:
+          #
+          #     +customers/{customer_id}/adGroups/{ad_group_id}+
+          class AdGroupOperation; end
+
+          # Response message for an ad group mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateAdGroupResult>]
+          #     All results for the mutate.
+          class MutateAdGroupsResponse; end
+
+          # The result for the ad group mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateAdGroupResult; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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
+    module Googleads
+      module V0
+        module Services
+          # Request message for {Google::Ads::Googleads::V0::Services::BiddingStrategyService::GetBiddingStrategy BiddingStrategyService::GetBiddingStrategy}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the bidding strategy to fetch.
+          class GetBiddingStrategyRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::BiddingStrategyService::MutateBiddingStrategies BiddingStrategyService::MutateBiddingStrategies}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose bidding strategies are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::BiddingStrategyOperation>]
+          #     The list of operations to perform on individual bidding strategies.
+          class MutateBiddingStrategiesRequest; end
+
+          # A single operation (create, update, remove) on a bidding strategy.
+          # @!attribute [rw] update_mask
+          #   @return [Google::Protobuf::FieldMask]
+          #     FieldMask that determines which resource fields are modified in an update.
+          # @!attribute [rw] create
+          #   @return [Google::Ads::Googleads::V0::Resources::BiddingStrategy]
+          #     Create operation: No resource name is expected for the new bidding
+          #     strategy.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::BiddingStrategy]
+          #     Update operation: The bidding strategy is expected to have a valid
+          #     resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed bidding strategy is
+          #     expected, in this format:
+          #
+          #     +customers/{customer_id}/biddingStrategies/{bidding_strategy_id}+
+          class BiddingStrategyOperation; end
+
+          # Response message for bidding strategy mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateBiddingStrategyResult>]
+          #     All results for the mutate.
+          class MutateBiddingStrategiesResponse; end
+
+          # The result for the bidding strategy mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateBiddingStrategyResult; end
+        end
+      end
+    end
+  end
+end