google-ads-googleads 0.3.0 → 0.4.0

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/services/campaign_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::CampaignBidModifierService::GetCampaignBidModifier CampaignBidModifierService::GetCampaignBidModifier}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the campaign bid modifier to fetch.
+          class GetCampaignBidModifierRequest; end
+
+          # Request message for {CampaignBidModifierService::MutateCampaignBidModifier}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     ID of the customer whose campaign bid modifiers are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::CampaignBidModifierOperation>]
+          #     The list of operations to perform on individual campaign bid modifiers.
+          class MutateCampaignBidModifiersRequest; end
+
+          # A single operation (create, remove, update) on a campaign 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::CampaignBidModifier]
+          #     Create operation: No resource name is expected for the new campaign bid
+          #     modifier.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignBidModifier]
+          #     Update operation: The campaign bid modifier is expected to have a valid
+          #     resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed campaign bid modifier
+          #     is expected, in this format:
+          #
+          #
+          #     +customers/{customer_id}/CampaignBidModifiers/{campaign_id}_{criterion_id}+
+          class CampaignBidModifierOperation; end
+
+          # Response message for campaign bid modifiers mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateCampaignBidModifierResult>]
+          #     All results for the mutate.
+          class MutateCampaignBidModifiersResponse; end
+
+          # The result for the criterion mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateCampaignBidModifierResult; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/services/campaign_budget_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::CampaignBudgetService::GetCampaignBudget CampaignBudgetService::GetCampaignBudget}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the campaign budget to fetch.
+          class GetCampaignBudgetRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::CampaignBudgetService::MutateCampaignBudgets CampaignBudgetService::MutateCampaignBudgets}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose campaign budgets are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::CampaignBudgetOperation>]
+          #     The list of operations to perform on individual campaign budgets.
+          class MutateCampaignBudgetsRequest; end
+
+          # A single operation (create, update, remove) on a campaign budget.
+          # @!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::CampaignBudget]
+          #     Create operation: No resource name is expected for the new budget.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignBudget]
+          #     Update operation: The campaign budget is expected to have a valid
+          #     resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed budget is expected, in
+          #     this format:
+          #
+          #     +customers/{customer_id}/campaignBudgets/{budget_id}+
+          class CampaignBudgetOperation; end
+
+          # Response message for campaign budget mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateCampaignBudgetResult>]
+          #     All results for the mutate.
+          class MutateCampaignBudgetsResponse; end
+
+          # The result for the campaign budget mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateCampaignBudgetResult; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/services/campaign_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::CampaignCriterionService::GetCampaignCriterion CampaignCriterionService::GetCampaignCriterion}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the criterion to fetch.
+          class GetCampaignCriterionRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::CampaignCriterionService::MutateCampaignCriteria CampaignCriterionService::MutateCampaignCriteria}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose criteria are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::CampaignCriterionOperation>]
+          #     The list of operations to perform on individual criteria.
+          class MutateCampaignCriteriaRequest; end
+
+          # A single operation (create, update, remove) on a campaign 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::CampaignCriterion]
+          #     Create operation: No resource name is expected for the new criterion.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignCriterion]
+          #     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}/campaignCriteria/{campaign_id}_{criterion_id}+
+          class CampaignCriterionOperation; end
+
+          # Response message for campaign criterion mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateCampaignCriterionResult>]
+          #     All results for the mutate.
+          class MutateCampaignCriteriaResponse; end
+
+          # The result for the criterion mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateCampaignCriterionResult; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/services/campaign_group_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::CampaignGroupService::GetCampaignGroup CampaignGroupService::GetCampaignGroup}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the campaign group to fetch.
+          class GetCampaignGroupRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::CampaignGroupService::MutateCampaignGroups CampaignGroupService::MutateCampaignGroups}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose campaign groups are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::CampaignGroupOperation>]
+          #     The list of operations to perform on individual campaign groups.
+          class MutateCampaignGroupsRequest; end
+
+          # A single operation (create, update, remove) on a campaign 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::CampaignGroup]
+          #     Create operation: No resource name is expected for the new campaign
+          #     group.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignGroup]
+          #     Update operation: The campaign group is expected to have a valid
+          #     resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed campaign group is
+          #     expected, in this format:
+          #
+          #     +customers/{customer_id}/campaignGroups/{campaign_group_id}+
+          class CampaignGroupOperation; end
+
+          # Response message for campaign group mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateCampaignGroupResult>]
+          #     All results for the mutate.
+          class MutateCampaignGroupsResponse; end
+
+          # The result for the campaign group mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateCampaignGroupResult; end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/googleads/v0/services/doc/google/ads/googleads/v0/services/campaign_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::CampaignService::GetCampaign CampaignService::GetCampaign}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the campaign to fetch.
+          class GetCampaignRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::CampaignService::MutateCampaigns CampaignService::MutateCampaigns}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose campaigns are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::CampaignOperation>]
+          #     The list of operations to perform on individual campaigns.
+          class MutateCampaignsRequest; end
+
+          # A single operation (create, update, remove) on a campaign.
+          # @!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::Campaign]
+          #     Create operation: No resource name is expected for the new campaign.
+          # @!attribute [rw] update
+          #   @return [Google::Ads::Googleads::V0::Resources::Campaign]
+          #     Update operation: The campaign is expected to have a valid
+          #     resource name.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed campaign is
+          #     expected, in this format:
+          #
+          #     +customers/{customer_id}/campaigns/{campaign_id}+
+          class CampaignOperation; end
+
+          # Response message for campaign mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateCampaignResult>]
+          #     All results for the mutate.
+          class MutateCampaignsResponse; end
+
+          # The result for the campaign mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateCampaignResult; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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::CampaignSharedSetService::GetCampaignSharedSet CampaignSharedSetService::GetCampaignSharedSet}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the campaign shared set to fetch.
+          class GetCampaignSharedSetRequest; end
+
+          # Request message for {Google::Ads::Googleads::V0::Services::CampaignSharedSetService::MutateCampaignSharedSets CampaignSharedSetService::MutateCampaignSharedSets}.
+          # @!attribute [rw] customer_id
+          #   @return [String]
+          #     The ID of the customer whose campaign shared sets are being modified.
+          # @!attribute [rw] operations
+          #   @return [Array<Google::Ads::Googleads::V0::Services::CampaignSharedSetOperation>]
+          #     The list of operations to perform on individual campaign shared sets.
+          class MutateCampaignSharedSetsRequest; end
+
+          # A single operation (create, remove) on an campaign shared set.
+          # @!attribute [rw] create
+          #   @return [Google::Ads::Googleads::V0::Resources::CampaignSharedSet]
+          #     Create operation: No resource name is expected for the new campaign
+          #     shared set.
+          # @!attribute [rw] remove
+          #   @return [String]
+          #     Remove operation: A resource name for the removed campaign shared set is
+          #     expected, in this format:
+          #
+          #
+          #     +customers/{customer_id}/campaignSharedSets/{campaign_id}_{shared_set_id}+
+          class CampaignSharedSetOperation; end
+
+          # Response message for a campaign shared set mutate.
+          # @!attribute [rw] results
+          #   @return [Array<Google::Ads::Googleads::V0::Services::MutateCampaignSharedSetResult>]
+          #     All results for the mutate.
+          class MutateCampaignSharedSetsResponse; end
+
+          # The result for the campaign shared set mutate.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     Returned for successful operations.
+          class MutateCampaignSharedSetResult; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# 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::CustomerService::GetCustomer CustomerService::GetCustomer}.
+          # @!attribute [rw] resource_name
+          #   @return [String]
+          #     The resource name of the customer to fetch.
+          class GetCustomerRequest; end
+        end
+      end
+    end
+  end
+end