google-api-client 0.46.1 → 0.50.0

data/generated/google/apis/admob_v1beta/service.rb

@@ -0,0 +1,279 @@
+# 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 AdmobV1beta
+      # AdMob API
+      #
+      # The AdMob API allows publishers to programmatically get information about
+      #  their AdMob account.
+      #
+      # @example
+      #    require 'google/apis/admob_v1beta'
+      #
+      #    Admob = Google::Apis::AdmobV1beta # Alias the module
+      #    service = Admob::AdMobService.new
+      #
+      # @see https://developers.google.com/admob/api/
+      class AdMobService < 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]
+        #  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.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://admob.googleapis.com/', '')
+          @batch_path = 'batch'
+        end
+        
+        # Gets information about the specified AdMob publisher account.
+        # @param [String] name
+        #   Resource name of the publisher account to retrieve. Example: accounts/pub-
+        #   9876543210987654
+        # @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::AdmobV1beta::PublisherAccount] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdmobV1beta::PublisherAccount]
+        #
+        # @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(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta/{+name}', options)
+          command.response_representation = Google::Apis::AdmobV1beta::PublisherAccount::Representation
+          command.response_class = Google::Apis::AdmobV1beta::PublisherAccount
+          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
+        
+        # Lists the AdMob publisher account accessible with the client credential.
+        # Currently, all credentials have access to at most one AdMob account.
+        # @param [Fixnum] page_size
+        #   Maximum number of accounts to return.
+        # @param [String] page_token
+        #   The value returned by the last `ListPublisherAccountsResponse`; indicates that
+        #   this is a continuation of a prior `ListPublisherAccounts` call, and that the
+        #   system should return the next page of data.
+        # @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::AdmobV1beta::ListPublisherAccountsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdmobV1beta::ListPublisherAccountsResponse]
+        #
+        # @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(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta/accounts', options)
+          command.response_representation = Google::Apis::AdmobV1beta::ListPublisherAccountsResponse::Representation
+          command.response_class = Google::Apis::AdmobV1beta::ListPublisherAccountsResponse
+          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
+        
+        # List the ad units under the specified AdMob account.
+        # @param [String] parent
+        #   Required. Resource name of the account to list ad units for. Example: accounts/
+        #   pub-9876543210987654
+        # @param [Fixnum] page_size
+        #   The maximum number of ad units to return.
+        # @param [String] page_token
+        #   The value returned by the last `ListAdUnitsResponse`; indicates that this is a
+        #   continuation of a prior `ListAdUnits` call, and that the system should return
+        #   the next page of data.
+        # @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::AdmobV1beta::ListAdUnitsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdmobV1beta::ListAdUnitsResponse]
+        #
+        # @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_units(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta/{+parent}/adUnits', options)
+          command.response_representation = Google::Apis::AdmobV1beta::ListAdUnitsResponse::Representation
+          command.response_class = Google::Apis::AdmobV1beta::ListAdUnitsResponse
+          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
+        
+        # List the apps under the specified AdMob account.
+        # @param [String] parent
+        #   Required. Resource name of the account to list apps for. Example: accounts/pub-
+        #   9876543210987654
+        # @param [Fixnum] page_size
+        #   The maximum number of apps to return. If unspecified or 0, at most 1000 apps
+        #   will be returned. The maximum value is 10,000; values above 10,000 will be
+        #   coerced to 10,000.
+        # @param [String] page_token
+        #   The value returned by the last `ListAppsResponse`; indicates that this is a
+        #   continuation of a prior `ListApps` call, and that the system should return the
+        #   next page of data.
+        # @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::AdmobV1beta::ListAppsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdmobV1beta::ListAppsResponse]
+        #
+        # @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_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta/{+parent}/apps', options)
+          command.response_representation = Google::Apis::AdmobV1beta::ListAppsResponse::Representation
+          command.response_class = Google::Apis::AdmobV1beta::ListAppsResponse
+          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
+        
+        # Generates an AdMob Mediation report based on the provided report specification.
+        # Returns result of a server-side streaming RPC. The result is returned in a
+        # sequence of responses.
+        # @param [String] parent
+        #   Resource name of the account to generate the report for. Example: accounts/pub-
+        #   9876543210987654
+        # @param [Google::Apis::AdmobV1beta::GenerateMediationReportRequest] generate_mediation_report_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::AdmobV1beta::GenerateMediationReportResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdmobV1beta::GenerateMediationReportResponse]
+        #
+        # @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_mediation_report(parent, generate_mediation_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+parent}/mediationReport:generate', options)
+          command.request_representation = Google::Apis::AdmobV1beta::GenerateMediationReportRequest::Representation
+          command.request_object = generate_mediation_report_request_object
+          command.response_representation = Google::Apis::AdmobV1beta::GenerateMediationReportResponse::Representation
+          command.response_class = Google::Apis::AdmobV1beta::GenerateMediationReportResponse
+          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
+        
+        # Generates an AdMob Network report based on the provided report specification.
+        # Returns result of a server-side streaming RPC. The result is returned in a
+        # sequence of responses.
+        # @param [String] parent
+        #   Resource name of the account to generate the report for. Example: accounts/pub-
+        #   9876543210987654
+        # @param [Google::Apis::AdmobV1beta::GenerateNetworkReportRequest] generate_network_report_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::AdmobV1beta::GenerateNetworkReportResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AdmobV1beta::GenerateNetworkReportResponse]
+        #
+        # @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_network_report(parent, generate_network_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+parent}/networkReport:generate', options)
+          command.request_representation = Google::Apis::AdmobV1beta::GenerateNetworkReportRequest::Representation
+          command.request_object = generate_network_report_request_object
+          command.response_representation = Google::Apis::AdmobV1beta::GenerateNetworkReportResponse::Representation
+          command.response_class = Google::Apis::AdmobV1beta::GenerateNetworkReportResponse
+          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
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

data/generated/google/apis/analyticsadmin_v1alpha.rb

@@ -25,7 +25,7 @@ module Google
     # @see http://code.google.com/apis/analytics/docs/mgmt/home.html
     module AnalyticsadminV1alpha
       VERSION = 'V1alpha'
-      REVISION = '20200924'
+      REVISION = '20201031'
 
       # Edit Google Analytics management entities
       AUTH_ANALYTICS_EDIT = 'https://www.googleapis.com/auth/analytics.edit'

data/generated/google/apis/analyticsadmin_v1alpha/classes.rb

@@ -27,8 +27,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Country of business. Must be a non-deprecated code for a UN M.49 region. https:
-        # //unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.
-        # html
+        # //unicode.org/cldr/charts/latest/supplem // ental/
+        # territory_containment_un_m_49.html
         # Corresponds to the JSON property `countryCode`
         # @return [String]
         attr_accessor :country_code
@@ -77,7 +77,7 @@ module Google
       end
       
       # A virtual resource representing an overview of an account and all its child
-      # App+Web properties.
+      # GA4 properties.
       class GoogleAnalyticsAdminV1alphaAccountSummary
         include Google::Apis::Core::Hashable
       
@@ -271,15 +271,16 @@ module Google
       class GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest
         include Google::Apis::Core::Hashable
       
-        # Optional. If notify_new_users is set, then email new users that they've been
-        # given permissions on the resource.
+        # Optional. If set, then email the new users notifying them that they've been
+        # granted permissions to the resource. Regardless of whether this is set or not,
+        # notify_new_user field inside each individual request is ignored.
         # Corresponds to the JSON property `notifyNewUsers`
         # @return [Boolean]
         attr_accessor :notify_new_users
         alias_method :notify_new_users?, :notify_new_users
       
-        # The requests specifying the user links to create. A maximum of 1000 user links
-        # can be created in a batch.
+        # Required. The requests specifying the user links to create. A maximum of 1000
+        # user links can be created in a batch.
         # Corresponds to the JSON property `requests`
         # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCreateUserLinkRequest>]
         attr_accessor :requests
@@ -318,8 +319,8 @@ module Google
       class GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest
         include Google::Apis::Core::Hashable
       
-        # The requests specifying the user links to update. A maximum of 1000 user links
-        # can be updated in a batch.
+        # Required. The requests specifying the user links to update. A maximum of 1000
+        # user links can be updated in a batch.
         # Corresponds to the JSON property `requests`
         # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest>]
         attr_accessor :requests
@@ -357,8 +358,8 @@ module Google
       class GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest
         include Google::Apis::Core::Hashable
       
-        # The requests specifying the user links to update. A maximum of 1000 user links
-        # can be updated in a batch.
+        # Required. The requests specifying the user links to update. A maximum of 1000
+        # user links can be updated in a batch.
         # Corresponds to the JSON property `requests`
         # @return [Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest>]
         attr_accessor :requests
@@ -401,8 +402,8 @@ module Google
       class GoogleAnalyticsAdminV1alphaCreateUserLinkRequest
         include Google::Apis::Core::Hashable
       
-        # Optional. If notify_new_user is set, then email new user that they've been
-        # given permissions on the resource.
+        # Optional. If set, then email the new user notifying them that they've been
+        # granted permissions to the resource.
         # Corresponds to the JSON property `notifyNewUser`
         # @return [Boolean]
         attr_accessor :notify_new_user
@@ -662,7 +663,7 @@ module Google
         end
       end
       
-      # A link between an App+Web property and a Firebase project.
+      # A link between an GA4 property and a Firebase project.
       class GoogleAnalyticsAdminV1alphaFirebaseLink
         include Google::Apis::Core::Hashable
       
@@ -671,7 +672,7 @@ module Google
         # @return [String]
         attr_accessor :create_time
       
-        # Maximum user access to the App + Web property allowed to admins of the linked
+        # Maximum user access to the GA4 property allowed to admins of the linked
         # Firebase project.
         # Corresponds to the JSON property `maximumUserAccess`
         # @return [String]
@@ -725,7 +726,7 @@ module Google
         end
       end
       
-      # A link between an App+Web property and a Google Ads account.
+      # A link between an GA4 property and a Google Ads account.
       class GoogleAnalyticsAdminV1alphaGoogleAdsLink
         include Google::Apis::Core::Hashable
       
@@ -1074,7 +1075,7 @@ module Google
         end
       end
       
-      # A resource message representing a Google Analytics App+Web property.
+      # A resource message representing a Google Analytics GA4 property.
       class GoogleAnalyticsAdminV1alphaProperty
         include Google::Apis::Core::Hashable
       
@@ -1152,7 +1153,7 @@ module Google
         end
       end
       
-      # A virtual resource representing metadata for an App+Web property.
+      # A virtual resource representing metadata for an GA4 property.
       class GoogleAnalyticsAdminV1alphaPropertySummary
         include Google::Apis::Core::Hashable
       

data/generated/google/apis/analyticsadmin_v1alpha/service.rb

@@ -187,9 +187,8 @@ module Google
         end
         
         # Returns all accounts accessible by the caller. Note that these accounts might
-        # not currently have App+Web properties. Soft-deleted (ie: "trashed") accounts
-        # are excluded by default. Returns an empty list if no relevant accounts are
-        # found.
+        # not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are
+        # excluded by default. Returns an empty list if no relevant accounts are found.
         # @param [Fixnum] page_size
         #   The maximum number of resources to return. The service may return fewer than
         #   this value, even if there are additional pages. If unspecified, at most 50
@@ -488,8 +487,8 @@ module Google
         #   Required. Example format: accounts/1234
         # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
         # @param [Boolean] notify_new_user
-        #   Optional. If notify_new_user is set, then email new user that they've been
-        #   given permissions on the resource.
+        #   Optional. If set, then email the new user notifying them that they've been
+        #   granted permissions to the resource.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -653,7 +652,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Creates an "App+Web" property with the specified location and attributes.
+        # Creates an "GA4" property with the specified location and attributes.
         # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] google_analytics_admin_v1alpha_property_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -689,7 +688,7 @@ module Google
         # the expiration time, the Property and all child resources (eg: GoogleAdsLinks,
         # Streams, UserLinks) will be permanently purged. https://support.google.com/
         # analytics/answer/6154772 Returns an error if the target is not found, or is
-        # not an App+Web Property.
+        # not an GA4 Property.
         # @param [String] name
         #   Required. The name of the Property to soft-delete. Format: properties/`
         #   property_id` Example: "properties/1000"
@@ -720,9 +719,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lookup for a single "App+Web" Property. Throws "Target not found" if no such
-        # property found, if property is not of the type "App+Web", or if caller does
-        # not have permissions to access it.
+        # Lookup for a single "GA4" Property. Throws "Target not found" if no such
+        # property found, if property is not of the type "GA4", or if caller does not
+        # have permissions to access it.
         # @param [String] name
         #   Required. The name of the property to lookup. Format: properties/`property_id`
         #   Example: "properties/1000"
@@ -753,7 +752,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Returns child Properties under the specified parent Account. Only "App+Web"
+        # Returns child Properties under the specified parent Account. Only "GA4"
         # properties will be returned. Properties will be excluded if the caller does
         # not have access. Soft-deleted (ie: "trashed") properties are excluded by
         # default. Returns an empty list if no relevant properties are found.
@@ -1669,8 +1668,8 @@ module Google
         #   Required. Example format: accounts/1234
         # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
         # @param [Boolean] notify_new_user
-        #   Optional. If notify_new_user is set, then email new user that they've been
-        #   given permissions on the resource.
+        #   Optional. If set, then email the new user notifying them that they've been
+        #   granted permissions to the resource.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user