diff --git a/generated/google/apis/androidenterprise_v1.rb b/generated/google/apis/androidenterprise_v1.rb index fa82ed4d6..f3e38ecc9 100644 --- a/generated/google/apis/androidenterprise_v1.rb +++ b/generated/google/apis/androidenterprise_v1.rb @@ -20,12 +20,12 @@ module Google module Apis # Google Play EMM API # - # Manages the deployment of apps to Android for Work users. + # Manages the deployment of apps to Android Enterprise devices. # # @see https://developers.google.com/android/work/play/emm-api module AndroidenterpriseV1 VERSION = 'V1' - REVISION = '20200427' + REVISION = '20200528' # Manage corporate Android devices AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise' diff --git a/generated/google/apis/androidenterprise_v1/classes.rb b/generated/google/apis/androidenterprise_v1/classes.rb index 525630797..0f42bf5c6 100644 --- a/generated/google/apis/androidenterprise_v1/classes.rb +++ b/generated/google/apis/androidenterprise_v1/classes.rb @@ -22,8 +22,8 @@ module Google module Apis module AndroidenterpriseV1 - # This represents an enterprise admin who can manage the enterprise in the - # managed Google Play store. + # This represents an enterprise admin who can manage the enterprise + # in the managed Google Play store. class Administrator include Google::Apis::Core::Hashable @@ -46,11 +46,6 @@ module Google class AdministratorWebToken include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # An opaque token to be passed to the Play front-end to generate an iframe. # Corresponds to the JSON property `token` # @return [String] @@ -62,35 +57,29 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @token = args[:token] if args.key?(:token) end end - # Specification for a token used to generate iframes. The token specifies what - # data the admin is allowed to modify and the URI the iframe is allowed to - # communiate with. + # Specification for a token used to generate iframes. The token specifies + # what data the admin is allowed to modify and the URI the iframe is + # allowed to communiate with. class AdministratorWebTokenSpec include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # Options for displaying the Managed Configuration page. # Corresponds to the JSON property `managedConfigurations` # @return [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpecManagedConfigurations] attr_accessor :managed_configurations - # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may - # not be hosted at other URIs. This URI must be https. Use whitespaces to - # separate multiple parent URIs. + # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe + # may not be hosted at other URIs. This URI must be https. + # Use whitespaces to separate multiple parent URIs. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # Deprecated. Use PlaySearch.approveApps. + # Deprecated. Use PlaySearch.approveApps. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission @@ -121,7 +110,6 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @managed_configurations = args[:managed_configurations] if args.key?(:managed_configurations) @parent = args[:parent] if args.key?(:parent) @permission = args[:permission] if args.key?(:permission) @@ -156,7 +144,10 @@ module Google class AdministratorWebTokenSpecPlaySearch include Google::Apis::Core::Hashable - # Allow access to the iframe in approve mode. Default is false. + # Allow access to the iframe in approve + # mode. Default is false. # Corresponds to the JSON property `approveApps` # @return [Boolean] attr_accessor :approve_apps @@ -239,8 +230,8 @@ module Google end end - # Represents the list of app restrictions available to be pre-configured for the - # product. + # Represents the list of app restrictions available to be pre-configured for + # the product. class AppRestrictionsSchema include Google::Apis::Core::Hashable @@ -266,13 +257,14 @@ module Google end # An event generated when a new app version is uploaded to Google Play and its - # app restrictions schema changed. To fetch the app restrictions schema for an - # app, use Products.getAppRestrictionsSchema on the EMM API. + # app restrictions schema changed. + # To fetch the app restrictions schema for an app, use + # Products.getAppRestrictionsSchema on the EMM API. class AppRestrictionsSchemaChangeEvent include Google::Apis::Core::Hashable - # The id of the product (e.g. "app:com.google.android.gm") for which the app - # restriction schema changed. This field will always be present. + # The id of the product (e.g. "app:com.google.android.gm") for which the + # app restriction schema changed. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -297,34 +289,37 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestrictionRestrictionValue] attr_accessor :default_value - # A longer description of the restriction, giving more detail of what it affects. + # A longer description of the restriction, giving more detail of what it + # affects. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # For choice or multiselect restrictions, the list of possible entries' human- - # readable names. + # For choice or multiselect restrictions, the list + # of possible entries' human-readable names. # Corresponds to the JSON property `entry` # @return [Array] attr_accessor :entry - # For choice or multiselect restrictions, the list of possible entries' machine- - # readable values. These values should be used in the configuration, either as a - # single string value for a choice restriction or in a stringArray for a - # multiselect restriction. + # For choice or multiselect restrictions, the list + # of possible entries' machine-readable values. These values should be used + # in the configuration, either as a single string value for a + # choice restriction or in a stringArray for a + # multiselect restriction. # Corresponds to the JSON property `entryValue` # @return [Array] attr_accessor :entry_value - # The unique key that the product uses to identify the restriction, e.g. "com. - # google.android.gm.fieldname". + # The unique key that the product uses to identify the restriction, + # e.g. "com.google.android.gm.fieldname". # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # For bundle or bundleArray restrictions, the list of nested restrictions. A - # bundle restriction is always nested within a bundleArray restriction, and a - # bundleArray restriction is at most two levels deep. + # For bundle or bundleArray restrictions, the list + # of nested restrictions. A bundle restriction is always nested + # within a bundleArray restriction, and a + # bundleArray restriction is at most two levels deep. # Corresponds to the JSON property `nestedRestriction` # @return [Array] attr_accessor :nested_restriction @@ -376,12 +371,14 @@ module Google # @return [Fixnum] attr_accessor :value_integer - # The list of string values - this will only be present if type is multiselect. + # The list of string values - this will only be present if type is + # multiselect. # Corresponds to the JSON property `valueMultiselect` # @return [Array] attr_accessor :value_multiselect - # The string value - this will be present for types string, choice and hidden. + # The string value - this will be present for types string, choice and + # hidden. # Corresponds to the JSON property `valueString` # @return [String] attr_accessor :value_string @@ -404,12 +401,14 @@ module Google class AppState include Google::Apis::Core::Hashable - # List of keyed app states. This field will always be present. + # List of keyed app states. + # This field will always be present. # Corresponds to the JSON property `keyedAppState` # @return [Array] attr_accessor :keyed_app_state - # The package name of the app. This field will always be present. + # The package name of the app. + # This field will always be present. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name @@ -458,14 +457,14 @@ module Google attr_accessor :is_production alias_method :is_production?, :is_production - # Deprecated, use trackId instead. + # Deprecated, use trackId instead. # Corresponds to the JSON property `track` # @return [String] attr_accessor :track - # Track ids that the app version is published in. Replaces the track field ( - # deprecated), but doesn't include the production track (see isProduction - # instead). + # Track ids that the app version is published in. Replaces the + # track field (deprecated), but doesn't include the production + # track (see isProduction instead). # Corresponds to the JSON property `trackId` # @return [Array] attr_accessor :track_id @@ -475,7 +474,8 @@ module Google # @return [Fixnum] attr_accessor :version_code - # The string used in the Play store by the app developer to identify the version. + # The string used in the Play store by the app developer to identify + # the version. # The string is not necessarily unique or localized (for example, the string # could be "1.4"). # Corresponds to the JSON property `versionString` @@ -501,16 +501,11 @@ module Google include Google::Apis::Core::Hashable # A URL that displays a product's permissions and that can also be used to - # approve the product with the Products.approve call. + # approve the product with the Products.approve call. # Corresponds to the JSON property `approvalUrl` # @return [String] attr_accessor :approval_url - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -518,7 +513,6 @@ module Google # Update properties of this object def update!(**args) @approval_url = args[:approval_url] if args.key?(:approval_url) - @kind = args[:kind] if args.key?(:kind) end end @@ -527,14 +521,9 @@ module Google class AuthenticationToken include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The authentication token to be passed to the device policy client on the - # device where it can be used to provision the account for which this token was - # generated. + # device where it can be used to provision the account for which this token + # was generated. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token @@ -545,7 +534,6 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @token = args[:token] if args.key?(:token) end end @@ -586,8 +574,8 @@ module Google class AutoInstallPolicy include Google::Apis::Core::Hashable - # The constraints for auto-installing the app. You can specify a maximum of one - # constraint. + # The constraints for auto-installing the app. You can specify a maximum of + # one constraint. # Corresponds to the JSON property `autoInstallConstraint` # @return [Array] attr_accessor :auto_install_constraint @@ -604,9 +592,9 @@ module Google attr_accessor :auto_install_priority # The minimum version of the app. If a lower version of the app is installed, - # then the app will be auto-updated according to the auto-install constraints, - # instead of waiting for the regular auto-update. You can set a minimum version - # code for at most 20 apps per device. + # then the app will be auto-updated according to the auto-install + # constraints, instead of waiting for the regular auto-update. You can set a + # minimum version code for at most 20 apps per device. # Corresponds to the JSON property `minimumVersionCode` # @return [Fixnum] attr_accessor :minimum_version_code @@ -624,18 +612,13 @@ module Google end end - # A configuration variables resource contains the managed configuration settings - # ID to be applied to a single user, as well as the variable set that is - # attributed to the user. The variable set will be used to replace placeholders - # in the managed configuration settings. + # A configuration variables resource contains the managed configuration + # settings ID to be applied to a single user, as well as the variable set that + # is attributed to the user. The variable set will be used to replace + # placeholders in the managed configuration settings. class ConfigurationVariables include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The ID of the managed configurations settings. # Corresponds to the JSON property `mcmId` # @return [String] @@ -652,40 +635,36 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @mcm_id = args[:mcm_id] if args.key?(:mcm_id) @variable_set = args[:variable_set] if args.key?(:variable_set) end end - # A Devices resource represents a mobile device managed by the EMM and belonging - # to a specific enterprise user. + # A Devices resource represents a mobile device managed by the EMM and + # belonging to a specific enterprise user. class Device include Google::Apis::Core::Hashable - # The Google Play Services Android ID for the device encoded as a lowercase hex - # string. For example, "123456789abcdef0". + # The Google Play Services Android ID for the device encoded as + # a lowercase hex string. For example, + # "123456789abcdef0". # Corresponds to the JSON property `androidId` # @return [String] attr_accessor :android_id - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Identifies the extent to which the device is controlled by a managed Google - # Play EMM in various deployment configurations. + # Identifies the extent to which the device is controlled by a managed + # Google Play EMM in various deployment configurations.

# Possible values include: - # - "managedDevice", a device that has the EMM's device policy controller (DPC) - # as the device owner. - # - "managedProfile", a device that has a profile managed by the DPC (DPC is - # profile owner) in addition to a separate, personal profile that is unavailable - # to the DPC. - # - "containerApp", no longer used (deprecated). - # - "unmanagedProfile", a device that has been allowed (by the domain's admin, - # using the Admin Console to enable the privilege) to use managed Google Play, - # but the profile is itself not owned by a DPC. + #
  • "managedDevice", a device that has the EMM's device + # policy controller (DPC) as the device owner.
  • + #
  • "managedProfile", a device that has a profile managed + # by the DPC (DPC is profile owner) in addition to a separate, personal + # profile that is unavailable to the DPC.
  • + #
  • "containerApp", no longer used (deprecated).
  • + #
  • "unmanagedProfile", a device that has been allowed (by the + # domain's admin, using the Admin Console to enable the privilege) to use + # managed Google Play, but the profile is itself + # not owned by a DPC.
# Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type @@ -708,7 +687,6 @@ module Google # Update properties of this object def update!(**args) @android_id = args[:android_id] if args.key?(:android_id) - @kind = args[:kind] if args.key?(:kind) @management_type = args[:management_type] if args.key?(:management_type) @policy = args[:policy] if args.key?(:policy) @report = args[:report] if args.key?(:report) @@ -720,14 +698,15 @@ module Google class DeviceReport include Google::Apis::Core::Hashable - # List of app states set by managed apps on the device. App states are defined - # by the app's developers. This field will always be present. + # List of app states set by managed apps on the device. App states are + # defined by the app's developers. + # This field will always be present. # Corresponds to the JSON property `appState` # @return [Array] attr_accessor :app_state - # The timestamp of the last report update in milliseconds since epoch. This - # field will always be present. + # The timestamp of the last report update in milliseconds since epoch. + # This field will always be present. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis @@ -747,7 +726,8 @@ module Google class DeviceReportUpdateEvent include Google::Apis::Core::Hashable - # The Android ID of the device. This field will always be present. + # The Android ID of the device. + # This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -758,7 +738,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::DeviceReport] attr_accessor :report - # The ID of the user. This field will always be present. + # The ID of the user. + # This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -775,24 +756,19 @@ module Google end end - # The state of a user's device, as accessed by the getState and setState methods - # on device resources. + # The state of a user's device, as accessed by the getState and setState + # methods on device resources. class DeviceState include Google::Apis::Core::Hashable - # The state of the Google account on the device. "enabled" indicates that the - # Google account on the device can be used to access Google services (including - # Google Play), while "disabled" means that it cannot. A new device is initially - # in the "disabled" state. + # The state of the Google account on the device. "enabled" indicates that + # the Google account on the device can be used to access Google services + # (including Google Play), while "disabled" means that it cannot. + # A new device is initially in the "disabled" state. # Corresponds to the JSON property `accountState` # @return [String] attr_accessor :account_state - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -800,11 +776,10 @@ module Google # Update properties of this object def update!(**args) @account_state = args[:account_state] if args.key?(:account_state) - @kind = args[:kind] if args.key?(:kind) end end - # The device resources for the user. + # class ListDevicesResponse include Google::Apis::Core::Hashable @@ -813,12 +788,6 @@ module Google # @return [Array] attr_accessor :device - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#devicesListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -826,27 +795,30 @@ module Google # Update properties of this object def update!(**args) @device = args[:device] if args.key?(:device) - @kind = args[:kind] if args.key?(:kind) end end - # An Enterprises resource represents the binding between an EMM and a specific - # organization. That binding can be instantiated in one of two different ways - # using this API as follows: - # - For Google managed domain customers, the process involves using Enterprises. - # enroll and Enterprises.setAccount (in conjunction with artifacts obtained from - # the Admin console and the Google API Console) and submitted to the EMM through - # a more-or-less manual process. - # - For managed Google Play Accounts customers, the process involves using - # Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction - # with the managed Google Play sign-up UI (Google-provided mechanism) to create - # the binding without manual steps. As an EMM, you can support either or both - # approaches in your EMM console. See Create an Enterprise for details. + # An Enterprises resource represents the binding between an EMM and a + # specific organization. That binding can be instantiated in one of two + # different ways using this API as follows: + #
  • For Google managed domain customers, the process involves using + # Enterprises.enroll and Enterprises.setAccount (in + # conjunction with artifacts obtained from the Admin console and the Google + # API Console) and submitted to the EMM through a more-or-less manual + # process.
  • + #
  • For managed Google Play Accounts customers, the process involves using + # Enterprises.generateSignupUrl and + # Enterprises.completeSignup in conjunction with the managed + # Google Play sign-up UI (Google-provided mechanism) to create the binding + # without manual steps.
As an EMM, you can support either or both + # approaches in your EMM console. See Create an Enterprise + # for details. class Enterprise include Google::Apis::Core::Hashable - # Admins of the enterprise. This is only supported for enterprises created via - # the EMM-initiated flow. + # Admins of the enterprise. This is only supported for enterprises + # created via the EMM-initiated flow. # Corresponds to the JSON property `administrator` # @return [Array] attr_accessor :administrator @@ -856,11 +828,6 @@ module Google # @return [String] attr_accessor :id - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The name of the enterprise, for example, "Example, Inc". # Corresponds to the JSON property `name` # @return [String] @@ -879,14 +846,13 @@ module Google def update!(**args) @administrator = args[:administrator] if args.key?(:administrator) @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @primary_domain = args[:primary_domain] if args.key?(:primary_domain) end end - # A service account that can be used to authenticate as the enterprise to API - # calls that require such authentication. + # A service account that can be used to authenticate as the enterprise to + # API calls that require such authentication. class EnterpriseAccount include Google::Apis::Core::Hashable @@ -895,11 +861,6 @@ module Google # @return [String] attr_accessor :account_email - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -907,11 +868,10 @@ module Google # Update properties of this object def update!(**args) @account_email = args[:account_email] if args.key?(:account_email) - @kind = args[:kind] if args.key?(:kind) end end - # The matching enterprise resources. + # class ListEnterprisesResponse include Google::Apis::Core::Hashable @@ -920,12 +880,6 @@ module Google # @return [Array] attr_accessor :enterprise - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#enterprisesListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -933,7 +887,6 @@ module Google # Update properties of this object def update!(**args) @enterprise = args[:enterprise] if args.key?(:enterprise) - @kind = args[:kind] if args.key?(:kind) end end @@ -946,8 +899,8 @@ module Google # @return [String] attr_accessor :message_id - # The name of the Cloud Pub/Sub topic to which notifications for this enterprise' - # s enrolled account will be sent. + # The name of the Cloud Pub/Sub topic to which notifications for this + # enterprise's enrolled account will be sent. # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name @@ -971,35 +924,31 @@ module Google # The API can be used to create an entitlement. As an option, you can also use # the API to trigger the installation of an app on all a user's managed devices # at the same time the entitlement is created. - # If the app is free, creating the entitlement also creates a group license for - # that app. For paid apps, creating the entitlement consumes one license, and - # that license remains consumed until the entitlement is removed. If the + # If the app is free, creating the entitlement also creates a group license + # for that app. For paid apps, creating the entitlement consumes one license, + # and that license remains consumed until the entitlement is removed. If the # enterprise hasn't purchased enough licenses, then no entitlement is created # and the installation fails. An entitlement is also not created for an app if # the app requires permissions that the enterprise hasn't accepted. - # If an entitlement is deleted, the app may be uninstalled from a user's device. - # As a best practice, uninstall the app by calling Installs.delete() before - # deleting the entitlement. - # Entitlements for apps that a user pays for on an unmanaged profile have " - # userPurchase" as the entitlement reason. These entitlements cannot be removed - # via the API. + # If an entitlement is deleted, the app may be uninstalled from a user's + # device. As a best practice, uninstall the app by calling + # + # Installs.delete() before deleting the entitlement. + # Entitlements for apps that a user pays for on an unmanaged profile have + # "userPurchase" as the entitlement reason. These + # entitlements cannot be removed via the API. class Entitlement include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The ID of the product that the entitlement is for. For example, "app:com. - # google.android.gm". + # The ID of the product that the entitlement is for. For example, + # "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The reason for the entitlement. For example, "free" for free apps. This - # property is temporary: it will be replaced by the acquisition kind field of - # group licenses. + # The reason for the entitlement. For example, "free" + # for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -1010,29 +959,22 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @product_id = args[:product_id] if args.key?(:product_id) @reason = args[:reason] if args.key?(:reason) end end - # The entitlement resources for the user. + # class ListEntitlementsResponse include Google::Apis::Core::Hashable - # An entitlement of a user to a product (e.g. an app). For example, a free app - # that they have installed, or a paid app that they have been allocated a - # license to. + # An entitlement of a user to a product (e.g. an app). + # For example, a free app that they have installed, or a paid app that they + # have been allocated a license to. # Corresponds to the JSON property `entitlement` # @return [Array] attr_accessor :entitlement - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#entitlementsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -1040,78 +982,77 @@ module Google # Update properties of this object def update!(**args) @entitlement = args[:entitlement] if args.key?(:entitlement) - @kind = args[:kind] if args.key?(:kind) end end - # Group license objects allow you to keep track of licenses (called entitlements) + # Group license objects allow you to keep track of licenses (called + # entitlements) # for both free and paid apps. For a free app, a group license is created when # an enterprise admin first approves the product in Google Play or when the # first entitlement for the product is created for a user via the API. For a # paid app, a group license object is only created when an enterprise admin # purchases the product in Google Play for the first time. - # Use the API to query group licenses. A Grouplicenses resource includes the - # total number of licenses purchased (paid apps only) and the total number of - # licenses currently in use. In other words, the total number of Entitlements - # that exist for the product. - # Only one group license object is created per product and group license objects - # are never deleted. If a product is unapproved, its group license remains. This - # allows enterprise admins to keep track of any remaining entitlements for the - # product. + # Use the API to query group licenses. A Grouplicenses resource + # includes the total number of licenses purchased (paid apps only) and the + # total number of licenses currently in use. In other words, the total number + # of Entitlements that exist for the product. + # Only one group license object is created per product and group license + # objects are never deleted. If a product is unapproved, its group license + # remains. This allows enterprise admins to keep track of any remaining + # entitlements for the product. class GroupLicense include Google::Apis::Core::Hashable - # How this group license was acquired. "bulkPurchase" means that this - # Grouplicenses resource was created because the enterprise purchased licenses - # for this product; otherwise, the value is "free" (for free products). + # How this group license was acquired. "bulkPurchase" + # means that this Grouplicenses resource was created because the enterprise + # purchased licenses for this product; otherwise, the value is + # "free" (for free products). # Corresponds to the JSON property `acquisitionKind` # @return [String] attr_accessor :acquisition_kind - # Whether the product to which this group license relates is currently approved - # by the enterprise. Products are approved when a group license is first created, - # but this approval may be revoked by an enterprise admin via Google Play. - # Unapproved products will not be visible to end users in collections, and new - # entitlements to them should not normally be created. + # Whether the product to which this group license relates is currently + # approved by the enterprise. Products are approved when a group license is + # first created, but this approval may be revoked by an enterprise admin via + # Google Play. Unapproved products will not be visible to end users in + # collections, and new entitlements to them should not normally be created. # Corresponds to the JSON property `approval` # @return [String] attr_accessor :approval - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The total number of provisioned licenses for this product. Returned by read - # operations, but ignored in write operations. + # The total number of provisioned licenses for this product. + # Returned by read operations, but ignored in write operations. # Corresponds to the JSON property `numProvisioned` # @return [Fixnum] attr_accessor :num_provisioned - # The number of purchased licenses (possibly in multiple purchases). If this - # field is omitted, then there is no limit on the number of licenses that can be - # provisioned (for example, if the acquisition kind is "free"). + # The number of purchased licenses (possibly in multiple purchases). + # If this field is omitted, then there is no limit on the number of licenses + # that can be provisioned (for example, if the acquisition kind is + # "free"). # Corresponds to the JSON property `numPurchased` # @return [Fixnum] attr_accessor :num_purchased - # The permission approval status of the product. This field is only set if the - # product is approved. Possible states are: - # - "currentApproved", the current set of permissions is approved, but - # additional permissions will require the administrator to reapprove the product - # (If the product was approved without specifying the approved permissions - # setting, then this is the default behavior.), - # - "needsReapproval", the product has unapproved permissions. No additional - # product licenses can be assigned until the product is reapproved, - # - "allCurrentAndFutureApproved", the current permissions are approved and any - # future permission updates will be automatically approved without administrator - # review. + # The permission approval status of the product. This field + # is only set if the product is approved. Possible states are:
    + #
  • "currentApproved", the current set + # of permissions is approved, but additional permissions will require the + # administrator to reapprove the product (If the product was approved + # without specifying the approved permissions setting, then this is the + # default behavior.),
  • + #
  • "needsReapproval", the product has unapproved permissions. + # No additional product licenses can be assigned until the product is + # reapproved,
  • + #
  • "allCurrentAndFutureApproved", + # the current permissions are approved and any future permission updates + # will be automatically approved without administrator review.
# Corresponds to the JSON property `permissions` # @return [String] attr_accessor :permissions - # The ID of the product that the license is for. For example, "app:com.google. - # android.gm". + # The ID of the product that the license is for. For example, + # "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -1124,7 +1065,6 @@ module Google def update!(**args) @acquisition_kind = args[:acquisition_kind] if args.key?(:acquisition_kind) @approval = args[:approval] if args.key?(:approval) - @kind = args[:kind] if args.key?(:kind) @num_provisioned = args[:num_provisioned] if args.key?(:num_provisioned) @num_purchased = args[:num_purchased] if args.key?(:num_purchased) @permissions = args[:permissions] if args.key?(:permissions) @@ -1132,16 +1072,10 @@ module Google end end - # The user resources for the group license. + # class ListGroupLicenseUsersResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#groupLicenseUsersListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # A user of an enterprise. # Corresponds to the JSON property `user` # @return [Array] @@ -1153,12 +1087,11 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @user = args[:user] if args.key?(:user) end end - # The grouplicense resources for the enterprise. + # class ListGroupLicensesResponse include Google::Apis::Core::Hashable @@ -1167,12 +1100,6 @@ module Google # @return [Array] attr_accessor :group_license - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#groupLicensesListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -1180,18 +1107,21 @@ module Google # Update properties of this object def update!(**args) @group_license = args[:group_license] if args.key?(:group_license) - @kind = args[:kind] if args.key?(:kind) end end - # The existence of an Installs resource indicates that an app is installed on a - # particular device (or that an install is pending). - # The API can be used to create an install resource using the update method. - # This triggers the actual install of the app on the device. If the user does - # not already have an entitlement for the app, then an attempt is made to create - # one. If this fails (for example, because the app is not free and there is no - # available license), then the creation of the install fails. - # The API can also be used to update an installed app. If the update method is + # The existence of an Installs resource indicates that an app is + # installed on a particular device (or that an install is pending). + # The API can be used to create an install resource using the + # update + # method. This triggers the actual install of the app on the device. If the + # user does not already have an entitlement for the app, then an attempt is + # made to create one. If this fails (for example, because the app is not free + # and there is no available license), then the creation of the install fails. + # The API can also be used to update an installed app. If + # the update method is # used on an existing install, then the app will be updated to the latest # available version. # Note that it is not possible to force the installation of a specific version @@ -1207,26 +1137,22 @@ module Google class Install include Google::Apis::Core::Hashable - # Install state. The state "installPending" means that an install request has - # recently been made and download to the device is in progress. The state " - # installed" means that the app has been installed. This field is read-only. + # Install state. The state "installPending" + # means that an install request has recently been made and download to the + # device is in progress. The state "installed" + # means that the app has been installed. This field is read-only. # Corresponds to the JSON property `installState` # @return [String] attr_accessor :install_state - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The ID of the product that the install is for. For example, "app:com.google. - # android.gm". + # The ID of the product that the install is for. For example, + # "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The version of the installed product. Guaranteed to be set only if the install - # state is "installed". + # The version of the installed product. Guaranteed to be set only if the + # install state is "installed". # Corresponds to the JSON property `versionCode` # @return [Fixnum] attr_accessor :version_code @@ -1238,7 +1164,6 @@ module Google # Update properties of this object def update!(**args) @install_state = args[:install_state] if args.key?(:install_state) - @kind = args[:kind] if args.key?(:kind) @product_id = args[:product_id] if args.key?(:product_id) @version_code = args[:version_code] if args.key?(:version_code) end @@ -1248,7 +1173,8 @@ module Google class InstallFailureEvent include Google::Apis::Core::Hashable - # The Android ID of the device. This field will always be present. + # The Android ID of the device. + # This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -1258,18 +1184,20 @@ module Google # @return [String] attr_accessor :failure_details - # The reason for the installation failure. This field will always be present. + # The reason for the installation failure. + # This field will always be present. # Corresponds to the JSON property `failureReason` # @return [String] attr_accessor :failure_reason - # The id of the product (e.g. "app:com.google.android.gm") for which the install - # failure event occured. This field will always be present. + # The id of the product (e.g. "app:com.google.android.gm") for which the + # install failure event occured. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The ID of the user. This field will always be present. + # The ID of the user. + # This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -1288,22 +1216,17 @@ module Google end end - # The install resources for the device. + # class ListInstallsResponse include Google::Apis::Core::Hashable - # An installation of an app for a user on a specific device. The existence of an - # install implies that the user must have an entitlement to the app. + # An installation of an app for a user on a specific device. + # The existence of an install implies that the user must have an + # entitlement to the app. # Corresponds to the JSON property `install` # @return [Array] attr_accessor :install - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#installsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -1311,7 +1234,6 @@ module Google # Update properties of this object def update!(**args) @install = args[:install] if args.key?(:install) - @kind = args[:kind] if args.key?(:kind) end end @@ -1320,34 +1242,36 @@ module Google class KeyedAppState include Google::Apis::Core::Hashable - # Additional field intended for machine-readable data. For example, a number or - # JSON object. To prevent XSS, we recommend removing any HTML from the data - # before displaying it. + # Additional field intended for machine-readable data. For example, a number + # or JSON object. To prevent XSS, we recommend removing any HTML from the + # data before displaying it. # Corresponds to the JSON property `data` # @return [String] attr_accessor :data - # Key indicating what the app is providing a state for. The content of the key - # is set by the app's developer. To prevent XSS, we recommend removing any HTML - # from the key before displaying it. This field will always be present. + # Key indicating what the app is providing a state for. The content of the + # key is set by the app's developer. To prevent XSS, we recommend removing + # any HTML from the key before displaying it. + # This field will always be present. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Free-form, human-readable message describing the app state. For example, an - # error message. To prevent XSS, we recommend removing any HTML from the message - # before displaying it. + # Free-form, human-readable message describing the app state. For example, + # an error message. To prevent XSS, we recommend removing any HTML from the + # message before displaying it. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message - # Severity of the app state. This field will always be present. + # Severity of the app state. + # This field will always be present. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity - # Timestamp of when the app set the state in milliseconds since epoch. This - # field will always be present. + # Timestamp of when the app set the state in milliseconds since epoch. + # This field will always be present. # Corresponds to the JSON property `stateTimestampMillis` # @return [Fixnum] attr_accessor :state_timestamp_millis @@ -1391,8 +1315,9 @@ module Google end end - # Maintenance window for managed Google Play Accounts. This allows Play store to - # update the apps on the foreground in the designated window. + # Maintenance window for managed Google Play Accounts. + # This allows Play store to update the apps on the foreground in the designated + # window. class MaintenanceWindow include Google::Apis::Core::Hashable @@ -1420,15 +1345,15 @@ module Google end # A managed configuration resource contains the set of managed properties - # defined by the app developer in the app's managed configurations schema, as - # well as any configuration variables defined for the user. + # defined by the app developer in the app's managed configurations schema, + # as well as any configuration variables defined for the user. class ManagedConfiguration include Google::Apis::Core::Hashable - # A configuration variables resource contains the managed configuration settings - # ID to be applied to a single user, as well as the variable set that is - # attributed to the user. The variable set will be used to replace placeholders - # in the managed configuration settings. + # A configuration variables resource contains the managed configuration + # settings ID to be applied to a single user, as well as the variable set that + # is attributed to the user. The variable set will be used to replace + # placeholders in the managed configuration settings. # Corresponds to the JSON property `configurationVariables` # @return [Google::Apis::AndroidenterpriseV1::ConfigurationVariables] attr_accessor :configuration_variables @@ -1443,8 +1368,8 @@ module Google # @return [Array] attr_accessor :managed_property - # The ID of the product that the managed configuration is for, e.g. "app:com. - # google.android.gm". + # The ID of the product that the managed configuration is for, e.g. + # "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -1462,16 +1387,10 @@ module Google end end - # The managed configuration resources for the device. + # class ManagedConfigurationsForDeviceListResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#managedConfigurationsForDeviceListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # A managed configuration for an app on a specific device. # Corresponds to the JSON property `managedConfigurationForDevice` # @return [Array] @@ -1483,21 +1402,14 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @managed_configuration_for_device = args[:managed_configuration_for_device] if args.key?(:managed_configuration_for_device) end end - # The managed configuration resources for the user. + # class ManagedConfigurationsForUserListResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#managedConfigurationsForUserListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # A managed configuration for an app for a specific user. # Corresponds to the JSON property `managedConfigurationForUser` # @return [Array] @@ -1509,25 +1421,19 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @managed_configuration_for_user = args[:managed_configuration_for_user] if args.key?(:managed_configuration_for_user) end end - # A managed configurations settings resource contains the set of managed - # properties that have been configured for an Android app to be applied to a set - # of users. The app's developer would have defined configurable properties in - # the managed configurations schema. + # A managed configurations settings resource contains the set of + # managed properties that have been configured for an Android app to be applied + # to a set of users. The app's developer would have + # defined configurable properties in the managed configurations schema. class ManagedConfigurationsSettings include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The last updated time of the managed configuration settings in milliseconds - # since 1970-01-01T00:00:00Z. + # The last updated time of the managed configuration settings in + # milliseconds since 1970-01-01T00:00:00Z. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis @@ -1548,25 +1454,18 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @last_updated_timestamp_millis = args[:last_updated_timestamp_millis] if args.key?(:last_updated_timestamp_millis) @mcm_id = args[:mcm_id] if args.key?(:mcm_id) @name = args[:name] if args.key?(:name) end end - # The managed configurations settings for a product. + # class ManagedConfigurationsSettingsListResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#managedConfigurationsSettingsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # A managed configurations settings for an app that may be assigned to a group - # of users in an enterprise. + # A managed configurations settings for an app that may be assigned to a + # group of users in an enterprise. # Corresponds to the JSON property `managedConfigurationsSettings` # @return [Array] attr_accessor :managed_configurations_settings @@ -1577,7 +1476,6 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @managed_configurations_settings = args[:managed_configurations_settings] if args.key?(:managed_configurations_settings) end end @@ -1594,7 +1492,8 @@ module Google # @return [String] attr_accessor :key - # The boolean value - this will only be present if type of the property is bool. + # The boolean value - this will only be present if type of the property is + # bool. # Corresponds to the JSON property `valueBool` # @return [Boolean] attr_accessor :value_bool @@ -1605,8 +1504,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ManagedPropertyBundle] attr_accessor :value_bundle - # The list of bundles of properties - this will only be present if type of the - # property is bundle_array. + # The list of bundles of properties - this will only be present if type of + # the property is bundle_array. # Corresponds to the JSON property `valueBundleArray` # @return [Array] attr_accessor :value_bundle_array @@ -1617,14 +1516,14 @@ module Google # @return [Fixnum] attr_accessor :value_integer - # The string value - this will only be present if type of the property is string, - # choice or hidden. + # The string value - this will only be present if type of the property is + # string, choice or hidden. # Corresponds to the JSON property `valueString` # @return [String] attr_accessor :value_string - # The list of string values - this will only be present if type of the property - # is multiselect. + # The list of string values - this will only be present if type of the + # property is multiselect. # Corresponds to the JSON property `valueStringArray` # @return [Array] attr_accessor :value_string_array @@ -1668,7 +1567,8 @@ module Google class NewDeviceEvent include Google::Apis::Core::Hashable - # The Android ID of the device. This field will always be present. + # The Android ID of the device. + # This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -1678,16 +1578,19 @@ module Google # @return [String] attr_accessor :dpc_package_name - # Identifies the extent to which the device is controlled by an Android EMM in - # various deployment configurations. + # Identifies the extent to which the device is controlled by an Android + # EMM in various deployment configurations.

# Possible values include: - # - "managedDevice", a device where the DPC is set as device owner, - # - "managedProfile", a device where the DPC is set as profile owner. + #
  • "managedDevice", a device where the DPC is set as + # device owner,
  • + #
  • "managedProfile", a device where the DPC is set as profile + # owner.
# Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type - # The ID of the user. This field will always be present. + # The ID of the user. + # This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -1709,9 +1612,10 @@ module Google class NewPermissionsEvent include Google::Apis::Core::Hashable - # The set of permissions that the enterprise admin has already approved for this - # application. Use Permissions.Get on the EMM API to retrieve details about - # these permissions. + # The set of permissions that the enterprise admin has already approved for + # this application. + # Use Permissions.Get on the EMM API to retrieve details about these + # permissions. # Corresponds to the JSON property `approvedPermissions` # @return [Array] attr_accessor :approved_permissions @@ -1722,8 +1626,9 @@ module Google # @return [String] attr_accessor :product_id - # The set of permissions that the app is currently requesting. Use Permissions. - # Get on the EMM API to retrieve details about these permissions. + # The set of permissions that the app is currently requesting. + # Use Permissions.Get on the EMM API to retrieve details about these + # permissions. # Corresponds to the JSON property `requestedPermissions` # @return [Array] attr_accessor :requested_permissions @@ -1745,8 +1650,9 @@ module Google include Google::Apis::Core::Hashable # An event generated when a new app version is uploaded to Google Play and its - # app restrictions schema changed. To fetch the app restrictions schema for an - # app, use Products.getAppRestrictionsSchema on the EMM API. + # app restrictions schema changed. + # To fetch the app restrictions schema for an app, use + # Products.getAppRestrictionsSchema on the EMM API. # Corresponds to the JSON property `appRestrictionsSchemaChangeEvent` # @return [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaChangeEvent] attr_accessor :app_restrictions_schema_change_event @@ -1764,8 +1670,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::DeviceReportUpdateEvent] attr_accessor :device_report_update_event - # The ID of the enterprise for which the notification is sent. This will always - # be present. + # The ID of the enterprise for which the notification is sent. + # This will always be present. # Corresponds to the JSON property `enterpriseId` # @return [String] attr_accessor :enterprise_id @@ -1800,8 +1706,9 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ProductAvailabilityChangeEvent] attr_accessor :product_availability_change_event - # The time when the notification was published in milliseconds since 1970-01- - # 01T00:00:00Z. This will always be present. + # The time when the notification was published in + # milliseconds since 1970-01-01T00:00:00Z. + # This will always be present. # Corresponds to the JSON property `timestampMillis` # @return [Fixnum] attr_accessor :timestamp_millis @@ -1826,25 +1733,20 @@ module Google end end - # A resource returned by the PullNotificationSet API, which contains a - # collection of notifications for enterprises associated with the service + # A resource returned by the PullNotificationSet API, which contains + # a collection of notifications for enterprises associated with the service # account authenticated for the request. class NotificationSet include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The notifications received, or empty if no notifications are present. # Corresponds to the JSON property `notification` # @return [Array] attr_accessor :notification - # The notification set ID, required to mark the notification as received with - # the Enterprises.AcknowledgeNotification API. This will be omitted if no - # notifications are present. + # The notification set ID, required to mark the notification as + # received with the Enterprises.AcknowledgeNotification API. + # This will be omitted if no notifications are present. # Corresponds to the JSON property `notificationSetId` # @return [String] attr_accessor :notification_set_id @@ -1855,27 +1757,30 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @notification = args[:notification] if args.key?(:notification) @notification_set_id = args[:notification_set_id] if args.key?(:notification_set_id) end end - # + # Information about the current page. + # List operations that supports paging return only one "page" of results. This + # protocol buffer message describes the page that has been returned. class PageInfo include Google::Apis::Core::Hashable - # + # Maximum number of results returned in one page. + # ! The number of results included in the API response. # Corresponds to the JSON property `resultPerPage` # @return [Fixnum] attr_accessor :result_per_page - # + # Index of the first result returned in the current page. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index - # + # Total number of results available on the backend + # ! The total number of results in the result set. # Corresponds to the JSON property `totalResults` # @return [Fixnum] attr_accessor :total_results @@ -1893,26 +1798,22 @@ module Google end # A Permissions resource represents some extra capability, to be granted to an - # Android app, which requires explicit consent. An enterprise admin must consent - # to these permissions on behalf of their users before an entitlement for the - # app can be created. - # The permissions collection is read-only. The information provided for each - # permission (localized name and description) is intended to be used in the MDM - # user interface when obtaining consent from the enterprise. + # Android app, which requires explicit consent. An enterprise admin must + # consent to these permissions on behalf of their users before an + # entitlement for the app can be created. + # The permissions collection is read-only. The information provided for + # each permission (localized name and description) is intended to be + # used in the MDM user interface when obtaining consent from the + # enterprise. class Permission include Google::Apis::Core::Hashable - # A longer description of the Permissions resource, giving more details of what - # it affects. + # A longer description of the Permissions resource, giving more details of + # what it affects. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The name of the permission. # Corresponds to the JSON property `name` # @return [String] @@ -1930,7 +1831,6 @@ module Google # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) - @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @permission_id = args[:permission_id] if args.key?(:permission_id) end @@ -1941,38 +1841,41 @@ module Google include Google::Apis::Core::Hashable # The auto-update policy for apps installed on the device. "choiceToTheUser" - # allows the device's user to configure the app update policy. "always" enables - # auto updates. "never" disables auto updates. "wifiOnly" enables auto updates - # only when the device is connected to wifi. + # allows the device's user to configure the app update policy. "always" + # enables auto updates. "never" disables auto updates. "wifiOnly" enables + # auto updates only when the device is connected to wifi. # Corresponds to the JSON property `autoUpdatePolicy` # @return [String] attr_accessor :auto_update_policy - # Whether the device reports app states to the EMM. The default value is " - # deviceReportDisabled". + # Whether the device reports app states to the EMM. The default value is + # "deviceReportDisabled". # Corresponds to the JSON property `deviceReportPolicy` # @return [String] attr_accessor :device_report_policy - # Maintenance window for managed Google Play Accounts. This allows Play store to - # update the apps on the foreground in the designated window. + # Maintenance window for managed Google Play Accounts. + # This allows Play store to update the apps on the foreground in the designated + # window. # Corresponds to the JSON property `maintenanceWindow` # @return [Google::Apis::AndroidenterpriseV1::MaintenanceWindow] attr_accessor :maintenance_window - # The availability granted to the device for the specified products. "all" gives - # the device access to all products, regardless of approval status. "all" does - # not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" - # grants the device access the products specified in productPolicy[]. Only - # products that are approved or products that were previously approved (products - # with revoked approval) by the enterprise can be whitelisted. If no value is - # provided, the availability set at the user level is applied by default. + # The availability granted to the device for the specified products. "all" + # gives the device access to all products, regardless of approval status. + # "all" does not enable automatic visibility of "alpha" or "beta" tracks. + # "whitelist" grants the device access the products specified in + # productPolicy[]. Only products that are approved or products that were + # previously approved (products with revoked approval) by the enterprise can + # be whitelisted. If no value is provided, the availability set at the user + # level is applied by default. # Corresponds to the JSON property `productAvailabilityPolicy` # @return [String] attr_accessor :product_availability_policy - # The list of product policies. The productAvailabilityPolicy needs to be set to - # WHITELIST or ALL for the product policies to be applied. + # The list of product policies. The productAvailabilityPolicy + # needs to be set to WHITELIST or ALL for the + # product policies to be applied. # Corresponds to the JSON property `productPolicy` # @return [Array] attr_accessor :product_policy @@ -1995,9 +1898,9 @@ module Google # available to at least some users in the enterprise. (Some apps are restricted # to a single enterprise, and no information about them is made available # outside that enterprise.) - # The information provided for each product (localized name, icon, link to the - # full Google Play details page) is intended to allow a basic representation of - # the product within an EMM user interface. + # The information provided for each product (localized name, icon, link + # to the full Google Play details page) is intended to allow a basic + # representation of the product within an EMM user interface. class Product include Google::Apis::Core::Hashable @@ -2021,7 +1924,7 @@ module Google # @return [Array] attr_accessor :available_countries - # Deprecated, use appTracks instead. + # Deprecated, use appTracks instead. # Corresponds to the JSON property `availableTracks` # @return [Array] attr_accessor :available_tracks @@ -2046,12 +1949,13 @@ module Google # @return [String] attr_accessor :details_url - # How and to whom the package is made available. The value publicGoogleHosted - # means that the package is available through the Play store and not restricted - # to a specific enterprise. The value privateGoogleHosted means that the package - # is a private app (restricted to an enterprise) but hosted by Google. The value - # privateSelfHosted means that the package is a private app (restricted to an - # enterprise) and is privately hosted. + # How and to whom the package is made available. + # The value publicGoogleHosted means that the package is + # available through the Play store and not restricted to a specific + # enterprise. The value privateGoogleHosted means that the + # package is a private app (restricted to an enterprise) but hosted by + # Google. The value privateSelfHosted means that the package is + # a private app (restricted to an enterprise) and is privately hosted. # Corresponds to the JSON property `distributionChannel` # @return [String] attr_accessor :distribution_channel @@ -2061,19 +1965,14 @@ module Google # @return [Array] attr_accessor :features - # A link to an image that can be used as an icon for the product. This image is - # suitable for use at up to 512px x 512px. + # A link to an image that can be used as an icon for the product. + # This image is suitable for use at up to 512px x 512px. # Corresponds to the JSON property `iconUrl` # @return [String] attr_accessor :icon_url - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The approximate time (within 7 days) the app was last published, expressed in - # milliseconds since epoch. + # The approximate time (within 7 days) the app was last published, expressed + # in milliseconds since epoch. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis @@ -2088,15 +1987,16 @@ module Google # @return [Array] attr_accessor :permissions - # A string of the form app:. For example, app:com.google.android. - # gm represents the Gmail app. + # A string of the form app:<package name>. For + # example, app:com.google.android.gm represents the Gmail app. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # Whether this product is free, free with in-app purchases, or paid. If the - # pricing is unknown, this means the product is not generally available anymore ( - # even though it might still be available to people who own it). + # Whether this product is free, free with in-app purchases, or paid. + # If the pricing is unknown, this means the product is not generally + # available anymore (even though it might still be available to + # people who own it). # Corresponds to the JSON property `productPricing` # @return [String] attr_accessor :product_pricing @@ -2122,8 +2022,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ProductSigningCertificate] attr_accessor :signing_certificate - # A link to a smaller image that can be used as an icon for the product. This - # image is suitable for use at up to 128px x 128px. + # A link to a smaller image that can be used as an icon for the product. + # This image is suitable for use at up to 128px x 128px. # Corresponds to the JSON property `smallIconUrl` # @return [String] attr_accessor :small_icon_url @@ -2133,8 +2033,8 @@ module Google # @return [String] attr_accessor :title - # A link to the managed Google Play details page for the product, for use by an - # Enterprise admin. + # A link to the managed Google Play details page for the product, + # for use by an Enterprise admin. # Corresponds to the JSON property `workDetailsUrl` # @return [String] attr_accessor :work_details_url @@ -2157,7 +2057,6 @@ module Google @distribution_channel = args[:distribution_channel] if args.key?(:distribution_channel) @features = args[:features] if args.key?(:features) @icon_url = args[:icon_url] if args.key?(:icon_url) - @kind = args[:kind] if args.key?(:kind) @last_updated_timestamp_millis = args[:last_updated_timestamp_millis] if args.key?(:last_updated_timestamp_millis) @min_android_sdk_version = args[:min_android_sdk_version] if args.key?(:min_android_sdk_version) @permissions = args[:permissions] if args.key?(:permissions) @@ -2177,8 +2076,8 @@ module Google class ProductApprovalEvent include Google::Apis::Core::Hashable - # Whether the product was approved or unapproved. This field will always be - # present. + # Whether the product was approved or unapproved. + # This field will always be present. # Corresponds to the JSON property `approved` # @return [String] attr_accessor :approved @@ -2204,13 +2103,14 @@ module Google class ProductAvailabilityChangeEvent include Google::Apis::Core::Hashable - # The new state of the product. This field will always be present. + # The new state of the product. + # This field will always be present. # Corresponds to the JSON property `availabilityStatus` # @return [String] attr_accessor :availability_status - # The id of the product (e.g. "app:com.google.android.gm") for which the product - # availability changed. This field will always be present. + # The id of the product (e.g. "app:com.google.android.gm") for which the + # product availability changed. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -2226,10 +2126,11 @@ module Google end end - # A product permissions resource represents the set of permissions required by a - # specific app and whether or not they have been accepted by an enterprise admin. - # The API can be used to read the set of permissions, and also to update the set - # to indicate that permissions have been accepted. + # A product permissions resource represents the set of permissions + # required by a specific app and whether or not they have been accepted + # by an enterprise admin. + # The API can be used to read the set of permissions, and also to update + # the set to indicate that permissions have been accepted. class ProductPermission include Google::Apis::Core::Hashable @@ -2254,23 +2155,18 @@ module Google end end - # Information about the permissions required by a specific app and whether they - # have been accepted by the enterprise. + # Information about the permissions required by a specific app and + # whether they have been accepted by the enterprise. class ProductPermissions include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The permissions required by the app. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission - # The ID of the app that the permissions relate to, e.g. "app:com.google.android. - # gm". + # The ID of the app that the permissions relate to, e.g. + # "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -2281,7 +2177,6 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @permission = args[:permission] if args.key?(:permission) @product_id = args[:product_id] if args.key?(:product_id) end @@ -2297,25 +2192,26 @@ module Google attr_accessor :auto_install_policy # A managed configuration resource contains the set of managed properties - # defined by the app developer in the app's managed configurations schema, as - # well as any configuration variables defined for the user. + # defined by the app developer in the app's managed configurations schema, + # as well as any configuration variables defined for the user. # Corresponds to the JSON property `managedConfiguration` # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] attr_accessor :managed_configuration - # The ID of the product. For example, "app:com.google.android.gm". + # The ID of the product. For example, + # "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Grants the device visibility to the specified product release track(s), - # identified by trackIds. The list of release tracks of a product can be - # obtained by calling Products.Get. + # identified by trackIds. The list of release tracks of a + # product can be obtained by calling Products.Get. # Corresponds to the JSON property `trackIds` # @return [Array] attr_accessor :track_ids - # Deprecated. Use trackIds instead. + # Deprecated. Use trackIds instead. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2338,36 +2234,33 @@ module Google class ProductSet include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The list of product IDs making up the set of products. # Corresponds to the JSON property `productId` # @return [Array] attr_accessor :product_id - # The interpretation of this product set. "unknown" should never be sent and is - # ignored if received. "whitelist" means that the user is entitled to access the - # product set. "includeAll" means that all products are accessible, including - # products that are approved, products with revoked approval, and products that - # have never been approved. "allApproved" means that the user is entitled to - # access all products that are approved for the enterprise. If the value is " - # allApproved" or "includeAll", the productId field is ignored. If no value is - # provided, it is interpreted as "whitelist" for backwards compatibility. - # Further "allApproved" or "includeAll" does not enable automatic visibility of " - # alpha" or "beta" tracks for Android app. Use ProductVisibility to enable " - # alpha" or "beta" tracks per user. + # The interpretation of this product set. "unknown" should never be sent and + # is ignored if received. "whitelist" means that the user is entitled to + # access the product set. "includeAll" means that all products are + # accessible, including products that are approved, products with revoked + # approval, and products that have never been approved. "allApproved" means + # that the user is entitled to access all products that are approved for the + # enterprise. If the value is "allApproved" or "includeAll", the productId + # field is ignored. If no value is provided, it is interpreted as + # "whitelist" for backwards compatibility. + # Further "allApproved" or "includeAll" does not enable automatic + # visibility of "alpha" or "beta" tracks for Android app. Use + # ProductVisibility to enable "alpha" or "beta" tracks per user. # Corresponds to the JSON property `productSetBehavior` # @return [String] attr_accessor :product_set_behavior - # Additional list of product IDs making up the product set. Unlike the productID - # array, in this list It's possible to specify which tracks (alpha, beta, - # production) of a product are visible to the user. See ProductVisibility and - # its fields for more information. Specifying the same product ID both here and - # in the productId array is not allowed and it will result in an error. + # Additional list of product IDs making up the product set. + # Unlike the productID array, in this list It's possible to specify + # which tracks (alpha, beta, production) of a product are visible to the + # user. See ProductVisibility and its fields for more information. Specifying + # the same product ID both here and in the productId array is not allowed and + # it will result in an error. # Corresponds to the JSON property `productVisibility` # @return [Array] attr_accessor :product_visibility @@ -2378,7 +2271,6 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @product_id = args[:product_id] if args.key?(:product_id) @product_set_behavior = args[:product_set_behavior] if args.key?(:product_set_behavior) @product_visibility = args[:product_visibility] if args.key?(:product_visibility) @@ -2390,8 +2282,8 @@ module Google include Google::Apis::Core::Hashable # The base64 urlsafe encoded SHA1 hash of the certificate. (This field is - # deprecated in favor of SHA2-256. It should not be used and may be removed at - # any time.) + # deprecated in favor of SHA2-256. It should not be used and may be + # removed at any time.) # Corresponds to the JSON property `certificateHashSha1` # @return [String] attr_accessor :certificate_hash_sha1 @@ -2416,19 +2308,19 @@ module Google class ProductVisibility include Google::Apis::Core::Hashable - # The product ID to make visible to the user. Required for each item in the - # productVisibility list. + # The product ID to make visible to the user. + # Required for each item in the productVisibility list. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Grants the user visibility to the specified product track(s), identified by - # trackIds. + # trackIds. # Corresponds to the JSON property `trackIds` # @return [Array] attr_accessor :track_ids - # Deprecated. Use trackIds instead. + # Deprecated. Use trackIds instead. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2454,12 +2346,12 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ApprovalUrlInfo] attr_accessor :approval_url_info - # Sets how new permission requests for the product are handled. "allPermissions" - # automatically approves all current and future permissions for the product. " - # currentPermissionsOnly" approves the current set of permissions for the - # product, but any future permissions added through updates will require manual - # reapproval. If not specified, only the current set of permissions will be - # approved. + # Sets how new permission requests for the product are handled. + # "allPermissions" automatically approves all current and future + # permissions for the product. "currentPermissionsOnly" approves the + # current set of permissions for the product, but any future permissions + # added through updates will require manual reapproval. If not specified, + # only the current set of permissions will be approved. # Corresponds to the JSON property `approvedPermissions` # @return [String] attr_accessor :approved_permissions @@ -2479,13 +2371,15 @@ module Google class GenerateProductApprovalUrlResponse include Google::Apis::Core::Hashable - # A URL that can be rendered in an iframe to display the permissions (if any) of - # a product. This URL can be used to approve the product only once and only - # within 24 hours of being generated, using the Products.approve call. If the - # product is currently unapproved and has no permissions, this URL will point to - # an empty page. If the product is currently approved, a URL will only be - # generated if that product has added permissions since it was last approved, - # and the URL will only display those new permissions that have not yet been + # A URL that can be rendered in an iframe to display the permissions (if + # any) of a product. + # This URL can be used to approve the product only once and only within 24 + # hours of being generated, using the Products.approve call. + # If the product is currently unapproved and has no permissions, this + # URL will point to an empty page. + # If the product is currently approved, a URL will only be generated if + # that product has added permissions since it was last approved, and the + # URL will only display those new permissions that have not yet been # accepted. # Corresponds to the JSON property `url` # @return [String] @@ -2501,17 +2395,13 @@ module Google end end - # The matching products. + # class ProductsListResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#productsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # General pagination information. + # Information about the current page. + # List operations that supports paging return only one "page" of results. This + # protocol buffer message describes the page that has been returned. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::AndroidenterpriseV1::PageInfo] attr_accessor :page_info @@ -2522,7 +2412,15 @@ module Google # @return [Array] attr_accessor :product - # Pagination information for token pagination. + # Pagination information returned by a List operation when token pagination + # is enabled. + # List operations that supports paging return only one "page" of results. This + # protocol buffer message describes the page that has been returned. + # When using token pagination, clients should use the next/previous token + # to get another page of the result. The presence or absence of next/previous + # token indicates whether a next/previous page is available and provides a + # mean of accessing this page. ListRequest.page_token should be set to either + # next_page_token or previous_page_token to access another page. # Corresponds to the JSON property `tokenPagination` # @return [Google::Apis::AndroidenterpriseV1::TokenPagination] attr_accessor :token_pagination @@ -2533,7 +2431,6 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @page_info = args[:page_info] if args.key?(:page_info) @product = args[:product] if args.key?(:product) @token_pagination = args[:token_pagination] if args.key?(:token_pagination) @@ -2550,11 +2447,6 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ServiceAccountKey] attr_accessor :key - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The account name of the service account, in the form of an email address. # Assigned by the server. # Corresponds to the JSON property `name` @@ -2568,7 +2460,6 @@ module Google # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) - @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end @@ -2577,26 +2468,23 @@ module Google class ServiceAccountKey include Google::Apis::Core::Hashable - # The body of the private key credentials file, in string format. This is only - # populated when the ServiceAccountKey is created, and is not stored by Google. + # The body of the private key credentials file, in string format. This + # is only populated when the ServiceAccountKey is created, and is not stored + # by Google. # Corresponds to the JSON property `data` # @return [String] attr_accessor :data - # An opaque, unique identifier for this ServiceAccountKey. Assigned by the - # server. + # An opaque, unique identifier for this ServiceAccountKey. + # Assigned by the server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # Public key data for the credentials file. This is an X.509 cert. If you are - # using the googleCredentials key type, this is identical to the cert that can - # be retrieved by using the X.509 cert url inside of the credentials file. + # using the googleCredentials key type, this is identical to the + # cert that can be retrieved by using the X.509 cert url inside of the + # credentials file. # Corresponds to the JSON property `publicData` # @return [String] attr_accessor :public_data @@ -2614,7 +2502,6 @@ module Google def update!(**args) @data = args[:data] if args.key?(:data) @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) @public_data = args[:public_data] if args.key?(:public_data) @type = args[:type] if args.key?(:type) end @@ -2639,13 +2526,13 @@ module Google end end - # A resource returned by the GenerateSignupUrl API, which contains the Signup - # URL and Completion Token. + # A resource returned by the GenerateSignupUrl API, which contains the + # Signup URL and Completion Token. class SignupInfo include Google::Apis::Core::Hashable - # An opaque token that will be required, along with the Enterprise Token, for - # obtaining the enterprise resource from CompleteSignup. + # An opaque token that will be required, along with the Enterprise Token, + # for obtaining the enterprise resource from CompleteSignup. # Corresponds to the JSON property `completionToken` # @return [String] attr_accessor :completion_token @@ -2655,8 +2542,8 @@ module Google # @return [String] attr_accessor :kind - # A URL under which the Admin can sign up for an enterprise. The page pointed to - # cannot be rendered in an iframe. + # A URL under which the Admin can sign up for an enterprise. + # The page pointed to cannot be rendered in an iframe. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -2683,30 +2570,28 @@ module Google # @return [String] attr_accessor :id - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Ordered list of localized strings giving the name of this page. The text - # displayed is the one that best matches the user locale, or the first entry if - # there is no good match. There needs to be at least one entry. + # Ordered list of localized strings giving the name of this page. + # The text displayed is the one that best matches the user locale, + # or the first entry if there is no good match. There needs to be + # at least one entry. # Corresponds to the JSON property `name` # @return [Array] attr_accessor :name # String (US-ASCII only) used to determine order of this cluster within the - # parent page's elements. Page elements are sorted in lexicographic order of - # this field. Duplicated values are allowed, but ordering between elements with + # parent page's elements. Page elements are sorted in lexicographic order + # of this field. + # Duplicated values are allowed, but ordering between elements with # duplicate order is undefined. - # The value of this field is never visible to a user, it is used solely for the - # purpose of defining an ordering. Maximum length is 256 characters. + # The value of this field is never visible to a user, it is used solely + # for the purpose of defining an ordering. Maximum length is 256 + # characters. # Corresponds to the JSON property `orderInPage` # @return [String] attr_accessor :order_in_page - # List of products in the order they are displayed in the cluster. There should - # not be duplicates within a cluster. + # List of products in the order they are displayed in the cluster. There + # should not be duplicates within a cluster. # Corresponds to the JSON property `productId` # @return [Array] attr_accessor :product_id @@ -2718,35 +2603,30 @@ module Google # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @order_in_page = args[:order_in_page] if args.key?(:order_in_page) @product_id = args[:product_id] if args.key?(:product_id) end end - # General setting for the managed Google Play store layout, currently only - # specifying the page to display the first time the store is opened. + # General setting for the managed Google Play store layout, + # currently only specifying the page to display the first time + # the store is opened. class StoreLayout include Google::Apis::Core::Hashable - # The ID of the store page to be used as the homepage. The homepage is the first - # page shown in the managed Google Play Store. - # Not specifying a homepage is equivalent to setting the store layout type to " - # basic". + # The ID of the store page to be used as the homepage. The homepage is the + # first page shown in the managed Google Play Store. + # Not specifying a homepage is equivalent to setting the store layout + # type to "basic". # Corresponds to the JSON property `homepageId` # @return [String] attr_accessor :homepage_id - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The store layout type. By default, this value is set to "basic" if the - # homepageId field is not set, and to "custom" otherwise. If set to "basic", the - # layout will consist of all approved apps that have been whitelisted for the - # user. + # The store layout type. By default, this value is set to "basic" + # if the homepageId field is not set, and to "custom" otherwise. + # If set to "basic", the layout will consist of all approved apps that + # have been whitelisted for the user. # Corresponds to the JSON property `storeLayoutType` # @return [String] attr_accessor :store_layout_type @@ -2758,12 +2638,11 @@ module Google # Update properties of this object def update!(**args) @homepage_id = args[:homepage_id] if args.key?(:homepage_id) - @kind = args[:kind] if args.key?(:kind) @store_layout_type = args[:store_layout_type] if args.key?(:store_layout_type) end end - # The store page resources for the enterprise. + # class StoreLayoutClustersListResponse include Google::Apis::Core::Hashable @@ -2772,12 +2651,6 @@ module Google # @return [Array] attr_accessor :cluster - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#storeLayoutClustersListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - def initialize(**args) update!(**args) end @@ -2785,20 +2658,13 @@ module Google # Update properties of this object def update!(**args) @cluster = args[:cluster] if args.key?(:cluster) - @kind = args[:kind] if args.key?(:kind) end end - # The store page resources for the enterprise. + # class StoreLayoutPagesListResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#storeLayoutPagesListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # A store page of an enterprise. # Corresponds to the JSON property `page` # @return [Array] @@ -2810,13 +2676,13 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @page = args[:page] if args.key?(:page) end end - # Definition of a managed Google Play store page, made of a localized name and - # links to other pages. A page also contains clusters defined as a subcollection. + # Definition of a managed Google Play store page, made of a localized name + # and links to other pages. A page also contains clusters defined + # as a subcollection. class StorePage include Google::Apis::Core::Hashable @@ -2825,22 +2691,19 @@ module Google # @return [String] attr_accessor :id - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Ordered list of pages a user should be able to reach from this page. The list - # can't include this page. It is recommended that the basic pages are created - # first, before adding the links between pages. + # Ordered list of pages a user should be able to reach from this page. + # The list can't include this page. + # It is recommended that the basic pages are created first, + # before adding the links between pages. # The API doesn't verify that the pages exist or the pages are reachable. # Corresponds to the JSON property `link` # @return [Array] attr_accessor :link - # Ordered list of localized strings giving the name of this page. The text - # displayed is the one that best matches the user locale, or the first entry if - # there is no good match. There needs to be at least one entry. + # Ordered list of localized strings giving the name of this page. + # The text displayed is the one that best matches the user locale, + # or the first entry if there is no good match. There needs to be + # at least one entry. # Corresponds to the JSON property `name` # @return [Array] attr_accessor :name @@ -2852,17 +2715,25 @@ module Google # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) @link = args[:link] if args.key?(:link) @name = args[:name] if args.key?(:name) end end - # + # Pagination information returned by a List operation when token pagination + # is enabled. + # List operations that supports paging return only one "page" of results. This + # protocol buffer message describes the page that has been returned. + # When using token pagination, clients should use the next/previous token + # to get another page of the result. The presence or absence of next/previous + # token indicates whether a next/previous page is available and provides a + # mean of accessing this page. ListRequest.page_token should be set to either + # next_page_token or previous_page_token to access another page. class TokenPagination include Google::Apis::Core::Hashable - # + # Tokens to pass to the standard list field 'page_token'. Whenever available, + # tokens are preferred over manipulating start_index. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2887,15 +2758,15 @@ module Google class TrackInfo include Google::Apis::Core::Hashable - # A modifiable name for a track. This is the visible name in the play developer - # console. + # A modifiable name for a track. This is the visible name in the play + # developer console. # Corresponds to the JSON property `trackAlias` # @return [String] attr_accessor :track_alias - # Unmodifiable, unique track identifier. This identifier is the releaseTrackId - # in the url of the play developer console page that displays the track - # information. + # Unmodifiable, unique track identifier. This identifier is the + # releaseTrackId in the url of the play developer console page that displays + # the track information. # Corresponds to the JSON property `trackId` # @return [String] attr_accessor :track_id @@ -2912,37 +2783,43 @@ module Google end # A Users resource represents an account associated with an enterprise. The - # account may be specific to a device or to an individual user (who can then use - # the account across multiple devices). The account may provide access to + # account may be specific to a device or to an individual user (who can then + # use the account across multiple devices). The account may provide access to # managed Google Play only, or to other Google services, depending on the # identity model: - # - The Google managed domain identity model requires synchronization to Google - # account sources (via primaryEmail). - # - The managed Google Play Accounts identity model provides a dynamic means for - # enterprises to create user or device accounts as needed. These accounts - # provide access to managed Google Play. + #
  • The Google managed domain identity model requires synchronization to + # Google account sources (via primaryEmail).
  • + #
  • The managed Google Play Accounts identity model provides a dynamic means + # for enterprises to create user or device accounts as needed. These accounts + # provide access to managed Google Play.
  • + #
class User include Google::Apis::Core::Hashable - # A unique identifier you create for this user, such as "user342" or "asset# - # 44418". Do not use personally identifiable information (PII) for this property. - # Must always be set for EMM-managed users. Not set for Google-managed users. + # A unique identifier you create for this user, such as "user342" or + # "asset#44418". Do not use personally identifiable information (PII) for + # this property. Must always be set for EMM-managed users. + # Not set for Google-managed users. # Corresponds to the JSON property `accountIdentifier` # @return [String] attr_accessor :account_identifier - # The type of account that this user represents. A userAccount can be installed - # on multiple devices, but a deviceAccount is specific to a single device. An - # EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), - # but a Google-managed user (googleManaged) is always a userAccount. + # The type of account that this user represents. A userAccount + # can be installed on multiple devices, but a deviceAccount is + # specific to a single device. An EMM-managed user (emmManaged) + # can be either type (userAccount, deviceAccount), + # but a Google-managed user (googleManaged) is always a + # userAccount. # Corresponds to the JSON property `accountType` # @return [String] attr_accessor :account_type # The name that will appear in user interfaces. Setting this property is - # optional when creating EMM-managed users. If you do set this property, use - # something generic about the organization (such as "Example, Inc.") or your - # name (as EMM). Not used for Google-managed user accounts. + # optional when creating EMM-managed users. If you do set this property, + # use something generic about the organization (such as "Example, Inc.") or + # your name (as EMM). + # Not used for Google-managed user accounts. + # @mutable androidenterprise.users.update # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -2952,20 +2829,17 @@ module Google # @return [String] attr_accessor :id - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The entity that manages the user. With googleManaged users, the source of - # truth is Google so EMMs have to make sure a Google Account exists for the user. - # With emmManaged users, the EMM is in charge. + # The entity that manages the user. With googleManaged users, + # the source of truth is Google so EMMs have to make sure a Google Account + # exists for the user. With emmManaged users, the + # EMM is in charge. # Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type - # The user's primary email address, for example, "jsmith@example.com". Will - # always be set for Google managed users and not set for EMM managed users. + # The user's primary email address, for example, "jsmith@example.com". + # Will always be set for Google managed users and not set for EMM managed + # users. # Corresponds to the JSON property `primaryEmail` # @return [String] attr_accessor :primary_email @@ -2980,57 +2854,15 @@ module Google @account_type = args[:account_type] if args.key?(:account_type) @display_name = args[:display_name] if args.key?(:display_name) @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) @management_type = args[:management_type] if args.key?(:management_type) @primary_email = args[:primary_email] if args.key?(:primary_email) end end - # A UserToken is used by a user when setting up a managed device or profile with - # their managed Google Play account on a device. When the user enters their - # email address and token (activation code) the appropriate EMM app can be - # automatically downloaded. - class UserToken - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The token (activation code) to be entered by the user. This consists of a - # sequence of decimal digits. Note that the leading digit may be 0. - # Corresponds to the JSON property `token` - # @return [String] - attr_accessor :token - - # The unique ID for the user. - # Corresponds to the JSON property `userId` - # @return [String] - attr_accessor :user_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @token = args[:token] if args.key?(:token) - @user_id = args[:user_id] if args.key?(:user_id) - end - end - - # The matching user resources. + # class ListUsersResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#usersListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # A user of an enterprise. # Corresponds to the JSON property `user` # @return [Array] @@ -3042,23 +2874,17 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @user = args[:user] if args.key?(:user) end end - # A variable set is a key-value pair of EMM-provided placeholders and its - # corresponding value, which is attributed to a user. For example, $FIRSTNAME - # could be a placeholder, and its value could be Alice. Placeholders should - # start with a '$' sign and should be alphanumeric only. + # A variable set is a key-value pair of EMM-provided placeholders and + # its corresponding value, which is attributed to a user. For example, + # $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders + # should start with a '$' sign and should be alphanumeric only. class VariableSet include Google::Apis::Core::Hashable - # - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The placeholder string; defined by EMM. # Corresponds to the JSON property `placeholder` # @return [String] @@ -3075,29 +2901,29 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @placeholder = args[:placeholder] if args.key?(:placeholder) @user_value = args[:user_value] if args.key?(:user_value) end end # A WebApps resource represents a web app created for an enterprise. Web apps - # are published to managed Google Play and can be distributed like other Android - # apps. On a user's device, a web app opens its specified URL. + # are published to managed Google Play and can be distributed like other + # Android apps. On a user's device, a web app opens its specified URL. class WebApp include Google::Apis::Core::Hashable - # The display mode of the web app. + # The display mode of the web app.

# Possible values include: - # - "minimalUi", the device's status bar, navigation bar, the app's URL, and a - # refresh button are visible when the app is open. For HTTP URLs, you can only - # select this option. - # - "standalone", the device's status bar and navigation bar are visible when - # the app is open. - # - "fullScreen", the app opens in full screen mode, hiding the device's status - # and navigation bars. All browser UI elements, page URL, system status bar and - # back button are not visible, and the web app takes up the entirety of the - # available display area. + #
  • "minimalUi", the device's status bar, navigation bar, + # the app's URL, and a refresh button are visible when the app is open. For + # HTTP URLs, you can only select this option. + #
  • "standalone", the device's status bar and navigation + # bar are visible when the app is open. + #
  • "fullScreen", the app opens in full screen mode, hiding + # the device's status and navigation bars. All browser UI elements, page + # URL, system status bar and back button are not visible, and the web app + # takes up the entirety of the available display area. + #
# Corresponds to the JSON property `displayMode` # @return [String] attr_accessor :display_mode @@ -3127,16 +2953,18 @@ module Google attr_accessor :title # The current version of the app. - # Note that the version can automatically increase during the lifetime of the - # web app, while Google does internal housekeeping to keep the web app up-to- - # date. + #

Note that the version can automatically increase during the lifetime of + # the web app, while Google does internal housekeeping to keep the web app + # up-to-date. # Corresponds to the JSON property `versionCode` # @return [Fixnum] attr_accessor :version_code - # The ID of the application. A string of the form "app:" where the - # package name always starts with the prefix "com.google.enterprise.webapp." - # followed by a random id. + # The ID of the application. A string of the form + # "app:<package name>" where the package name + # always starts with the prefix + # "com.google.enterprise.webapp." followed by a + # random id. # Corresponds to the JSON property `webAppId` # @return [String] attr_accessor :web_app_id @@ -3163,9 +2991,11 @@ module Google # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, # section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - # - The image type can be png or jpg. - # - The image should ideally be square. - # - The image should ideally have a size of 512x512. + #

    + #
  • The image type can be png or jpg. + #
  • The image should ideally be square. + #
  • The image should ideally have a size of 512x512. + #
# Corresponds to the JSON property `imageData` # @return [String] attr_accessor :image_data @@ -3180,16 +3010,10 @@ module Google end end - # The web app details for an enterprise. + # class WebAppsListResponse include Google::Apis::Core::Hashable - # Identifies what kind of resource this is. Value: the fixed string " - # androidenterprise#webAppsListResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - # The manifest describing a web app. # Corresponds to the JSON property `webApp` # @return [Array] @@ -3201,7 +3025,6 @@ module Google # Update properties of this object def update!(**args) - @kind = args[:kind] if args.key?(:kind) @web_app = args[:web_app] if args.key?(:web_app) end end diff --git a/generated/google/apis/androidenterprise_v1/representations.rb b/generated/google/apis/androidenterprise_v1/representations.rb index 34d11146f..4d174af2d 100644 --- a/generated/google/apis/androidenterprise_v1/representations.rb +++ b/generated/google/apis/androidenterprise_v1/representations.rb @@ -490,12 +490,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class UserToken - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ListUsersResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -536,7 +530,6 @@ module Google class AdministratorWebToken # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :token, as: 'token' end end @@ -544,7 +537,6 @@ module Google class AdministratorWebTokenSpec # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :managed_configurations, as: 'managedConfigurations', class: Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpecManagedConfigurations, decorator: Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpecManagedConfigurations::Representation property :parent, as: 'parent' @@ -670,14 +662,12 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :approval_url, as: 'approvalUrl' - property :kind, as: 'kind' end end class AuthenticationToken # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :token, as: 'token' end end @@ -705,7 +695,6 @@ module Google class ConfigurationVariables # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :mcm_id, as: 'mcmId' collection :variable_set, as: 'variableSet', class: Google::Apis::AndroidenterpriseV1::VariableSet, decorator: Google::Apis::AndroidenterpriseV1::VariableSet::Representation @@ -716,7 +705,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :android_id, as: 'androidId' - property :kind, as: 'kind' property :management_type, as: 'managementType' property :policy, as: 'policy', class: Google::Apis::AndroidenterpriseV1::Policy, decorator: Google::Apis::AndroidenterpriseV1::Policy::Representation @@ -748,7 +736,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_state, as: 'accountState' - property :kind, as: 'kind' end end @@ -757,7 +744,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :device, as: 'device', class: Google::Apis::AndroidenterpriseV1::Device, decorator: Google::Apis::AndroidenterpriseV1::Device::Representation - property :kind, as: 'kind' end end @@ -767,7 +753,6 @@ module Google collection :administrator, as: 'administrator', class: Google::Apis::AndroidenterpriseV1::Administrator, decorator: Google::Apis::AndroidenterpriseV1::Administrator::Representation property :id, as: 'id' - property :kind, as: 'kind' property :name, as: 'name' property :primary_domain, as: 'primaryDomain' end @@ -777,7 +762,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :account_email, as: 'accountEmail' - property :kind, as: 'kind' end end @@ -786,7 +770,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :enterprise, as: 'enterprise', class: Google::Apis::AndroidenterpriseV1::Enterprise, decorator: Google::Apis::AndroidenterpriseV1::Enterprise::Representation - property :kind, as: 'kind' end end @@ -801,7 +784,6 @@ module Google class Entitlement # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :product_id, as: 'productId' property :reason, as: 'reason' end @@ -812,7 +794,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :entitlement, as: 'entitlement', class: Google::Apis::AndroidenterpriseV1::Entitlement, decorator: Google::Apis::AndroidenterpriseV1::Entitlement::Representation - property :kind, as: 'kind' end end @@ -821,7 +802,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :acquisition_kind, as: 'acquisitionKind' property :approval, as: 'approval' - property :kind, as: 'kind' property :num_provisioned, as: 'numProvisioned' property :num_purchased, as: 'numPurchased' property :permissions, as: 'permissions' @@ -832,7 +812,6 @@ module Google class ListGroupLicenseUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :user, as: 'user', class: Google::Apis::AndroidenterpriseV1::User, decorator: Google::Apis::AndroidenterpriseV1::User::Representation end @@ -843,7 +822,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :group_license, as: 'groupLicense', class: Google::Apis::AndroidenterpriseV1::GroupLicense, decorator: Google::Apis::AndroidenterpriseV1::GroupLicense::Representation - property :kind, as: 'kind' end end @@ -851,7 +829,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :install_state, as: 'installState' - property :kind, as: 'kind' property :product_id, as: 'productId' property :version_code, as: 'versionCode' end @@ -873,7 +850,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :install, as: 'install', class: Google::Apis::AndroidenterpriseV1::Install, decorator: Google::Apis::AndroidenterpriseV1::Install::Representation - property :kind, as: 'kind' end end @@ -919,7 +895,6 @@ module Google class ManagedConfigurationsForDeviceListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :managed_configuration_for_device, as: 'managedConfigurationForDevice', class: Google::Apis::AndroidenterpriseV1::ManagedConfiguration, decorator: Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation end @@ -928,7 +903,6 @@ module Google class ManagedConfigurationsForUserListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :managed_configuration_for_user, as: 'managedConfigurationForUser', class: Google::Apis::AndroidenterpriseV1::ManagedConfiguration, decorator: Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation end @@ -937,7 +911,6 @@ module Google class ManagedConfigurationsSettings # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :last_updated_timestamp_millis, :numeric_string => true, as: 'lastUpdatedTimestampMillis' property :mcm_id, as: 'mcmId' property :name, as: 'name' @@ -947,7 +920,6 @@ module Google class ManagedConfigurationsSettingsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :managed_configurations_settings, as: 'managedConfigurationsSettings', class: Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettings, decorator: Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettings::Representation end @@ -1023,7 +995,6 @@ module Google class NotificationSet # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :notification, as: 'notification', class: Google::Apis::AndroidenterpriseV1::Notification, decorator: Google::Apis::AndroidenterpriseV1::Notification::Representation property :notification_set_id, as: 'notificationSetId' @@ -1043,7 +1014,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' - property :kind, as: 'kind' property :name, as: 'name' property :permission_id, as: 'permissionId' end @@ -1079,7 +1049,6 @@ module Google property :distribution_channel, as: 'distributionChannel' collection :features, as: 'features' property :icon_url, as: 'iconUrl' - property :kind, as: 'kind' property :last_updated_timestamp_millis, :numeric_string => true, as: 'lastUpdatedTimestampMillis' property :min_android_sdk_version, as: 'minAndroidSdkVersion' collection :permissions, as: 'permissions', class: Google::Apis::AndroidenterpriseV1::ProductPermission, decorator: Google::Apis::AndroidenterpriseV1::ProductPermission::Representation @@ -1124,7 +1093,6 @@ module Google class ProductPermissions # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :permission, as: 'permission', class: Google::Apis::AndroidenterpriseV1::ProductPermission, decorator: Google::Apis::AndroidenterpriseV1::ProductPermission::Representation property :product_id, as: 'productId' @@ -1147,7 +1115,6 @@ module Google class ProductSet # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :product_id, as: 'productId' property :product_set_behavior, as: 'productSetBehavior' collection :product_visibility, as: 'productVisibility', class: Google::Apis::AndroidenterpriseV1::ProductVisibility, decorator: Google::Apis::AndroidenterpriseV1::ProductVisibility::Representation @@ -1191,7 +1158,6 @@ module Google class ProductsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :page_info, as: 'pageInfo', class: Google::Apis::AndroidenterpriseV1::PageInfo, decorator: Google::Apis::AndroidenterpriseV1::PageInfo::Representation collection :product, as: 'product', class: Google::Apis::AndroidenterpriseV1::Product, decorator: Google::Apis::AndroidenterpriseV1::Product::Representation @@ -1206,7 +1172,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :key, as: 'key', class: Google::Apis::AndroidenterpriseV1::ServiceAccountKey, decorator: Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation - property :kind, as: 'kind' property :name, as: 'name' end end @@ -1216,7 +1181,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :data, as: 'data' property :id, as: 'id' - property :kind, as: 'kind' property :public_data, as: 'publicData' property :type, as: 'type' end @@ -1243,7 +1207,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' - property :kind, as: 'kind' collection :name, as: 'name', class: Google::Apis::AndroidenterpriseV1::LocalizedText, decorator: Google::Apis::AndroidenterpriseV1::LocalizedText::Representation property :order_in_page, as: 'orderInPage' @@ -1255,7 +1218,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :homepage_id, as: 'homepageId' - property :kind, as: 'kind' property :store_layout_type, as: 'storeLayoutType' end end @@ -1265,14 +1227,12 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :cluster, as: 'cluster', class: Google::Apis::AndroidenterpriseV1::StoreCluster, decorator: Google::Apis::AndroidenterpriseV1::StoreCluster::Representation - property :kind, as: 'kind' end end class StoreLayoutPagesListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :page, as: 'page', class: Google::Apis::AndroidenterpriseV1::StorePage, decorator: Google::Apis::AndroidenterpriseV1::StorePage::Representation end @@ -1282,7 +1242,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :id, as: 'id' - property :kind, as: 'kind' collection :link, as: 'link' collection :name, as: 'name', class: Google::Apis::AndroidenterpriseV1::LocalizedText, decorator: Google::Apis::AndroidenterpriseV1::LocalizedText::Representation @@ -1312,25 +1271,14 @@ module Google property :account_type, as: 'accountType' property :display_name, as: 'displayName' property :id, as: 'id' - property :kind, as: 'kind' property :management_type, as: 'managementType' property :primary_email, as: 'primaryEmail' end end - class UserToken - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :token, as: 'token' - property :user_id, as: 'userId' - end - end - class ListUsersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :user, as: 'user', class: Google::Apis::AndroidenterpriseV1::User, decorator: Google::Apis::AndroidenterpriseV1::User::Representation end @@ -1339,7 +1287,6 @@ module Google class VariableSet # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' property :placeholder, as: 'placeholder' property :user_value, as: 'userValue' end @@ -1369,7 +1316,6 @@ module Google class WebAppsListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' collection :web_app, as: 'webApp', class: Google::Apis::AndroidenterpriseV1::WebApp, decorator: Google::Apis::AndroidenterpriseV1::WebApp::Representation end diff --git a/generated/google/apis/androidenterprise_v1/service.rb b/generated/google/apis/androidenterprise_v1/service.rb index e7fc22a61..6a9025a58 100644 --- a/generated/google/apis/androidenterprise_v1/service.rb +++ b/generated/google/apis/androidenterprise_v1/service.rb @@ -22,7 +22,7 @@ module Google module AndroidenterpriseV1 # Google Play EMM API # - # Manages the deployment of apps to Android for Work users. + # Manages the deployment of apps to Android Enterprise devices. # # @example # require 'google/apis/androidenterprise_v1' @@ -38,22 +38,20 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # 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 - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'androidenterprise/v1/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/androidenterprise/v1' end - # Uploads a report containing any changes in app states on the device since the - # last report was generated. You can call this method up to 3 times every 24 - # hours for a given device. + # Uploads a report containing any changes in app states on the device since + # the last report was generated. You can call this method up to 3 times every + # 24 hours for a given device. + # If you exceed the quota, then the Google Play EMM API returns HTTP + # 429 Too Many Requests. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -63,10 +61,8 @@ module Google # @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. + # 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 # @@ -79,14 +75,13 @@ module Google # @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 force_device_report_upload(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload', options) + def force_device_report_upload(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_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 @@ -100,10 +95,8 @@ module Google # @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. + # 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 # @@ -116,8 +109,8 @@ module Google # @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_device(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options) + def get_device(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Device command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -125,15 +118,16 @@ module Google command.params['deviceId'] = device_id unless device_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 whether a device's access to Google services is enabled or disabled. + # Retrieves whether a device's access to Google services is enabled or + # disabled. # The device state takes effect only if enforcing EMM policies on Android - # devices is enabled in the Google Admin Console. Otherwise, the device state is - # ignored and all devices are allowed access to Google services. This is only - # supported for Google-managed users. + # devices is enabled in the Google Admin Console. + # Otherwise, the device state is ignored and all devices are allowed access + # to Google services. + # This is only supported for Google-managed users. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -143,10 +137,8 @@ module Google # @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. + # 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 # @@ -159,8 +151,8 @@ module Google # @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_device_state(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options) + def get_device_state(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options) command.response_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation command.response_class = Google::Apis::AndroidenterpriseV1::DeviceState command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -168,7 +160,6 @@ module Google command.params['deviceId'] = device_id unless device_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 @@ -180,10 +171,8 @@ module Google # @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. + # 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 # @@ -196,23 +185,23 @@ module Google # @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_devices(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices', options) + def list_devices(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListDevicesResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListDevicesResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 - # Sets whether a device's access to Google services is enabled or disabled. The - # device state takes effect only if enforcing EMM policies on Android devices is - # enabled in the Google Admin Console. Otherwise, the device state is ignored - # and all devices are allowed access to Google services. This is only supported - # for Google-managed users. + # Sets whether a device's access to Google services is enabled or disabled. + # The device state takes effect only if enforcing EMM policies on Android + # devices is enabled in the Google Admin Console. + # Otherwise, the device state is ignored and all devices are allowed access + # to Google services. + # This is only supported for Google-managed users. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -223,10 +212,8 @@ module Google # @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. + # 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 # @@ -239,8 +226,8 @@ module Google # @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 set_device_state(enterprise_id, user_id, device_id, device_state_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options) + def set_device_state(enterprise_id, user_id, device_id, device_state_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/state', options) command.request_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation command.request_object = device_state_object command.response_representation = Google::Apis::AndroidenterpriseV1::DeviceState::Representation @@ -250,7 +237,6 @@ module Google command.params['deviceId'] = device_id unless device_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 @@ -263,17 +249,15 @@ module Google # The ID of the device. # @param [Google::Apis::AndroidenterpriseV1::Device] device_object # @param [String] update_mask - # Mask that identifies which fields to update. If not set, all modifiable fields - # will be modified. - # When set in a query parameter, this field should be specified as updateMask=< - # field1>,,... + # Mask that identifies which fields to update. If not set, all modifiable + # fields will be modified. + # When set in a query parameter, this field should be specified as + # updateMask=<field1>,<field2>,... # @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. + # 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 # @@ -286,8 +270,8 @@ module Google # @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_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options) + def update_device(enterprise_id, user_id, device_id, device_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Device::Representation command.request_object = device_object command.response_representation = Google::Apis::AndroidenterpriseV1::Device::Representation @@ -298,23 +282,20 @@ module Google command.query['updateMask'] = update_mask unless update_mask.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 - # Acknowledges notifications that were received from Enterprises. - # PullNotificationSet to prevent subsequent calls from returning the same - # notifications. + # Acknowledges notifications that were received from + # Enterprises.PullNotificationSet to prevent subsequent calls from returning + # the same notifications. # @param [String] notification_set_id - # The notification set ID as returned by Enterprises.PullNotificationSet. This - # must be provided. + # The notification set ID as returned by Enterprises.PullNotificationSet. + # This must be provided. # @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. + # 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 # @@ -327,17 +308,17 @@ module Google # @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 acknowledge_enterprise_notification_set(notification_set_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/acknowledgeNotificationSet', options) + def acknowledge_enterprise_notification_set(notification_set_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/acknowledgeNotificationSet', options) command.query['notificationSetId'] = notification_set_id unless notification_set_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 - # Completes the signup flow, by specifying the Completion token and Enterprise - # token. This request must not be called multiple times for a given Enterprise + # Completes the signup flow, by specifying the Completion token and + # Enterprise token. + # This request must not be called multiple times for a given Enterprise # Token. # @param [String] completion_token # The Completion token initially returned by GenerateSignupUrl. @@ -346,10 +327,8 @@ module Google # @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. + # 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 # @@ -362,32 +341,29 @@ module Google # @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 complete_enterprise_signup(completion_token: nil, enterprise_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/completeSignup', options) + def complete_enterprise_signup(completion_token: nil, enterprise_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/completeSignup', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise command.query['completionToken'] = completion_token unless completion_token.nil? command.query['enterpriseToken'] = enterprise_token unless enterprise_token.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 - # Returns a unique token to access an embeddable UI. To generate a web UI, pass - # the generated token into the managed Google Play javascript API. Each token - # may only be used to start one UI session. See the javascript API documentation - # for further information. + # Returns a unique token to access an embeddable UI. To generate a + # web UI, pass the generated token into the managed Google Play javascript + # API. Each token may only be used to start one UI session. See the + # javascript API documentation for further information. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpec] administrator_web_token_spec_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. + # 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 # @@ -400,8 +376,8 @@ module Google # @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 create_enterprise_web_token(enterprise_id, administrator_web_token_spec_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/createWebToken', options) + def create_enterprise_web_token(enterprise_id, administrator_web_token_spec_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/createWebToken', options) command.request_representation = Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpec::Representation command.request_object = administrator_web_token_spec_object command.response_representation = Google::Apis::AndroidenterpriseV1::AdministratorWebToken::Representation @@ -409,21 +385,18 @@ module Google command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Enrolls an enterprise with the calling EMM. # @param [String] token - # The token provided by the enterprise to register the EMM. + # Required. The token provided by the enterprise to register the EMM. # @param [Google::Apis::AndroidenterpriseV1::Enterprise] enterprise_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. + # 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 # @@ -436,8 +409,8 @@ module Google # @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 enroll_enterprise(token, enterprise_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/enroll', options) + def enroll_enterprise(token, enterprise_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/enroll', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.request_object = enterprise_object command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation @@ -445,26 +418,24 @@ module Google command.query['token'] = token unless token.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 # Generates a sign-up URL. # @param [String] callback_url # The callback URL to which the Admin will be redirected after successfully - # creating an enterprise. Before redirecting there the system will add a single - # query parameter to this URL named "enterpriseToken" which will contain an - # opaque token to be used for the CompleteSignup request. - # Beware that this means that the URL will be parsed, the parameter added and - # then a new URL formatted, i.e. there may be some minor formatting changes and, - # more importantly, the URL must be well-formed so that it can be parsed. + # creating an enterprise. Before redirecting there the system will add a + # single query parameter to this URL named "enterpriseToken" which will + # contain an opaque token to be used for the CompleteSignup request.
+ # Beware that this means that the URL will be parsed, the parameter added + # and then a new URL formatted, i.e. there may be some minor formatting + # changes and, more importantly, the URL must be well-formed so that it can + # be parsed. # @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. + # 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 # @@ -477,14 +448,13 @@ module Google # @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_enterprise_signup_url(callback_url: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/signupUrl', options) + def generate_enterprise_signup_url(callback_url: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/signupUrl', options) command.response_representation = Google::Apis::AndroidenterpriseV1::SignupInfo::Representation command.response_class = Google::Apis::AndroidenterpriseV1::SignupInfo command.query['callbackUrl'] = callback_url unless callback_url.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 @@ -494,10 +464,8 @@ module Google # @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. + # 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 # @@ -510,28 +478,31 @@ module Google # @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_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}', options) + def get_enterprise(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Enterprise::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Enterprise command.params['enterpriseId'] = enterprise_id unless enterprise_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 - # Returns a service account and credentials. The service account can be bound to - # the enterprise by calling setAccount. The service account is unique to this - # enterprise and EMM, and will be deleted if the enterprise is unbound. The - # credentials contain private key data and are not stored server-side. - # This method can only be called after calling Enterprises.Enroll or Enterprises. - # CompleteSignup, and before Enterprises.SetAccount; at other times it will - # return an error. + # Returns a service account and credentials. The service account + # can be bound to the enterprise by calling setAccount. The service account + # is unique to this enterprise and EMM, and will be deleted if the enterprise + # is unbound. The credentials contain private key data and are not stored + # server-side. + #

+ # This method can only be called after calling + # Enterprises.Enroll or Enterprises.CompleteSignup, and before + # Enterprises.SetAccount; at other times it will return an error. + #

# Subsequent calls after the first will generate a new, unique set of # credentials, and invalidate the previously generated credentials. - # Once the service account is bound to the enterprise, it can be managed using - # the serviceAccountKeys resource. + #

+ # Once the service account is bound to the enterprise, it can be managed + # using the serviceAccountKeys resource. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] key_type @@ -539,10 +510,8 @@ module Google # @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. + # 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 # @@ -555,29 +524,27 @@ module Google # @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_enterprise_service_account(enterprise_id, key_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/serviceAccount', options) + def get_enterprise_service_account(enterprise_id, key_type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/serviceAccount', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccount::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccount command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.query['keyType'] = key_type unless key_type.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 - # Returns the store layout for the enterprise. If the store layout has not been - # set, returns "basic" as the store layout type and no homepage. + # Returns the store layout for the enterprise. If the store layout + # has not been set, returns "basic" as the store layout type and no + # homepage. # @param [String] enterprise_id # The ID of the enterprise. # @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. + # 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 # @@ -590,31 +557,28 @@ module Google # @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_enterprise_store_layout(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout', options) + def get_enterprise_store_layout(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayout command.params['enterpriseId'] = enterprise_id unless enterprise_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 - # Looks up an enterprise by domain name. This is only supported for enterprises - # created via the Google-initiated creation flow. Lookup of the id is not needed - # for enterprises created via the EMM-initiated flow since the EMM learns the - # enterprise ID in the callback specified in the Enterprises.generateSignupUrl - # call. + # Looks up an enterprise by domain name. + # This is only supported for enterprises created via the Google-initiated + # creation flow. Lookup of the id is not needed for enterprises created via + # the EMM-initiated flow since the EMM learns the enterprise ID in the + # callback specified in the Enterprises.generateSignupUrl call. # @param [String] domain - # The exact primary domain name of the enterprise to look up. + # Required. The exact primary domain name of the enterprise to look up. # @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. + # 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 # @@ -627,47 +591,53 @@ module Google # @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_enterprises(domain, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises', options) + def list_enterprises(domain, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListEnterprisesResponse command.query['domain'] = domain unless domain.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 - # Pulls and returns a notification set for the enterprises associated with the - # service account authenticated for the request. The notification set may be - # empty if no notification are pending. - # A notification set returned needs to be acknowledged within 20 seconds by - # calling Enterprises.AcknowledgeNotificationSet, unless the notification set is - # empty. - # Notifications that are not acknowledged within the 20 seconds will eventually - # be included again in the response to another PullNotificationSet request, and - # those that are never acknowledged will ultimately be deleted according to the - # Google Cloud Platform Pub/Sub system policy. - # Multiple requests might be performed concurrently to retrieve notifications, - # in which case the pending notifications (if any) will be split among each - # caller, if any are pending. + # Pulls and returns a notification set for the enterprises associated with + # the service account authenticated for the request. The notification set may + # be empty if no notification are pending. + #
+ # A notification set returned needs to be acknowledged within 20 seconds + # by calling Enterprises.AcknowledgeNotificationSet, unless the + # notification set is empty. + #
+ # Notifications that are not acknowledged within the 20 seconds will + # eventually be included again in the response to another PullNotificationSet + # request, and those that are never acknowledged will ultimately be deleted + # according to the Google Cloud Platform Pub/Sub system policy. + #
+ # Multiple requests might be performed concurrently to retrieve + # notifications, in which case the pending notifications (if any) will be + # split among each caller, if any are pending. + #
# If no notifications are present, an empty notification list is returned. - # Subsequent requests may return more notifications once they become available. + # Subsequent requests may return more notifications once they become + # available. # @param [String] request_mode # The request mode for pulling notifications. - # Specifying waitForNotifications will cause the request to block and wait until - # one or more notifications are present, or return an empty notification list if - # no notifications are present after some time. - # Speciying returnImmediately will cause the request to immediately return the - # pending notifications, or an empty list if no notifications are present. - # If omitted, defaults to waitForNotifications. + #
+ # Specifying waitForNotifications will cause the request to + # block and wait until one or more notifications are present, or return an + # empty notification list if no notifications are present after some time. + #
+ # Speciying returnImmediately will cause the request to + # immediately return the pending notifications, or an empty list if no + # notifications are present. + #
+ # If omitted, defaults to waitForNotifications. # @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. + # 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 # @@ -680,28 +650,25 @@ module Google # @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 pull_enterprise_notification_set(request_mode: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/pullNotificationSet', options) + def pull_enterprise_notification_set(request_mode: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/pullNotificationSet', options) command.response_representation = Google::Apis::AndroidenterpriseV1::NotificationSet::Representation command.response_class = Google::Apis::AndroidenterpriseV1::NotificationSet command.query['requestMode'] = request_mode unless request_mode.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 - # Sends a test notification to validate the EMM integration with the Google - # Cloud Pub/Sub service for this enterprise. + # Sends a test notification to validate the EMM integration with + # the Google Cloud Pub/Sub service for this enterprise. # @param [String] enterprise_id # The ID of the enterprise. # @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. + # 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 # @@ -714,14 +681,13 @@ module Google # @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 send_enterprise_test_push_notification(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/sendTestPushNotification', options) + def send_enterprise_test_push_notification(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/sendTestPushNotification', options) command.response_representation = Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::SendTestPushNotificationResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -733,10 +699,8 @@ module Google # @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. + # 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 # @@ -749,8 +713,8 @@ module Google # @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 set_enterprise_account(enterprise_id, enterprise_account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/account', options) + def set_enterprise_account(enterprise_id, enterprise_account_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/account', options) command.request_representation = Google::Apis::AndroidenterpriseV1::EnterpriseAccount::Representation command.request_object = enterprise_account_object command.response_representation = Google::Apis::AndroidenterpriseV1::EnterpriseAccount::Representation @@ -758,27 +722,26 @@ module Google command.params['enterpriseId'] = enterprise_id unless enterprise_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 - # Sets the store layout for the enterprise. By default, storeLayoutType is set - # to "basic" and the basic store layout is enabled. The basic layout only - # contains apps approved by the admin, and that have been added to the available - # product set for a user (using the setAvailableProductSet call). Apps on the - # page are sorted in order of their product ID value. If you create a custom - # store layout (by setting storeLayoutType = "custom" and setting a homepage), - # the basic store layout is disabled. + # Sets the store layout for the enterprise. By default, storeLayoutType + # is set to "basic" and the basic store layout is enabled. The basic + # layout only contains apps approved by the admin, and that have + # been added to the available product set for a user (using the + # + # setAvailableProductSet call). Apps on the page are sorted in order of + # their product ID value. If you create a custom store layout (by setting + # storeLayoutType = "custom" and setting a homepage), the basic store + # layout is disabled. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::StoreLayout] store_layout_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. + # 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 # @@ -791,8 +754,8 @@ module Google # @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 set_enterprise_store_layout(enterprise_id, store_layout_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout', options) + def set_enterprise_store_layout(enterprise_id, store_layout_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation command.request_object = store_layout_object command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayout::Representation @@ -800,7 +763,6 @@ module Google command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -810,10 +772,8 @@ module Google # @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. + # 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 # @@ -826,12 +786,11 @@ module Google # @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 unenroll_enterprise(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/unenroll', options) + def unenroll_enterprise(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/unenroll', options) command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -845,10 +804,8 @@ module Google # @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. + # 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 # @@ -861,14 +818,13 @@ module Google # @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 delete_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) + def delete_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['entitlementId'] = entitlement_id unless entitlement_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 @@ -882,10 +838,8 @@ module Google # @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. + # 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 # @@ -898,8 +852,8 @@ module Google # @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_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) + def get_entitlement(enterprise_id, user_id, entitlement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Entitlement command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -907,7 +861,6 @@ module Google command.params['entitlementId'] = entitlement_id unless entitlement_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 @@ -919,10 +872,8 @@ module Google # @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. + # 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 # @@ -935,15 +886,14 @@ module Google # @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_entitlements(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/entitlements', options) + def list_entitlements(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListEntitlementsResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 @@ -957,16 +907,14 @@ module Google # @param [Google::Apis::AndroidenterpriseV1::Entitlement] entitlement_object # @param [Boolean] install # Set to true to also install the product on all the user's devices where - # possible. Failure to install on one or more devices will not prevent this - # operation from returning successfully, as long as the entitlement was - # successfully assigned to the user. + # possible. Failure to install on one or more devices will not prevent + # this operation from returning successfully, as long as the entitlement + # was successfully assigned to the user. # @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. + # 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 # @@ -979,8 +927,8 @@ module Google # @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_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) + def update_entitlement(enterprise_id, user_id, entitlement_id, entitlement_object = nil, install: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation command.request_object = entitlement_object command.response_representation = Google::Apis::AndroidenterpriseV1::Entitlement::Representation @@ -991,7 +939,6 @@ module Google command.query['install'] = install unless install.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 @@ -999,15 +946,13 @@ module Google # @param [String] enterprise_id # The ID of the enterprise. # @param [String] group_license_id - # The ID of the product the group license is for, e.g. "app:com.google.android. - # gm". + # The ID of the product the group license is for, e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1020,15 +965,14 @@ module Google # @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_group_license(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}', options) + def get_group_license(enterprise_id, group_license_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::GroupLicense::Representation command.response_class = Google::Apis::AndroidenterpriseV1::GroupLicense command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['groupLicenseId'] = group_license_id unless group_license_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 @@ -1038,10 +982,8 @@ module Google # @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. + # 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 # @@ -1054,31 +996,28 @@ module Google # @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_group_licenses(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses', options) + def list_group_licenses(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListGroupLicensesResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 IDs of the users who have been granted entitlements under the - # license. + # Retrieves the IDs of the users who have been granted entitlements + # under the license. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] group_license_id - # The ID of the product the group license is for, e.g. "app:com.google.android. - # gm". + # The ID of the product the group license is for, e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1091,20 +1030,20 @@ module Google # @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_group_license_users(enterprise_id, group_license_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users', options) + def list_group_license_users(enterprise_id, group_license_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/users', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListGroupLicenseUsersResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['groupLicenseId'] = group_license_id unless group_license_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 - # Requests to remove an app from a device. A call to get or list will still show - # the app as installed on the device until it is actually removed. + # Requests to remove an app from a device. A call to get or + # list will still show the app as installed on the device until + # it is actually removed. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1112,15 +1051,13 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] install_id - # The ID of the product represented by the install, e.g. "app:com.google.android. - # gm". + # The ID of the product represented by the install, e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1133,15 +1070,14 @@ module Google # @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 delete_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) + def delete_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['installId'] = install_id unless install_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 @@ -1153,15 +1089,13 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] install_id - # The ID of the product represented by the install, e.g. "app:com.google.android. - # gm". + # The ID of the product represented by the install, e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1174,8 +1108,8 @@ module Google # @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_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) + def get_install(enterprise_id, user_id, device_id, install_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Install command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1184,7 +1118,6 @@ module Google command.params['installId'] = install_id unless install_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 @@ -1198,10 +1131,8 @@ module Google # @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. + # 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 # @@ -1214,8 +1145,8 @@ module Google # @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_installs(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs', options) + def list_installs(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListInstallsResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListInstallsResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1223,12 +1154,12 @@ module Google command.params['deviceId'] = device_id unless device_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 - # Requests to install the latest version of an app to a device. If the app is - # already installed, then it is updated to the latest version if necessary. + # Requests to install the latest version of an app to a device. If the app + # is already installed, then it is updated to the latest version if + # necessary. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1236,16 +1167,14 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] install_id - # The ID of the product represented by the install, e.g. "app:com.google.android. - # gm". + # The ID of the product represented by the install, e.g. + # "app:com.google.android.gm". # @param [Google::Apis::AndroidenterpriseV1::Install] install_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. + # 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 # @@ -1258,8 +1187,8 @@ module Google # @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_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) + def update_install(enterprise_id, user_id, device_id, install_id, install_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::Install::Representation command.request_object = install_object command.response_representation = Google::Apis::AndroidenterpriseV1::Install::Representation @@ -1270,11 +1199,11 @@ module Google command.params['installId'] = install_id unless install_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 - # Removes a per-device managed configuration for an app for the specified device. + # Removes a per-device managed configuration for an app for the specified + # device. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1282,15 +1211,13 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id - # The ID of the managed configuration (a product ID), e.g. "app:com.google. - # android.gm". + # The ID of the managed configuration (a product ID), e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1303,15 +1230,14 @@ module Google # @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 delete_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) + def delete_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['deviceId'] = device_id unless device_id.nil? command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_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 @@ -1323,15 +1249,13 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id - # The ID of the managed configuration (a product ID), e.g. "app:com.google. - # android.gm". + # The ID of the managed configuration (a product ID), e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1344,8 +1268,8 @@ module Google # @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_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) + def get_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1354,12 +1278,11 @@ module Google command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_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 - # Lists all the per-device managed configurations for the specified device. Only - # the ID is set. + # Lists all the per-device managed configurations for the specified device. + # Only the ID is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1369,10 +1292,8 @@ module Google # @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. + # 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 # @@ -1385,8 +1306,8 @@ module Google # @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_managedconfigurationsfordevices(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice', options) + def list_managedconfigurationsfordevices(enterprise_id, user_id, device_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForDeviceListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1394,7 +1315,6 @@ module Google command.params['deviceId'] = device_id unless device_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 @@ -1407,16 +1327,14 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id - # The ID of the managed configuration (a product ID), e.g. "app:com.google. - # android.gm". + # The ID of the managed configuration (a product ID), e.g. + # "app:com.google.android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_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. + # 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 # @@ -1429,8 +1347,8 @@ module Google # @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_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) + def update_managedconfigurationsfordevice(enterprise_id, user_id, device_id, managed_configuration_for_device_id, managed_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.request_object = managed_configuration_object command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation @@ -1441,7 +1359,6 @@ module Google command.params['managedConfigurationForDeviceId'] = managed_configuration_for_device_id unless managed_configuration_for_device_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 @@ -1451,15 +1368,13 @@ module Google # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id - # The ID of the managed configuration (a product ID), e.g. "app:com.google. - # android.gm". + # The ID of the managed configuration (a product ID), e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1472,14 +1387,13 @@ module Google # @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 delete_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) + def delete_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_id.nil? command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_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 @@ -1490,15 +1404,13 @@ module Google # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id - # The ID of the managed configuration (a product ID), e.g. "app:com.google. - # android.gm". + # The ID of the managed configuration (a product ID), e.g. + # "app:com.google.android.gm". # @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. + # 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 # @@ -1511,8 +1423,8 @@ module Google # @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_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) + def get_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfiguration command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1520,12 +1432,11 @@ module Google command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_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 - # Lists all the per-user managed configurations for the specified user. Only the - # ID is set. + # Lists all the per-user managed configurations for the specified user. Only + # the ID is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1533,10 +1444,8 @@ module Google # @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. + # 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 # @@ -1549,38 +1458,42 @@ module Google # @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_managedconfigurationsforusers(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser', options) + def list_managedconfigurationsforusers(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsForUserListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Adds or updates the managed configuration settings for an app for the - # specified user. If you support the Managed configurations iframe, you can - # apply managed configurations to a user by specifying an mcmId and its - # associated configuration variables (if any) in the request. Alternatively, all - # EMMs can apply managed configurations by passing a list of managed properties. + # specified user. + # If you support the Managed + # configurations iframe, + # you can apply managed configurations to a user by specifying an + # mcmId + # and its associated configuration variables (if any) in the request. + # Alternatively, + # all EMMs can apply managed configurations by passing a list of managed + # properties. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id - # The ID of the managed configuration (a product ID), e.g. "app:com.google. - # android.gm". + # The ID of the managed configuration (a product ID), e.g. + # "app:com.google.android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_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. + # 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 # @@ -1593,8 +1506,8 @@ module Google # @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_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) + def update_managedconfigurationsforuser(enterprise_id, user_id, managed_configuration_for_user_id, managed_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation command.request_object = managed_configuration_object command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfiguration::Representation @@ -1604,7 +1517,6 @@ module Google command.params['managedConfigurationForUserId'] = managed_configuration_for_user_id unless managed_configuration_for_user_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 @@ -1612,14 +1524,13 @@ module Google # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id - # The ID of the product for which the managed configurations settings applies to. + # The ID of the product for which the managed configurations settings applies + # to. # @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. + # 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 # @@ -1632,15 +1543,14 @@ module Google # @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_managedconfigurationssettings(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings', options) + def list_managedconfigurationssettings(enterprise_id, product_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 @@ -1653,10 +1563,8 @@ module Google # @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. + # 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 # @@ -1669,23 +1577,24 @@ module Google # @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_permission(permission_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'permissions/{permissionId}', options) + def get_permission(permission_id, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/permissions/{permissionId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Permission::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Permission command.params['permissionId'] = permission_id unless permission_id.nil? command.query['language'] = language unless language.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 - # Approves the specified product and the relevant app permissions, if any. The - # maximum number of products that you can approve per enterprise customer is 1, - # 000. - # To learn how to use managed Google Play to design and create a store layout to - # display approved products to your users, see Store Layout Design. + #

Approves the specified product and the relevant app permissions, if any. + # The maximum number of products that you can approve per enterprise customer + # is 1,000.

+ #

To learn how to use managed Google Play to design and create a store + # layout to display approved products to your users, + # see Store Layout + # Design.

# @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id @@ -1694,10 +1603,8 @@ module Google # @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. + # 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 # @@ -1710,40 +1617,39 @@ module Google # @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 approve_product(enterprise_id, product_id, approve_product_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/approve', options) + def approve_product(enterprise_id, product_id, approve_product_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/approve', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ApproveProductRequest::Representation command.request_object = approve_product_request_object command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 - # Generates a URL that can be rendered in an iframe to display the permissions ( - # if any) of a product. An enterprise admin must view these permissions and - # accept them on behalf of their organization in order to approve that product. - # Admins should accept the displayed permissions by interacting with a separate - # UI element in the EMM console, which in turn should trigger the use of this - # URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to - # approve the product. This URL can only be used to display permissions for up - # to 1 day. + # Generates a URL that can be rendered in an iframe to display the + # permissions (if any) of a product. An enterprise admin must view these + # permissions and accept them on behalf of their organization in order to + # approve that product.

+ # Admins should accept the displayed permissions by + # interacting with a separate UI element in the EMM console, which in turn + # should trigger the use of this URL as the + # approvalUrlInfo.approvalUrl property in a + # Products.approve call to approve the product. + # This URL can only be used to display permissions for up to 1 day. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product. # @param [String] language_code - # The BCP 47 language code used for permission names and descriptions in the - # returned iframe, for instance "en-US". + # The BCP 47 language code used for permission names and descriptions in + # the returned iframe, for instance "en-US". # @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. + # 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 # @@ -1756,8 +1662,8 @@ module Google # @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_product_approval_url(enterprise_id, product_id, language_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl', options) + def generate_product_approval_url(enterprise_id, product_id, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/generateApprovalUrl', options) command.response_representation = Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::GenerateProductApprovalUrlResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1765,7 +1671,6 @@ module Google command.query['languageCode'] = language_code unless language_code.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 @@ -1779,10 +1684,8 @@ module Google # @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. + # 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 # @@ -1795,8 +1698,8 @@ module Google # @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_product(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}', options) + def get_product(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::Product::Representation command.response_class = Google::Apis::AndroidenterpriseV1::Product command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1804,16 +1707,17 @@ module Google command.query['language'] = language unless language.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 schema that defines the configurable properties for this product. - # All products have a schema, but this schema may be empty if no managed - # configurations have been defined. This schema can be used to populate a UI - # that allows an admin to configure the product. To apply a managed - # configuration based on the schema obtained using this API, see Managed - # Configurations through Play. + # Retrieves the schema that defines the configurable properties for this + # product. All products have a schema, but this schema may be empty if no + # managed configurations have been defined. This schema can be used to + # populate a UI that allows an admin to configure the product. + # To apply a managed configuration based on the schema obtained using this + # API, see + # Managed + # Configurations through Play. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id @@ -1823,10 +1727,8 @@ module Google # @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. + # 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 # @@ -1839,8 +1741,8 @@ module Google # @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_product_app_restrictions_schema(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema', options) + def get_product_app_restrictions_schema(enterprise_id, product_id, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchema', options) command.response_representation = Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema::Representation command.response_class = Google::Apis::AndroidenterpriseV1::AppRestrictionsSchema command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1848,7 +1750,6 @@ module Google command.query['language'] = language unless language.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 @@ -1860,10 +1761,8 @@ module Google # @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. + # 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 # @@ -1876,48 +1775,46 @@ module Google # @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_product_permissions(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/permissions', options) + def get_product_permissions(enterprise_id, product_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/permissions', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ProductPermissions::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ProductPermissions command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 - # Finds approved products that match a query, or all approved products if there - # is no query. + # Finds approved products that match a query, or all approved products + # if there is no query. # @param [String] enterprise_id # The ID of the enterprise. # @param [Boolean] approved - # Specifies whether to search among all products (false) or among only products - # that have been approved (true). Only "true" is supported, and should be - # specified. + # Specifies whether to search among all products (false) or among + # only products that have been approved (true). Only "true" is + # supported, and should be specified. # @param [String] language - # The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results - # are returned in the language best matching the preferred language. + # The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). + # Results are returned in the language best matching the preferred + # language. # @param [Fixnum] max_results - # Specifies the maximum number of products that can be returned per request. If - # not specified, uses a default value of 100, which is also the maximum - # retrievable within a single response. + # Defines how many results the list operation should return. + # The default number depends on the resource collection. # @param [String] query - # The search query as typed in the Google Play store search box. If omitted, all - # approved apps will be returned (using the pagination parameters), including - # apps that are not available in the store (e.g. unpublished apps). + # The search query as typed in the Google Play store search box. + # If omitted, all approved apps will be returned (using the pagination + # parameters), including apps that are not available in the store + # (e.g. unpublished apps). # @param [String] token - # A pagination token is contained in a request's response when there are more - # products. The token can be used in a subsequent request to obtain more - # products, and so forth. This parameter cannot be used in the initial request. + # Defines the token of the page to return, usually taken from + # TokenPagination. + # This can only be used if token paging is enabled. # @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. + # 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 # @@ -1930,8 +1827,8 @@ module Google # @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_products(enterprise_id, approved: nil, language: nil, max_results: nil, query: nil, token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/products', options) + def list_products(enterprise_id, approved: nil, language: nil, max_results: nil, query: nil, token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/products', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ProductsListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ProductsListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -1942,7 +1839,6 @@ module Google command.query['token'] = token unless token.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 @@ -1954,10 +1850,8 @@ module Google # @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. + # 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 # @@ -1970,20 +1864,19 @@ module Google # @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 unapprove_product(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/products/{productId}/unapprove', options) + def unapprove_product(enterprise_id, product_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/unapprove', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['productId'] = product_id unless product_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 # Removes and invalidates the specified credentials for the service account # associated with this enterprise. The calling service account must have been - # retrieved by calling Enterprises.GetServiceAccount and must have been set as - # the enterprise service account by calling Enterprises.SetAccount. + # retrieved by calling Enterprises.GetServiceAccount and must have been set + # as the enterprise service account by calling Enterprises.SetAccount. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] key_id @@ -1991,10 +1884,8 @@ module Google # @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. + # 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 # @@ -2007,31 +1898,29 @@ module Google # @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 delete_serviceaccountkey(enterprise_id, key_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/serviceAccountKeys/{keyId}', options) + def delete_serviceaccountkey(enterprise_id, key_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys/{keyId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['keyId'] = key_id unless key_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 # Generates new credentials for the service account associated with this # enterprise. The calling service account must have been retrieved by calling - # Enterprises.GetServiceAccount and must have been set as the enterprise service - # account by calling Enterprises.SetAccount. - # Only the type of the key should be populated in the resource to be inserted. + # Enterprises.GetServiceAccount and must have been set as the enterprise + # service account by calling Enterprises.SetAccount.

+ # Only the type of the key should be populated in the resource to be + # inserted. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::ServiceAccountKey] service_account_key_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. + # 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 # @@ -2044,8 +1933,8 @@ module Google # @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_serviceaccountkey(enterprise_id, service_account_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/serviceAccountKeys', options) + def insert_serviceaccountkey(enterprise_id, service_account_key_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation command.request_object = service_account_key_object command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKey::Representation @@ -2053,24 +1942,21 @@ module Google command.params['enterpriseId'] = enterprise_id unless enterprise_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 # Lists all active credentials for the service account associated with this - # enterprise. Only the ID and key type are returned. The calling service account - # must have been retrieved by calling Enterprises.GetServiceAccount and must - # have been set as the enterprise service account by calling Enterprises. - # SetAccount. + # enterprise. Only the ID and key type are returned. The calling service + # account must have been retrieved by calling Enterprises.GetServiceAccount + # and must have been set as the enterprise service account by calling + # Enterprises.SetAccount. # @param [String] enterprise_id # The ID of the enterprise. # @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. + # 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 # @@ -2083,14 +1969,13 @@ module Google # @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_serviceaccountkeys(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/serviceAccountKeys', options) + def list_serviceaccountkeys(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ServiceAccountKeysListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -2104,10 +1989,8 @@ module Google # @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. + # 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 # @@ -2120,14 +2003,13 @@ module Google # @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 delete_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) + def delete_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_id.nil? command.params['clusterId'] = cluster_id unless cluster_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 @@ -2141,10 +2023,8 @@ module Google # @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. + # 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 # @@ -2157,8 +2037,8 @@ module Google # @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_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) + def get_storelayoutcluster(enterprise_id, page_id, cluster_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreCluster command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? @@ -2166,7 +2046,6 @@ module Google command.params['clusterId'] = cluster_id unless cluster_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 @@ -2179,10 +2058,8 @@ module Google # @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. + # 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 # @@ -2195,8 +2072,8 @@ module Google # @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_storelayoutcluster(enterprise_id, page_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options) + def insert_storelayoutcluster(enterprise_id, page_id, store_cluster_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.request_object = store_cluster_object command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation @@ -2205,7 +2082,6 @@ module Google command.params['pageId'] = page_id unless page_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 @@ -2217,10 +2093,8 @@ module Google # @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. + # 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 # @@ -2233,15 +2107,14 @@ module Google # @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_storelayoutclusters(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options) + def list_storelayoutclusters(enterprise_id, page_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayoutClustersListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 @@ -2256,10 +2129,8 @@ module Google # @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. + # 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 # @@ -2272,8 +2143,8 @@ module Google # @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_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) + def update_storelayoutcluster(enterprise_id, page_id, cluster_id, store_cluster_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation command.request_object = store_cluster_object command.response_representation = Google::Apis::AndroidenterpriseV1::StoreCluster::Representation @@ -2283,7 +2154,6 @@ module Google command.params['clusterId'] = cluster_id unless cluster_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 @@ -2295,10 +2165,8 @@ module Google # @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. + # 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 # @@ -2311,13 +2179,12 @@ module Google # @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 delete_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) + def delete_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 @@ -2329,10 +2196,8 @@ module Google # @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. + # 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 # @@ -2345,15 +2210,14 @@ module Google # @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_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) + def get_storelayoutpage(enterprise_id, page_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StorePage command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['pageId'] = page_id unless page_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 @@ -2364,10 +2228,8 @@ module Google # @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. + # 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 # @@ -2380,8 +2242,8 @@ module Google # @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_storelayoutpage(enterprise_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/storeLayout/pages', options) + def insert_storelayoutpage(enterprise_id, store_page_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.request_object = store_page_object command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation @@ -2389,7 +2251,6 @@ module Google command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -2399,10 +2260,8 @@ module Google # @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. + # 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 # @@ -2415,14 +2274,13 @@ module Google # @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_storelayoutpages(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/storeLayout/pages', options) + def list_storelayoutpages(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages', options) command.response_representation = Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::StoreLayoutPagesListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -2435,10 +2293,8 @@ module Google # @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. + # 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 # @@ -2451,8 +2307,8 @@ module Google # @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_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) + def update_storelayoutpage(enterprise_id, page_id, store_page_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation command.request_object = store_page_object command.response_representation = Google::Apis::AndroidenterpriseV1::StorePage::Representation @@ -2461,7 +2317,6 @@ module Google command.params['pageId'] = page_id unless page_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 @@ -2473,10 +2328,8 @@ module Google # @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. + # 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 # @@ -2489,19 +2342,18 @@ module Google # @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 delete_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}', options) + def delete_user(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Generates an authentication token which the device policy client can use to - # provision the given EMM-managed user account on a device. The generated token - # is single-use and expires after a few minutes. + # provision the given EMM-managed user account on a device. + # The generated token is single-use and expires after a few minutes. # You can provision a maximum of 10 devices per user. # This call only works with EMM-managed accounts. # @param [String] enterprise_id @@ -2511,10 +2363,8 @@ module Google # @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. + # 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 # @@ -2527,54 +2377,14 @@ module Google # @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_user_authentication_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/authenticationToken', options) + def generate_user_authentication_token(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/authenticationToken', options) command.response_representation = Google::Apis::AndroidenterpriseV1::AuthenticationToken::Representation command.response_class = Google::Apis::AndroidenterpriseV1::AuthenticationToken command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 - - # Generates a token (activation code) to allow this user to configure their - # managed account in the Android Setup Wizard. Revokes any previously generated - # token. - # This call only works with Google managed accounts. - # @param [String] enterprise_id - # The ID of the enterprise. - # @param [String] user_id - # The ID of the user. - # @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::AndroidenterpriseV1::UserToken] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidenterpriseV1::UserToken] - # - # @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_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/users/{userId}/token', options) - command.response_representation = Google::Apis::AndroidenterpriseV1::UserToken::Representation - command.response_class = Google::Apis::AndroidenterpriseV1::UserToken - command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? - command.params['userId'] = user_id unless user_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 @@ -2586,10 +2396,8 @@ module Google # @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. + # 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 # @@ -2602,15 +2410,14 @@ module Google # @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_user(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}', options) + def get_user(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.response_class = Google::Apis::AndroidenterpriseV1::User command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 @@ -2622,10 +2429,8 @@ module Google # @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. + # 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 # @@ -2638,34 +2443,32 @@ module Google # @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_user_available_product_set(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users/{userId}/availableProductSet', options) + def get_user_available_product_set(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ProductSet command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 # Creates a new EMM-managed user. - # The Users resource passed in the body of the request should include an - # accountIdentifier and an accountType. - # If a corresponding user already exists with the same account identifier, the - # user will be updated with the resource. In this case only the displayName - # field can be changed. + # The Users resource + # passed in the body of the request should include an + # accountIdentifier and an accountType. + #

If a corresponding user already exists with the same account identifier, + # the user will be updated with the resource. In this case only the + # displayName field can be changed. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::User] user_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. + # 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 # @@ -2678,8 +2481,8 @@ module Google # @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_user(enterprise_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/users', options) + def insert_user(enterprise_id, user_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/users', options) command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation @@ -2687,24 +2490,22 @@ module Google command.params['enterpriseId'] = enterprise_id unless enterprise_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 - # Looks up a user by primary email address. This is only supported for Google- - # managed users. Lookup of the id is not needed for EMM-managed users because - # the id is already returned in the result of the Users.insert call. + # Looks up a user by primary email address. + # This is only supported for Google-managed users. Lookup of the id is not + # needed for EMM-managed users because the id is already returned in the + # result of the Users.insert call. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] email - # The exact primary email address of the user to look up. + # Required. The exact primary email address of the user to look up. # @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. + # 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 # @@ -2717,21 +2518,20 @@ module Google # @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_users(enterprise_id, email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/users', options) + def list_users(enterprise_id, email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/users', options) command.response_representation = Google::Apis::AndroidenterpriseV1::ListUsersResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::ListUsersResponse command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.query['email'] = email unless email.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 - # Revokes access to all devices currently provisioned to the user. The user will - # no longer be able to use the managed Play store on any of their managed - # devices. + # Revokes access to all devices currently provisioned to the user. The user + # will no longer be able to use the managed Play store on any of their + # managed devices. # This call only works with EMM-managed accounts. # @param [String] enterprise_id # The ID of the enterprise. @@ -2740,10 +2540,8 @@ module Google # @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. + # 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 # @@ -2756,53 +2554,20 @@ module Google # @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 revoke_user_device_access(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/deviceAccess', options) + def revoke_user_device_access(enterprise_id, user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/deviceAccess', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['userId'] = user_id unless user_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 - # Revokes a previously generated token (activation code) for the user. - # @param [String] enterprise_id - # The ID of the enterprise. - # @param [String] user_id - # The ID of the user. - # @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 [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @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 revoke_user_token(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/token', options) - command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? - command.params['userId'] = user_id unless user_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 - - # Modifies the set of products that a user is entitled to access (referred to as - # whitelisted products). Only products that are approved or products that were - # previously approved (products with revoked approval) can be whitelisted. + # Modifies the set of products that a user is entitled to access (referred to + # as whitelisted products). Only products that are + # approved + # or products that were previously approved (products with revoked approval) + # can be whitelisted. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -2811,10 +2576,8 @@ module Google # @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. + # 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 # @@ -2827,8 +2590,8 @@ module Google # @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 set_user_available_product_set(enterprise_id, user_id, product_set_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}/availableProductSet', options) + def set_user_available_product_set(enterprise_id, user_id, product_set_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSet', options) command.request_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation command.request_object = product_set_object command.response_representation = Google::Apis::AndroidenterpriseV1::ProductSet::Representation @@ -2837,15 +2600,16 @@ module Google command.params['userId'] = user_id unless user_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 the details of an EMM-managed user. - # Can be used with EMM-managed users only (not Google managed users). Pass the - # new details in the Users resource in the request body. Only the displayName - # field can be changed. Other fields must either be unset or have the currently - # active value. + # Can be used with EMM-managed users only (not Google managed users). + # Pass the new details in the + # Users + # resource in the request body. Only the displayName field + # can be changed. Other fields must either be unset or have the + # currently active value. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -2854,10 +2618,8 @@ module Google # @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. + # 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 # @@ -2870,8 +2632,8 @@ module Google # @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_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/users/{userId}', options) + def update_user(enterprise_id, user_id, user_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::User::Representation command.request_object = user_object command.response_representation = Google::Apis::AndroidenterpriseV1::User::Representation @@ -2880,7 +2642,6 @@ module Google command.params['userId'] = user_id unless user_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 @@ -2892,10 +2653,8 @@ module Google # @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. + # 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 # @@ -2908,13 +2667,12 @@ module Google # @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 delete_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'enterprises/{enterpriseId}/webApps/{webAppId}', options) + def delete_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}', options) command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['webAppId'] = web_app_id unless web_app_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 @@ -2926,10 +2684,8 @@ module Google # @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. + # 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 # @@ -2942,15 +2698,14 @@ module Google # @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_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/webApps/{webAppId}', options) + def get_webapp(enterprise_id, web_app_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}', options) command.response_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation command.response_class = Google::Apis::AndroidenterpriseV1::WebApp command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? command.params['webAppId'] = web_app_id unless web_app_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 @@ -2961,10 +2716,8 @@ module Google # @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. + # 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 # @@ -2977,8 +2730,8 @@ module Google # @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_webapp(enterprise_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'enterprises/{enterpriseId}/webApps', options) + def insert_webapp(enterprise_id, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'androidenterprise/v1/enterprises/{enterpriseId}/webApps', options) command.request_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation command.request_object = web_app_object command.response_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation @@ -2986,7 +2739,6 @@ module Google command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -2996,10 +2748,8 @@ module Google # @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. + # 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 # @@ -3012,14 +2762,13 @@ module Google # @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_webapps(enterprise_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'enterprises/{enterpriseId}/webApps', options) + def list_webapps(enterprise_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'androidenterprise/v1/enterprises/{enterpriseId}/webApps', options) command.response_representation = Google::Apis::AndroidenterpriseV1::WebAppsListResponse::Representation command.response_class = Google::Apis::AndroidenterpriseV1::WebAppsListResponse command.params['enterpriseId'] = enterprise_id unless enterprise_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 @@ -3032,10 +2781,8 @@ module Google # @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. + # 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 # @@ -3048,8 +2795,8 @@ module Google # @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_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'enterprises/{enterpriseId}/webApps/{webAppId}', options) + def update_webapp(enterprise_id, web_app_id, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}', options) command.request_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation command.request_object = web_app_object command.response_representation = Google::Apis::AndroidenterpriseV1::WebApp::Representation @@ -3058,7 +2805,6 @@ module Google command.params['webAppId'] = web_app_id unless web_app_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 @@ -3067,7 +2813,6 @@ module Google 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 diff --git a/generated/google/apis/cloudsearch_v1.rb b/generated/google/apis/cloudsearch_v1.rb index 726b4af5e..c18bec832 100644 --- a/generated/google/apis/cloudsearch_v1.rb +++ b/generated/google/apis/cloudsearch_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-search/docs/guides/ module CloudsearchV1 VERSION = 'V1' - REVISION = '20200505' + REVISION = '20200519' # Index and serve your organization's data with Cloud Search AUTH_CLOUD_SEARCH = 'https://www.googleapis.com/auth/cloud_search' diff --git a/generated/google/apis/cloudsearch_v1/service.rb b/generated/google/apis/cloudsearch_v1/service.rb index 6ff278165..0304ac3be 100644 --- a/generated/google/apis/cloudsearch_v1/service.rb +++ b/generated/google/apis/cloudsearch_v1/service.rb @@ -1274,7 +1274,7 @@ module Google # **Note:** This API requires an admin account to execute. # @param [String] name # Name of the search application. - #
Format: applications/`application_id`. + #
Format: searchapplications/`application_id`. # @param [Boolean] debug_options_enable_debugging # If you are asked by Google to help with debugging, set this field. # Otherwise, ignore this field. diff --git a/generated/google/apis/displayvideo_v1/classes.rb b/generated/google/apis/displayvideo_v1/classes.rb index 2f69365e3..2df6ec84d 100644 --- a/generated/google/apis/displayvideo_v1/classes.rb +++ b/generated/google/apis/displayvideo_v1/classes.rb @@ -632,6 +632,77 @@ module Google end end + # An assignment between a targetable inventory source and an inventory source + # group. + class AssignedInventorySource + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the assigned inventory source. The ID is only + # unique within a given inventory source group. It may be reused in other + # contexts. + # Corresponds to the JSON property `assignedInventorySourceId` + # @return [Fixnum] + attr_accessor :assigned_inventory_source_id + + # Required. The ID of the inventory source entity being targeted. + # Corresponds to the JSON property `inventorySourceId` + # @return [String] + attr_accessor :inventory_source_id + + # Output only. The resource name of the assigned inventory source. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_inventory_source_id = args[:assigned_inventory_source_id] if args.key?(:assigned_inventory_source_id) + @inventory_source_id = args[:inventory_source_id] if args.key?(:inventory_source_id) + @name = args[:name] if args.key?(:name) + end + end + + # An assignment between a location list and a relevant targeting option. + # Currently, geo region targeting options are the only supported option for + # assignment. + class AssignedLocation + include Google::Apis::Core::Hashable + + # Output only. The unique ID of the assigned location. The ID is only unique + # within a + # location list. It may be reused in other contexts. + # Corresponds to the JSON property `assignedLocationId` + # @return [Fixnum] + attr_accessor :assigned_location_id + + # Output only. The resource name of the assigned location. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The ID of the targeting option assigned to the location list. Must + # be of + # type TARGETING_TYPE_GEO_REGION. + # Corresponds to the JSON property `targetingOptionId` + # @return [String] + attr_accessor :targeting_option_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_location_id = args[:assigned_location_id] if args.key?(:assigned_location_id) + @name = args[:name] if args.key?(:name) + @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id) + end + end + # A single assigned targeting option, which defines the state of a targeting # option for an entity with targeting settings, such as a Line Item or # Insertion Order. @@ -1314,6 +1385,116 @@ module Google end end + # Request message for AssignedInventorySourceService.BulkEdit. + class BulkEditAssignedInventorySourcesRequest + include Google::Apis::Core::Hashable + + # The ID of the advertiser that owns the parent inventory source group. + # The parent partner does not have access to these assigned inventory + # sources. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # The assigned inventory sources to create in bulk, specified as a list of + # AssignedInventorySources. + # Corresponds to the JSON property `createdAssignedInventorySources` + # @return [Array] + attr_accessor :created_assigned_inventory_sources + + # The IDs of the assigned inventory sources to delete in bulk, specified as a + # list of + # assigned_inventory_source_ids. + # Corresponds to the JSON property `deletedAssignedInventorySources` + # @return [Array] + attr_accessor :deleted_assigned_inventory_sources + + # The ID of the partner that owns the inventory source group. + # Only this partner has write access to these assigned inventory sources. + # Corresponds to the JSON property `partnerId` + # @return [Fixnum] + attr_accessor :partner_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @created_assigned_inventory_sources = args[:created_assigned_inventory_sources] if args.key?(:created_assigned_inventory_sources) + @deleted_assigned_inventory_sources = args[:deleted_assigned_inventory_sources] if args.key?(:deleted_assigned_inventory_sources) + @partner_id = args[:partner_id] if args.key?(:partner_id) + end + end + + # Response message for AssignedInventorySourceService.BulkEdit. + class BulkEditAssignedInventorySourcesResponse + include Google::Apis::Core::Hashable + + # The list of assigned inventory sources that have been successfully created. + # This list will be absent if empty. + # Corresponds to the JSON property `assignedInventorySources` + # @return [Array] + attr_accessor :assigned_inventory_sources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_inventory_sources = args[:assigned_inventory_sources] if args.key?(:assigned_inventory_sources) + end + end + + # Request message for AssignedLocationService.BulkEditAssignedLocations. + class BulkEditAssignedLocationsRequest + include Google::Apis::Core::Hashable + + # The assigned locations to create in bulk, specified as a list of + # AssignedLocations. + # Corresponds to the JSON property `createdAssignedLocations` + # @return [Array] + attr_accessor :created_assigned_locations + + # The IDs of the assigned locations to delete in bulk, specified as a list of + # assigned_location_ids. + # Corresponds to the JSON property `deletedAssignedLocations` + # @return [Array] + attr_accessor :deleted_assigned_locations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @created_assigned_locations = args[:created_assigned_locations] if args.key?(:created_assigned_locations) + @deleted_assigned_locations = args[:deleted_assigned_locations] if args.key?(:deleted_assigned_locations) + end + end + + # Response message for AssignedLocationService.BulkEditAssignedLocations. + class BulkEditAssignedLocationsResponse + include Google::Apis::Core::Hashable + + # The list of assigned locations that have been successfully created. + # This list will be absent if empty. + # Corresponds to the JSON property `assignedLocations` + # @return [Array] + attr_accessor :assigned_locations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_locations = args[:assigned_locations] if args.key?(:assigned_locations) + end + end + # Request message for # BulkEditLineItemAssignedTargetingOptions. class BulkEditLineItemAssignedTargetingOptionsRequest @@ -1362,6 +1543,111 @@ module Google end end + # Request message for NegativeKeywordService.BulkEditNegativeKeywords. + class BulkEditNegativeKeywordsRequest + include Google::Apis::Core::Hashable + + # The negative keywords to create in batch, specified as a list of + # NegativeKeywords. + # Corresponds to the JSON property `createdNegativeKeywords` + # @return [Array] + attr_accessor :created_negative_keywords + + # The negative keywords to delete in batch, specified as a list of + # keyword_values. + # Corresponds to the JSON property `deletedNegativeKeywords` + # @return [Array] + attr_accessor :deleted_negative_keywords + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @created_negative_keywords = args[:created_negative_keywords] if args.key?(:created_negative_keywords) + @deleted_negative_keywords = args[:deleted_negative_keywords] if args.key?(:deleted_negative_keywords) + end + end + + # Response message for NegativeKeywordService.BulkEditNegativeKeywords. + class BulkEditNegativeKeywordsResponse + include Google::Apis::Core::Hashable + + # The list of negative keywords that have been successfully created. + # This list will be absent if empty. + # Corresponds to the JSON property `negativeKeywords` + # @return [Array] + attr_accessor :negative_keywords + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @negative_keywords = args[:negative_keywords] if args.key?(:negative_keywords) + end + end + + # Request message for SiteService.BulkEditSites. + class BulkEditSitesRequest + include Google::Apis::Core::Hashable + + # The ID of the advertiser that owns the parent channel. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # The sites to create in batch, specified as a list of Sites. + # Corresponds to the JSON property `createdSites` + # @return [Array] + attr_accessor :created_sites + + # The sites to delete in batch, specified as a list of site + # url_or_app_ids. + # Corresponds to the JSON property `deletedSites` + # @return [Array] + attr_accessor :deleted_sites + + # The ID of the partner that owns the parent channel. + # Corresponds to the JSON property `partnerId` + # @return [Fixnum] + attr_accessor :partner_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @created_sites = args[:created_sites] if args.key?(:created_sites) + @deleted_sites = args[:deleted_sites] if args.key?(:deleted_sites) + @partner_id = args[:partner_id] if args.key?(:partner_id) + end + end + + # Response message for SiteService.BulkEditSites. + class BulkEditSitesResponse + include Google::Apis::Core::Hashable + + # The list of sites that have been successfully created. + # This list will be absent if empty. + # Corresponds to the JSON property `sites` + # @return [Array] + attr_accessor :sites + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sites = args[:sites] if args.key?(:sites) + end + end + # class BulkListAdvertiserAssignedTargetingOptionsResponse include Google::Apis::Core::Hashable @@ -5120,6 +5406,68 @@ module Google end end + # Response message for + # AssignedInventorySourceService.ListAssignedInventorySources. + class ListAssignedInventorySourcesResponse + include Google::Apis::Core::Hashable + + # The list of assigned inventory sources. + # This list will be absent if empty. + # Corresponds to the JSON property `assignedInventorySources` + # @return [Array] + attr_accessor :assigned_inventory_sources + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token field + # in the subsequent call to `ListAssignedInventorySources` method to + # retrieve the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_inventory_sources = args[:assigned_inventory_sources] if args.key?(:assigned_inventory_sources) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for + # AssignedLocationService.ListAssignedLocations. + class ListAssignedLocationsResponse + include Google::Apis::Core::Hashable + + # The list of assigned locations. + # This list will be absent if empty. + # Corresponds to the JSON property `assignedLocations` + # @return [Array] + attr_accessor :assigned_locations + + # A token to retrieve the next page of results. + # Pass this value in the + # page_token field + # in the subsequent call to `ListAssignedLocations` method to + # retrieve the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assigned_locations = args[:assigned_locations] if args.key?(:assigned_locations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # class ListCampaignsResponse include Google::Apis::Core::Hashable @@ -5541,6 +5889,64 @@ module Google end end + # Response message for NegativeKeywordService.ListNegativeKeywords. + class ListNegativeKeywordsResponse + include Google::Apis::Core::Hashable + + # The list of negative keywords. + # This list will be absent if empty. + # Corresponds to the JSON property `negativeKeywords` + # @return [Array] + attr_accessor :negative_keywords + + # A token to retrieve the next page of results. + # Pass this value in the page_token + # field in the subsequent call to `ListNegativeKeywords` method to retrieve + # the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @negative_keywords = args[:negative_keywords] if args.key?(:negative_keywords) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for SiteService.ListSites. + class ListSitesResponse + include Google::Apis::Core::Hashable + + # A token to retrieve the next page of results. + # Pass this value in the page_token field + # in the subsequent call to `ListSites` method to retrieve the next page + # of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of sites. + # This list will be absent if empty. + # Corresponds to the JSON property `sites` + # @return [Array] + attr_accessor :sites + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @sites = args[:sites] if args.key?(:sites) + end + end + # Response message for # ListTargetingOptions. class ListTargetingOptionsResponse @@ -5715,6 +6121,37 @@ module Google end end + # A negatively targeted keyword that belongs to a negative keyword list. + class NegativeKeyword + include Google::Apis::Core::Hashable + + # Required. Immutable. The negatively targeted keyword, for example `car + # insurance`. + # Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number + # of characters is 80. Maximum number of words is 10. + # Valid characters are restricted to ASCII characters only. The only + # URL-escaping permitted is for representing whitespace between words. + # Leading or trailing whitespace is ignored. + # Corresponds to the JSON property `keywordValue` + # @return [String] + attr_accessor :keyword_value + + # Output only. The resource name of the negative keyword. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @keyword_value = args[:keyword_value] if args.key?(:keyword_value) + @name = args[:name] if args.key?(:name) + end + end + # A list of negative keywords used for targeting. class NegativeKeywordList include Google::Apis::Core::Hashable @@ -6703,6 +7140,32 @@ module Google end end + # A single site. Sites are apps or websites belonging to a channel. + class Site + include Google::Apis::Core::Hashable + + # Output only. The resource name of the site. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The URL or app ID of the site. + # Must be UTF-8 encoded with a maximum length of 240 bytes. + # Corresponds to the JSON property `urlOrAppId` + # @return [String] + attr_accessor :url_or_app_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @url_or_app_id = args[:url_or_app_id] if args.key?(:url_or_app_id) + end + end + # 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). Each `Status` message contains diff --git a/generated/google/apis/displayvideo_v1/representations.rb b/generated/google/apis/displayvideo_v1/representations.rb index e303da9e6..2151017d2 100644 --- a/generated/google/apis/displayvideo_v1/representations.rb +++ b/generated/google/apis/displayvideo_v1/representations.rb @@ -118,6 +118,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AssignedInventorySource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AssignedLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AssignedTargetingOption class Representation < Google::Apis::Core::JsonRepresentation; end @@ -178,6 +190,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BulkEditAssignedInventorySourcesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditAssignedInventorySourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditAssignedLocationsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditAssignedLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BulkEditLineItemAssignedTargetingOptionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -190,6 +226,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BulkEditNegativeKeywordsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditNegativeKeywordsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditSitesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BulkEditSitesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BulkListAdvertiserAssignedTargetingOptionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -748,6 +808,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListAssignedInventorySourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListAssignedLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListCampaignsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -832,6 +904,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListNegativeKeywordsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListSitesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListTargetingOptionsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -862,6 +946,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NegativeKeyword + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class NegativeKeywordList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1018,6 +1108,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Site + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Status class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1284,6 +1380,24 @@ module Google end end + class AssignedInventorySource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :assigned_inventory_source_id, :numeric_string => true, as: 'assignedInventorySourceId' + property :inventory_source_id, as: 'inventorySourceId' + property :name, as: 'name' + end + end + + class AssignedLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :assigned_location_id, :numeric_string => true, as: 'assignedLocationId' + property :name, as: 'name' + property :targeting_option_id, as: 'targetingOptionId' + end + end + class AssignedTargetingOption # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1455,6 +1569,42 @@ module Google end end + class BulkEditAssignedInventorySourcesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + collection :created_assigned_inventory_sources, as: 'createdAssignedInventorySources', class: Google::Apis::DisplayvideoV1::AssignedInventorySource, decorator: Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation + + collection :deleted_assigned_inventory_sources, as: 'deletedAssignedInventorySources' + property :partner_id, :numeric_string => true, as: 'partnerId' + end + end + + class BulkEditAssignedInventorySourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_inventory_sources, as: 'assignedInventorySources', class: Google::Apis::DisplayvideoV1::AssignedInventorySource, decorator: Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation + + end + end + + class BulkEditAssignedLocationsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :created_assigned_locations, as: 'createdAssignedLocations', class: Google::Apis::DisplayvideoV1::AssignedLocation, decorator: Google::Apis::DisplayvideoV1::AssignedLocation::Representation + + collection :deleted_assigned_locations, as: 'deletedAssignedLocations' + end + end + + class BulkEditAssignedLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_locations, as: 'assignedLocations', class: Google::Apis::DisplayvideoV1::AssignedLocation, decorator: Google::Apis::DisplayvideoV1::AssignedLocation::Representation + + end + end + class BulkEditLineItemAssignedTargetingOptionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1473,6 +1623,42 @@ module Google end end + class BulkEditNegativeKeywordsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :created_negative_keywords, as: 'createdNegativeKeywords', class: Google::Apis::DisplayvideoV1::NegativeKeyword, decorator: Google::Apis::DisplayvideoV1::NegativeKeyword::Representation + + collection :deleted_negative_keywords, as: 'deletedNegativeKeywords' + end + end + + class BulkEditNegativeKeywordsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :negative_keywords, as: 'negativeKeywords', class: Google::Apis::DisplayvideoV1::NegativeKeyword, decorator: Google::Apis::DisplayvideoV1::NegativeKeyword::Representation + + end + end + + class BulkEditSitesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + collection :created_sites, as: 'createdSites', class: Google::Apis::DisplayvideoV1::Site, decorator: Google::Apis::DisplayvideoV1::Site::Representation + + collection :deleted_sites, as: 'deletedSites' + property :partner_id, :numeric_string => true, as: 'partnerId' + end + end + + class BulkEditSitesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :sites, as: 'sites', class: Google::Apis::DisplayvideoV1::Site, decorator: Google::Apis::DisplayvideoV1::Site::Representation + + end + end + class BulkListAdvertiserAssignedTargetingOptionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2413,6 +2599,24 @@ module Google end end + class ListAssignedInventorySourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_inventory_sources, as: 'assignedInventorySources', class: Google::Apis::DisplayvideoV1::AssignedInventorySource, decorator: Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListAssignedLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assigned_locations, as: 'assignedLocations', class: Google::Apis::DisplayvideoV1::AssignedLocation, decorator: Google::Apis::DisplayvideoV1::AssignedLocation::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListCampaignsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2539,6 +2743,24 @@ module Google end end + class ListNegativeKeywordsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :negative_keywords, as: 'negativeKeywords', class: Google::Apis::DisplayvideoV1::NegativeKeyword, decorator: Google::Apis::DisplayvideoV1::NegativeKeyword::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListSitesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :sites, as: 'sites', class: Google::Apis::DisplayvideoV1::Site, decorator: Google::Apis::DisplayvideoV1::Site::Representation + + end + end + class ListTargetingOptionsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2584,6 +2806,14 @@ module Google end end + class NegativeKeyword + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :keyword_value, as: 'keywordValue' + property :name, as: 'name' + end + end + class NegativeKeywordList # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2819,6 +3049,14 @@ module Google end end + class Site + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :url_or_app_id, as: 'urlOrAppId' + end + end + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/displayvideo_v1/service.rb b/generated/google/apis/displayvideo_v1/service.rb index 66c82009e..dbf0eda17 100644 --- a/generated/google/apis/displayvideo_v1/service.rb +++ b/generated/google/apis/displayvideo_v1/service.rb @@ -719,6 +719,234 @@ module Google execute_or_queue_command(command, &block) end + # Updates a channel. Returns the updated channel if successful. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the created channel. + # @param [Fixnum] channel_id + # Output only. The unique ID of the channel. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::Channel] channel_object + # @param [Fixnum] partner_id + # The ID of the partner that owns the created channel. + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @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::DisplayvideoV1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Channel] + # + # @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_advertiser_channel(advertiser_id, channel_id, channel_object = nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/channels/{channelId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation + command.response_class = Google::Apis::DisplayvideoV1::Channel + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Bulk edits sites under a single channel. + # The operation will delete the sites provided in + # BulkEditSitesRequest.deleted_sites and then create the sites + # provided in BulkEditSitesRequest.created_sites. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel to which the sites belong. + # @param [Google::Apis::DisplayvideoV1::BulkEditSitesRequest] bulk_edit_sites_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::DisplayvideoV1::BulkEditSitesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::BulkEditSitesResponse] + # + # @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 bulk_advertiser_channel_site_edit(advertiser_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit', options) + command.request_representation = Google::Apis::DisplayvideoV1::BulkEditSitesRequest::Representation + command.request_object = bulk_edit_sites_request_object + command.response_representation = Google::Apis::DisplayvideoV1::BulkEditSitesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::BulkEditSitesResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a site in a channel. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel in which the site will be created. + # @param [Google::Apis::DisplayvideoV1::Site] site_object + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent channel. + # @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::DisplayvideoV1::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Site] + # + # @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 create_advertiser_channel_site(advertiser_id, channel_id, site_object = nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites', options) + command.request_representation = Google::Apis::DisplayvideoV1::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DisplayvideoV1::Site::Representation + command.response_class = Google::Apis::DisplayvideoV1::Site + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a site from a channel. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel to which the site belongs. + # @param [String] url_or_app_id + # Required. The URL or app ID of the site to delete. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent channel. + # @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::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @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 delete_advertiser_channel_site(advertiser_id, channel_id, url_or_app_id, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil? + command.query['partnerId'] = partner_id unless partner_id.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 sites in a channel. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel to which the requested sites belong. + # @param [String] filter + # Allows filtering by site fields. + # Supported syntax: + # * Filter expressions for site currently can only contain at most one + # * restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `urlOrAppId` + # Examples: + # * All sites for which the URL or app ID contains "google": + # `urlOrAppId : "google"` + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `urlOrAppId` (default) + # The default sorting order is ascending. To specify descending order for a + # field, a suffix " desc" should be added to the field name. Example: + # `urlOrAppId desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token returned from the + # previous call to `ListSites` method. If not specified, the first page + # of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent channel. + # @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::DisplayvideoV1::ListSitesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListSitesResponse] + # + # @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_advertiser_channel_sites(advertiser_id, channel_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/channels/{+channelId}/sites', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListSitesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListSitesResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new creative. # Returns the newly created creative if successful. # @param [Fixnum] advertiser_id @@ -1715,6 +1943,40 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new location list. Returns the newly created location list if + # successful. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the location list belongs. + # @param [Google::Apis::DisplayvideoV1::LocationList] location_list_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::DisplayvideoV1::LocationList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::LocationList] + # + # @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 create_advertiser_location_list(advertiser_id, location_list_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/locationLists', options) + command.request_representation = Google::Apis::DisplayvideoV1::LocationList::Representation + command.request_object = location_list_object + command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation + command.response_class = Google::Apis::DisplayvideoV1::LocationList + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets a location list. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the fetched location list @@ -1817,6 +2079,293 @@ module Google execute_or_queue_command(command, &block) end + # Updates a location list. Returns the updated location list if successful. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the location lists belongs. + # @param [Fixnum] location_list_id + # Output only. The unique ID of the location list. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::LocationList] location_list_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @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::DisplayvideoV1::LocationList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::LocationList] + # + # @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_advertiser_location_list(advertiser_id, location_list_id, location_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/locationLists/{locationListId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::LocationList::Representation + command.request_object = location_list_object + command.response_representation = Google::Apis::DisplayvideoV1::LocationList::Representation + command.response_class = Google::Apis::DisplayvideoV1::LocationList + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['locationListId'] = location_list_id unless location_list_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Bulk edits multiple assignments between locations and a single location + # list. + # The operation will delete the assigned locations provided in + # BulkEditAssignedLocationsRequest.deleted_assigned_locations and then + # create the assigned locations provided in + # BulkEditAssignedLocationsRequest.created_assigned_locations. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the location list belongs. + # @param [Fixnum] location_list_id + # Required. The ID of the location list to which these assignments are assigned. + # @param [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsRequest] bulk_edit_assigned_locations_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::DisplayvideoV1::BulkEditAssignedLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse] + # + # @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 bulk_edit_assigned_locations(advertiser_id, location_list_id, bulk_edit_assigned_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit', options) + command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsRequest::Representation + command.request_object = bulk_edit_assigned_locations_request_object + command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::BulkEditAssignedLocationsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['locationListId'] = location_list_id unless location_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an assignment between a location and a location list. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the location list belongs. + # @param [Fixnum] location_list_id + # Required. The ID of the location list for which the assignment will be created. + # @param [Google::Apis::DisplayvideoV1::AssignedLocation] assigned_location_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::DisplayvideoV1::AssignedLocation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::AssignedLocation] + # + # @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 create_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options) + command.request_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation + command.request_object = assigned_location_object + command.response_representation = Google::Apis::DisplayvideoV1::AssignedLocation::Representation + command.response_class = Google::Apis::DisplayvideoV1::AssignedLocation + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['locationListId'] = location_list_id unless location_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the assignment between a location and a location list. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the location list belongs. + # @param [Fixnum] location_list_id + # Required. The ID of the location list to which this assignment is assigned. + # @param [Fixnum] assigned_location_id + # Required. The ID of the assigned location to delete. + # @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::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @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 delete_advertiser_location_list_assigned_location(advertiser_id, location_list_id, assigned_location_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['locationListId'] = location_list_id unless location_list_id.nil? + command.params['assignedLocationId'] = assigned_location_id unless assigned_location_id.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 locations assigned to a location list. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the location list belongs. + # @param [Fixnum] location_list_id + # Required. The ID of the location list to which these assignments are assigned. + # @param [String] filter + # Allows filtering by location list assignment fields. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by the logical operator `OR`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `assignedLocationId` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `assignedLocationId` (default) + # The default sorting order is ascending. To specify descending order for a + # field, a suffix " desc" should be added to the field name. Example: + # `assignedLocationId desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListAssignedLocations` + # method. If not specified, the first page of results will be returned. + # @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::DisplayvideoV1::ListAssignedLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse] + # + # @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_advertiser_location_list_assigned_locations(advertiser_id, location_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListAssignedLocationsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['locationListId'] = location_list_id unless location_list_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.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 + + # Creates a new negative keyword list. Returns the newly created negative + # keyword list if successful. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the negative keyword list + # will + # belong. + # @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_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::DisplayvideoV1::NegativeKeywordList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::NegativeKeywordList] + # + # @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 create_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/negativeKeywordLists', options) + command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation + command.request_object = negative_keyword_list_object + command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation + command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a negative keyword list given an advertiser ID and a negative + # keyword list ID. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the negative keyword list + # belongs. + # @param [Fixnum] negative_keyword_list_id + # Required. The ID of the negative keyword list to delete. + # @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::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @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 delete_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets a negative keyword list given an advertiser ID and a negative keyword # list ID. # @param [Fixnum] advertiser_id @@ -1897,6 +2446,245 @@ module Google execute_or_queue_command(command, &block) end + # Updates a negative keyword list. Returns the updated negative keyword list + # if successful. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the negative keyword list + # belongs. + # @param [Fixnum] negative_keyword_list_id + # Output only. The unique ID of the negative keyword list. Assigned by the + # system. + # @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @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::DisplayvideoV1::NegativeKeywordList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::NegativeKeywordList] + # + # @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_advertiser_negative_keyword_list(advertiser_id, negative_keyword_list_id, negative_keyword_list_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation + command.request_object = negative_keyword_list_object + command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeywordList::Representation + command.response_class = Google::Apis::DisplayvideoV1::NegativeKeywordList + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Bulk edits negative keywords in a single negative keyword list. + # The operation will delete the negative keywords provided in + # BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then + # create the negative keywords provided in + # BulkEditNegativeKeywordsRequest.created_negative_keywords. + # This operation is guaranteed to be atomic and will never result in a + # partial success or partial failure. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the parent negative keyword + # list + # belongs. + # @param [Fixnum] negative_keyword_list_id + # Required. The ID of the parent negative keyword list to which the negative + # keywords + # belong. + # @param [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest] bulk_edit_negative_keywords_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::DisplayvideoV1::BulkEditNegativeKeywordsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse] + # + # @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 bulk_edit_negative_keywords(advertiser_id, negative_keyword_list_id, bulk_edit_negative_keywords_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit', options) + command.request_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest::Representation + command.request_object = bulk_edit_negative_keywords_request_object + command.response_representation = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a negative keyword in a negative keyword list. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the parent negative keyword + # list + # belongs. + # @param [Fixnum] negative_keyword_list_id + # Required. The ID of the parent negative keyword list in which the negative + # keyword + # will be created. + # @param [Google::Apis::DisplayvideoV1::NegativeKeyword] negative_keyword_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::DisplayvideoV1::NegativeKeyword] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::NegativeKeyword] + # + # @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 create_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, negative_keyword_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options) + command.request_representation = Google::Apis::DisplayvideoV1::NegativeKeyword::Representation + command.request_object = negative_keyword_object + command.response_representation = Google::Apis::DisplayvideoV1::NegativeKeyword::Representation + command.response_class = Google::Apis::DisplayvideoV1::NegativeKeyword + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a negative keyword from a negative keyword list. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the parent negative keyword + # list + # belongs. + # @param [Fixnum] negative_keyword_list_id + # Required. The ID of the parent negative keyword list to which the negative + # keyword + # belongs. + # @param [String] keyword_value + # Required. The keyword value of the negative keyword to delete. + # @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::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @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 delete_advertiser_negative_keyword_list_negative_keyword(advertiser_id, negative_keyword_list_id, keyword_value, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil? + command.params['keywordValue'] = keyword_value unless keyword_value.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 negative keywords in a negative keyword list. + # @param [Fixnum] advertiser_id + # Required. The ID of the DV360 advertiser to which the parent negative keyword + # list + # belongs. + # @param [Fixnum] negative_keyword_list_id + # Required. The ID of the parent negative keyword list to which the requested + # negative + # keywords belong. + # @param [String] filter + # Allows filtering by negative keyword fields. + # Supported syntax: + # * Filter expressions for negative keyword currently can only contain at + # most one + # * restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `keywordValue` + # Examples: + # * All negative keywords for which the keyword value contains "google": + # `keywordValue : "google"` + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `keywordValue` (default) + # The default sorting order is ascending. To specify descending order for a + # field, a suffix " desc" should be added to the field name. Example: + # `keywordValue desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token returned + # from the previous call to `ListNegativeKeywords` method. If not specified, + # the first page of results will be returned. + # @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::DisplayvideoV1::ListNegativeKeywordsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse] + # + # @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_advertiser_negative_keyword_list_negative_keywords(advertiser_id, negative_keyword_list_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListNegativeKeywordsResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['negativeKeywordListId'] = negative_keyword_list_id unless negative_keyword_list_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.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 + # Assigns a targeting option to an advertiser. # Returns the assigned targeting option if successful. # @param [Fixnum] advertiser_id @@ -2573,6 +3361,85 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new inventory source group. Returns the newly created inventory + # source group if successful. + # @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the inventory source group. + # The parent partner will not have access to this group. + # @param [Fixnum] partner_id + # The ID of the partner that owns the inventory source group. + # Only this partner will have write access to this group. Only advertisers + # to which this group is explicitly shared will have read access to this + # group. + # @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::DisplayvideoV1::InventorySourceGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::InventorySourceGroup] + # + # @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 create_inventory_source_group(inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/inventorySourceGroups', options) + command.request_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation + command.request_object = inventory_source_group_object + command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation + command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an inventory source group. + # @param [Fixnum] inventory_source_group_id + # Required. The ID of the inventory source group to delete. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the inventory source group. + # The parent partner does not have access to this group. + # @param [Fixnum] partner_id + # The ID of the partner that owns the inventory source group. + # Only this partner has write access to this group. + # @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::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @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 delete_inventory_source_group(inventory_source_group_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/inventorySourceGroups/{+inventorySourceGroupId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets an inventory source group. # @param [Fixnum] inventory_source_group_id # Required. The ID of the inventory source group to fetch. @@ -2681,6 +3548,253 @@ module Google execute_or_queue_command(command, &block) end + # Updates an inventory source group. Returns the updated inventory source + # group if successful. + # @param [Fixnum] inventory_source_group_id + # Output only. The unique ID of the inventory source group. Assigned by the + # system. + # @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the inventory source group. + # The parent partner does not have access to this group. + # @param [Fixnum] partner_id + # The ID of the partner that owns the inventory source group. + # Only this partner has write access to this group. + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @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::DisplayvideoV1::InventorySourceGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::InventorySourceGroup] + # + # @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_inventory_source_group(inventory_source_group_id, inventory_source_group_object = nil, advertiser_id: nil, partner_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/inventorySourceGroups/{inventorySourceGroupId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation + command.request_object = inventory_source_group_object + command.response_representation = Google::Apis::DisplayvideoV1::InventorySourceGroup::Representation + command.response_class = Google::Apis::DisplayvideoV1::InventorySourceGroup + command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Bulk edits multiple assignments between inventory sources and a single + # inventory source group. + # The operation will delete the assigned inventory sources provided in + # BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources + # and then create the assigned inventory sources provided in + # BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources. + # @param [Fixnum] inventory_source_group_id + # Required. The ID of the inventory source group to which the assignments are + # assigned. + # @param [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesRequest] bulk_edit_assigned_inventory_sources_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::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse] + # + # @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 bulk_edit_assigned_inventory_sources(inventory_source_group_id, bulk_edit_assigned_inventory_sources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit', options) + command.request_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesRequest::Representation + command.request_object = bulk_edit_assigned_inventory_sources_request_object + command.response_representation = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::BulkEditAssignedInventorySourcesResponse + command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an assignment between an inventory source and an inventory source + # group. + # @param [Fixnum] inventory_source_group_id + # Required. The ID of the inventory source group to which the assignment will be + # assigned. + # @param [Google::Apis::DisplayvideoV1::AssignedInventorySource] assigned_inventory_source_object + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent inventory source group. + # The parent partner will not have access to this assigned inventory + # source. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent inventory source group. + # Only this partner will have write access to this assigned inventory + # source. + # @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::DisplayvideoV1::AssignedInventorySource] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::AssignedInventorySource] + # + # @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 create_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_object = nil, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options) + command.request_representation = Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation + command.request_object = assigned_inventory_source_object + command.response_representation = Google::Apis::DisplayvideoV1::AssignedInventorySource::Representation + command.response_class = Google::Apis::DisplayvideoV1::AssignedInventorySource + command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the assignment between an inventory source and an inventory source + # group. + # @param [Fixnum] inventory_source_group_id + # Required. The ID of the inventory source group to which this assignment is + # assigned. + # @param [Fixnum] assigned_inventory_source_id + # Required. The ID of the assigned inventory source to delete. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent inventory source group. + # The parent partner does not have access to this assigned inventory + # source. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent inventory source group. + # Only this partner has write access to this assigned inventory source. + # @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::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @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 delete_inventory_source_group_assigned_inventory_source(inventory_source_group_id, assigned_inventory_source_id, advertiser_id: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil? + command.params['assignedInventorySourceId'] = assigned_inventory_source_id unless assigned_inventory_source_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['partnerId'] = partner_id unless partner_id.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 inventory sources assigned to an inventory source group. + # @param [Fixnum] inventory_source_group_id + # Required. The ID of the inventory source group to which these assignments are + # assigned. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that has access to the assignment. + # If the parent inventory source group is partner-owned, only advertisers + # to which the parent group is explicitly shared can access the assigned + # inventory source. + # @param [String] filter + # Allows filtering by assigned inventory source fields. + # Supported syntax: + # * Filter expressions are made up of one or more restrictions. + # * Restrictions can be combined by the logical operator `OR`. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `EQUALS (=)`. + # * Supported fields: + # - `assignedInventorySourceId` + # The length of this field should be no more than 500 characters. + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `assignedInventorySourceId` (default) + # The default sorting order is ascending. To specify descending order for a + # field, a suffix " desc" should be added to the field name. Example: + # `assignedInventorySourceId desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token + # returned from the previous call to `ListAssignedInventorySources` + # method. If not specified, the first page of results will be returned. + # @param [Fixnum] partner_id + # The ID of the partner that has access to the assignment. + # If the parent inventory source group is advertiser-owned, the assignment + # cannot be accessed via a partner. + # @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::DisplayvideoV1::ListAssignedInventorySourcesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse] + # + # @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_inventory_source_group_assigned_inventory_sources(inventory_source_group_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, partner_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListAssignedInventorySourcesResponse + command.params['inventorySourceGroupId'] = inventory_source_group_id unless inventory_source_group_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerId'] = partner_id unless partner_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets an inventory source. # @param [Fixnum] inventory_source_id # Required. The ID of the inventory source to fetch. @@ -2939,6 +4053,234 @@ module Google execute_or_queue_command(command, &block) end + # Updates a channel. Returns the updated channel if successful. + # @param [Fixnum] partner_id + # The ID of the partner that owns the created channel. + # @param [Fixnum] channel_id + # Output only. The unique ID of the channel. Assigned by the system. + # @param [Google::Apis::DisplayvideoV1::Channel] channel_object + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the created channel. + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @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::DisplayvideoV1::Channel] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Channel] + # + # @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_partner_channel(partner_id, channel_id, channel_object = nil, advertiser_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/partners/{+partnerId}/channels/{channelId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::Channel::Representation + command.request_object = channel_object + command.response_representation = Google::Apis::DisplayvideoV1::Channel::Representation + command.response_class = Google::Apis::DisplayvideoV1::Channel + command.params['partnerId'] = partner_id unless partner_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Bulk edits sites under a single channel. + # The operation will delete the sites provided in + # BulkEditSitesRequest.deleted_sites and then create the sites + # provided in BulkEditSitesRequest.created_sites. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel to which the sites belong. + # @param [Google::Apis::DisplayvideoV1::BulkEditSitesRequest] bulk_edit_sites_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::DisplayvideoV1::BulkEditSitesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::BulkEditSitesResponse] + # + # @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 bulk_partner_channel_site_edit(partner_id, channel_id, bulk_edit_sites_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit', options) + command.request_representation = Google::Apis::DisplayvideoV1::BulkEditSitesRequest::Representation + command.request_object = bulk_edit_sites_request_object + command.response_representation = Google::Apis::DisplayvideoV1::BulkEditSitesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::BulkEditSitesResponse + command.params['partnerId'] = partner_id unless partner_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a site in a channel. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel in which the site will be created. + # @param [Google::Apis::DisplayvideoV1::Site] site_object + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent channel. + # @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::DisplayvideoV1::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Site] + # + # @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 create_partner_channel_site(partner_id, channel_id, site_object = nil, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/partners/{partnerId}/channels/{+channelId}/sites', options) + command.request_representation = Google::Apis::DisplayvideoV1::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DisplayvideoV1::Site::Representation + command.response_class = Google::Apis::DisplayvideoV1::Site + command.params['partnerId'] = partner_id unless partner_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a site from a channel. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel to which the site belongs. + # @param [String] url_or_app_id + # Required. The URL or app ID of the site to delete. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent channel. + # @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::DisplayvideoV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::Empty] + # + # @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 delete_partner_channel_site(partner_id, channel_id, url_or_app_id, advertiser_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::Empty::Representation + command.response_class = Google::Apis::DisplayvideoV1::Empty + command.params['partnerId'] = partner_id unless partner_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.params['urlOrAppId'] = url_or_app_id unless url_or_app_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.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 sites in a channel. + # @param [Fixnum] partner_id + # The ID of the partner that owns the parent channel. + # @param [Fixnum] channel_id + # Required. The ID of the parent channel to which the requested sites belong. + # @param [Fixnum] advertiser_id + # The ID of the advertiser that owns the parent channel. + # @param [String] filter + # Allows filtering by site fields. + # Supported syntax: + # * Filter expressions for site currently can only contain at most one + # * restriction. + # * A restriction has the form of ``field` `operator` `value``. + # * The operator must be `CONTAINS (:)`. + # * Supported fields: + # - `urlOrAppId` + # Examples: + # * All sites for which the URL or app ID contains "google": + # `urlOrAppId : "google"` + # @param [String] order_by + # Field by which to sort the list. + # Acceptable values are: + # * `urlOrAppId` (default) + # The default sorting order is ascending. To specify descending order for a + # field, a suffix " desc" should be added to the field name. Example: + # `urlOrAppId desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value + # is specified. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # next_page_token returned from the + # previous call to `ListSites` method. If not specified, the first page + # of results will be returned. + # @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::DisplayvideoV1::ListSitesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListSitesResponse] + # + # @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_partner_channel_sites(partner_id, channel_id, advertiser_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/partners/{+partnerId}/channels/{+channelId}/sites', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListSitesResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListSitesResponse + command.params['partnerId'] = partner_id unless partner_id.nil? + command.params['channelId'] = channel_id unless channel_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.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 + # Creates an SDF Download Task. Returns an # Operation. # An SDF Download Task is a long-running, asynchronous operation. The diff --git a/generated/google/apis/recommender_v1.rb b/generated/google/apis/recommender_v1.rb new file mode 100644 index 000000000..d11f69db2 --- /dev/null +++ b/generated/google/apis/recommender_v1.rb @@ -0,0 +1,34 @@ +# 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/recommender_v1/service.rb' +require 'google/apis/recommender_v1/classes.rb' +require 'google/apis/recommender_v1/representations.rb' + +module Google + module Apis + # Recommender API + # + # + # + # @see https://cloud.google.com/recommender/docs/ + module RecommenderV1 + VERSION = 'V1' + REVISION = '20200516' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/recommender_v1/classes.rb b/generated/google/apis/recommender_v1/classes.rb new file mode 100644 index 000000000..5336a671b --- /dev/null +++ b/generated/google/apis/recommender_v1/classes.rb @@ -0,0 +1,505 @@ +# 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 '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 RecommenderV1 + + # Contains metadata about how much money a recommendation can save or incur. + class GoogleCloudRecommenderV1CostProjection + include Google::Apis::Core::Hashable + + # Represents an amount of money with its currency type. + # Corresponds to the JSON property `cost` + # @return [Google::Apis::RecommenderV1::GoogleTypeMoney] + attr_accessor :cost + + # Duration for which this cost applies. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cost = args[:cost] if args.key?(:cost) + @duration = args[:duration] if args.key?(:duration) + end + end + + # Contains the impact a recommendation can have for a given category. + class GoogleCloudRecommenderV1Impact + include Google::Apis::Core::Hashable + + # Category that is being targeted. + # Corresponds to the JSON property `category` + # @return [String] + attr_accessor :category + + # Contains metadata about how much money a recommendation can save or incur. + # Corresponds to the JSON property `costProjection` + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1CostProjection] + attr_accessor :cost_projection + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @category = args[:category] if args.key?(:category) + @cost_projection = args[:cost_projection] if args.key?(:cost_projection) + end + end + + # Response to the `ListRecommendations` method. + class GoogleCloudRecommenderV1ListRecommendationsResponse + include Google::Apis::Core::Hashable + + # A token that can be used to request the next page of results. This field is + # empty if there are no additional results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The set of recommendations for the `parent` resource. + # Corresponds to the JSON property `recommendations` + # @return [Array] + attr_accessor :recommendations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @recommendations = args[:recommendations] if args.key?(:recommendations) + end + end + + # Request for the `MarkRecommendationClaimed` Method. + class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + include Google::Apis::Core::Hashable + + # Required. Fingerprint of the Recommendation. Provides optimistic locking. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # State properties to include with this state. Overwrites any existing + # `state_metadata`. + # Keys must match the regex /^a-z0-9`0,62`$/. + # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # Corresponds to the JSON property `stateMetadata` + # @return [Hash] + attr_accessor :state_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @state_metadata = args[:state_metadata] if args.key?(:state_metadata) + end + end + + # Request for the `MarkRecommendationFailed` Method. + class GoogleCloudRecommenderV1MarkRecommendationFailedRequest + include Google::Apis::Core::Hashable + + # Required. Fingerprint of the Recommendation. Provides optimistic locking. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # State properties to include with this state. Overwrites any existing + # `state_metadata`. + # Keys must match the regex /^a-z0-9`0,62`$/. + # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # Corresponds to the JSON property `stateMetadata` + # @return [Hash] + attr_accessor :state_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @state_metadata = args[:state_metadata] if args.key?(:state_metadata) + end + end + + # Request for the `MarkRecommendationSucceeded` Method. + class GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + include Google::Apis::Core::Hashable + + # Required. Fingerprint of the Recommendation. Provides optimistic locking. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # State properties to include with this state. Overwrites any existing + # `state_metadata`. + # Keys must match the regex /^a-z0-9`0,62`$/. + # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # Corresponds to the JSON property `stateMetadata` + # @return [Hash] + attr_accessor :state_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @state_metadata = args[:state_metadata] if args.key?(:state_metadata) + end + end + + # Contains an operation for a resource loosely based on the JSON-PATCH format + # with support for: + # * Custom filters for describing partial array patch. + # * Extended path values for describing nested arrays. + # * Custom fields for describing the resource for which the operation is being + # described. + # * Allows extension to custom operations not natively supported by RFC6902. + # See https://tools.ietf.org/html/rfc6902 for details on the original RFC. + class GoogleCloudRecommenderV1Operation + include Google::Apis::Core::Hashable + + # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', + # 'copy', 'test' and custom operations. This field is case-insensitive and + # always populated. + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # Path to the target field being operated on. If the operation is at the + # resource level, then path should be "/". This field is always populated. + # Corresponds to the JSON property `path` + # @return [String] + attr_accessor :path + + # Set of filters to apply if `path` refers to array elements or nested array + # elements in order to narrow down to a single unique element that is being + # tested/modified. + # This is intended to be an exact match per filter. To perform advanced + # matching, use path_value_matchers. + # * Example: ` + # "/versions/*/name" : "it-123" + # "/versions/*/targetSize/percent": 20 + # ` + # * Example: ` + # "/bindings/*/role": "roles/admin" + # "/bindings/*/condition" : null + # ` + # * Example: ` + # "/bindings/*/role": "roles/admin" + # "/bindings/*/members/*" : ["x@google.com", "y@google.com"] + # ` + # When both path_filters and path_value_matchers are set, an implicit AND + # must be performed. + # Corresponds to the JSON property `pathFilters` + # @return [Hash] + attr_accessor :path_filters + + # Similar to path_filters, this contains set of filters to apply if `path` + # field referes to array elements. This is meant to support value matching + # beyond exact match. To perform exact match, use path_filters. + # When both path_filters and path_value_matchers are set, an implicit AND + # must be performed. + # Corresponds to the JSON property `pathValueMatchers` + # @return [Hash] + attr_accessor :path_value_matchers + + # Contains the fully qualified resource name. This field is always populated. + # ex: //cloudresourcemanager.googleapis.com/projects/foo. + # Corresponds to the JSON property `resource` + # @return [String] + attr_accessor :resource + + # Type of GCP resource being modified/tested. This field is always populated. + # Example: cloudresourcemanager.googleapis.com/Project, + # compute.googleapis.com/Instance + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + # Can be set with action 'copy' or 'move' to indicate the source field within + # resource or source_resource, ignored if provided for other operation types. + # Corresponds to the JSON property `sourcePath` + # @return [String] + attr_accessor :source_path + + # Can be set with action 'copy' to copy resource configuration across + # different resources of the same type. Example: A resource clone can be + # done via action = 'copy', path = "/", from = "/", + # source_resource = and resource_name = . + # This field is empty for all other values of `action`. + # Corresponds to the JSON property `sourceResource` + # @return [String] + attr_accessor :source_resource + + # Value for the `path` field. Will be set for actions:'add'/'replace'. + # Maybe set for action: 'test'. Either this or `value_matcher` will be set + # for 'test' operation. An exact match must be performed. + # Corresponds to the JSON property `value` + # @return [Object] + attr_accessor :value + + # Contains various matching options for values for a GCP resource field. + # Corresponds to the JSON property `valueMatcher` + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher] + attr_accessor :value_matcher + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @path = args[:path] if args.key?(:path) + @path_filters = args[:path_filters] if args.key?(:path_filters) + @path_value_matchers = args[:path_value_matchers] if args.key?(:path_value_matchers) + @resource = args[:resource] if args.key?(:resource) + @resource_type = args[:resource_type] if args.key?(:resource_type) + @source_path = args[:source_path] if args.key?(:source_path) + @source_resource = args[:source_resource] if args.key?(:source_resource) + @value = args[:value] if args.key?(:value) + @value_matcher = args[:value_matcher] if args.key?(:value_matcher) + end + end + + # Group of operations that need to be performed atomically. + class GoogleCloudRecommenderV1OperationGroup + include Google::Apis::Core::Hashable + + # List of operations across one or more resources that belong to this group. + # Loosely based on RFC6902 and should be performed in the order they appear. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operations = args[:operations] if args.key?(:operations) + end + end + + # A recommendation along with a suggested action. E.g., a rightsizing + # recommendation for an underutilized VM, IAM role recommendations, etc + class GoogleCloudRecommenderV1Recommendation + include Google::Apis::Core::Hashable + + # Optional set of additional impact that this recommendation may have when + # trying to optimize for the primary category. These may be positive + # or negative. + # Corresponds to the JSON property `additionalImpact` + # @return [Array] + attr_accessor :additional_impact + + # Contains what resources are changing and how they are changing. + # Corresponds to the JSON property `content` + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent] + attr_accessor :content + + # Free-form human readable summary in English. The maximum length is 500 + # characters. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Fingerprint of the Recommendation. Provides optimistic locking when + # updating states. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Last time this recommendation was refreshed by the system that created it + # in the first place. + # Corresponds to the JSON property `lastRefreshTime` + # @return [String] + attr_accessor :last_refresh_time + + # Name of recommendation. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Contains the impact a recommendation can have for a given category. + # Corresponds to the JSON property `primaryImpact` + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact] + attr_accessor :primary_impact + + # Contains an identifier for a subtype of recommendations produced for the + # same recommender. Subtype is a function of content and impact, meaning a + # new subtype might be added when significant changes to `content` or + # `primary_impact.category` are introduced. See the Recommenders section + # to see a list of subtypes for a given Recommender. + # Examples: + # For recommender = "google.iam.policy.Recommender", + # recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" + # Corresponds to the JSON property `recommenderSubtype` + # @return [String] + attr_accessor :recommender_subtype + + # Information for state. Contains state and metadata. + # Corresponds to the JSON property `stateInfo` + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationStateInfo] + attr_accessor :state_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additional_impact = args[:additional_impact] if args.key?(:additional_impact) + @content = args[:content] if args.key?(:content) + @description = args[:description] if args.key?(:description) + @etag = args[:etag] if args.key?(:etag) + @last_refresh_time = args[:last_refresh_time] if args.key?(:last_refresh_time) + @name = args[:name] if args.key?(:name) + @primary_impact = args[:primary_impact] if args.key?(:primary_impact) + @recommender_subtype = args[:recommender_subtype] if args.key?(:recommender_subtype) + @state_info = args[:state_info] if args.key?(:state_info) + end + end + + # Contains what resources are changing and how they are changing. + class GoogleCloudRecommenderV1RecommendationContent + include Google::Apis::Core::Hashable + + # Operations to one or more Google Cloud resources grouped in such a way + # that, all operations within one group are expected to be performed + # atomically and in an order. + # Corresponds to the JSON property `operationGroups` + # @return [Array] + attr_accessor :operation_groups + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operation_groups = args[:operation_groups] if args.key?(:operation_groups) + end + end + + # Information for state. Contains state and metadata. + class GoogleCloudRecommenderV1RecommendationStateInfo + include Google::Apis::Core::Hashable + + # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # A map of metadata for the state, provided by user or automations systems. + # Corresponds to the JSON property `stateMetadata` + # @return [Hash] + attr_accessor :state_metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @state = args[:state] if args.key?(:state) + @state_metadata = args[:state_metadata] if args.key?(:state_metadata) + end + end + + # Contains various matching options for values for a GCP resource field. + class GoogleCloudRecommenderV1ValueMatcher + include Google::Apis::Core::Hashable + + # To be used for full regex matching. The regular expression is using the + # Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be + # used with RE2::FullMatch + # Corresponds to the JSON property `matchesPattern` + # @return [String] + attr_accessor :matches_pattern + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @matches_pattern = args[:matches_pattern] if args.key?(:matches_pattern) + end + end + + # Represents an amount of money with its currency type. + class GoogleTypeMoney + include Google::Apis::Core::Hashable + + # The 3-letter currency code defined in ISO 4217. + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # Number of nano (10^-9) units of the amount. + # The value must be between -999,999,999 and +999,999,999 inclusive. + # If `units` is positive, `nanos` must be positive or zero. + # If `units` is zero, `nanos` can be positive, zero, or negative. + # If `units` is negative, `nanos` must be negative or zero. + # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + # Corresponds to the JSON property `nanos` + # @return [Fixnum] + attr_accessor :nanos + + # The whole units of the amount. + # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + # Corresponds to the JSON property `units` + # @return [Fixnum] + attr_accessor :units + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @nanos = args[:nanos] if args.key?(:nanos) + @units = args[:units] if args.key?(:units) + end + end + end + end +end diff --git a/generated/google/apis/recommender_v1/representations.rb b/generated/google/apis/recommender_v1/representations.rb new file mode 100644 index 000000000..a5ed5de0a --- /dev/null +++ b/generated/google/apis/recommender_v1/representations.rb @@ -0,0 +1,232 @@ +# 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 '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 RecommenderV1 + + class GoogleCloudRecommenderV1CostProjection + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1Impact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1ListRecommendationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1MarkRecommendationFailedRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1OperationGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1Recommendation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1RecommendationContent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1RecommendationStateInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1ValueMatcher + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleTypeMoney + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudRecommenderV1CostProjection + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cost, as: 'cost', class: Google::Apis::RecommenderV1::GoogleTypeMoney, decorator: Google::Apis::RecommenderV1::GoogleTypeMoney::Representation + + property :duration, as: 'duration' + end + end + + class GoogleCloudRecommenderV1Impact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :category, as: 'category' + property :cost_projection, as: 'costProjection', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1CostProjection, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1CostProjection::Representation + + end + end + + class GoogleCloudRecommenderV1ListRecommendationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :recommendations, as: 'recommendations', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation + + end + end + + class GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + hash :state_metadata, as: 'stateMetadata' + end + end + + class GoogleCloudRecommenderV1MarkRecommendationFailedRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + hash :state_metadata, as: 'stateMetadata' + end + end + + class GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + hash :state_metadata, as: 'stateMetadata' + end + end + + class GoogleCloudRecommenderV1Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + property :path, as: 'path' + hash :path_filters, as: 'pathFilters' + hash :path_value_matchers, as: 'pathValueMatchers', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher::Representation + + property :resource, as: 'resource' + property :resource_type, as: 'resourceType' + property :source_path, as: 'sourcePath' + property :source_resource, as: 'sourceResource' + property :value, as: 'value' + property :value_matcher, as: 'valueMatcher', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ValueMatcher::Representation + + end + end + + class GoogleCloudRecommenderV1OperationGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :operations, as: 'operations', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Operation, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Operation::Representation + + end + end + + class GoogleCloudRecommenderV1Recommendation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :additional_impact, as: 'additionalImpact', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact::Representation + + property :content, as: 'content', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent::Representation + + property :description, as: 'description' + property :etag, as: 'etag' + property :last_refresh_time, as: 'lastRefreshTime' + property :name, as: 'name' + property :primary_impact, as: 'primaryImpact', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact::Representation + + property :recommender_subtype, as: 'recommenderSubtype' + property :state_info, as: 'stateInfo', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationStateInfo, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationStateInfo::Representation + + end + end + + class GoogleCloudRecommenderV1RecommendationContent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :operation_groups, as: 'operationGroups', class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1OperationGroup, decorator: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1OperationGroup::Representation + + end + end + + class GoogleCloudRecommenderV1RecommendationStateInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :state, as: 'state' + hash :state_metadata, as: 'stateMetadata' + end + end + + class GoogleCloudRecommenderV1ValueMatcher + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :matches_pattern, as: 'matchesPattern' + end + end + + class GoogleTypeMoney + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :currency_code, as: 'currencyCode' + property :nanos, as: 'nanos' + property :units, :numeric_string => true, as: 'units' + end + end + end + end +end diff --git a/generated/google/apis/recommender_v1/service.rb b/generated/google/apis/recommender_v1/service.rb new file mode 100644 index 000000000..a689f4e47 --- /dev/null +++ b/generated/google/apis/recommender_v1/service.rb @@ -0,0 +1,266 @@ +# 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 RecommenderV1 + # Recommender API + # + # + # + # @example + # require 'google/apis/recommender_v1' + # + # Recommender = Google::Apis::RecommenderV1 # Alias the module + # service = Recommender::RecommenderService.new + # + # @see https://cloud.google.com/recommender/docs/ + class RecommenderService < 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://recommender.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets the requested recommendation. Requires the recommender.*.get + # IAM permission for the specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] + # + # @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_project_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation + 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 recommendations for a Cloud project. Requires the recommender.*.list + # IAM permission for the specified recommender. + # @param [String] parent + # Required. The container resource on which to execute the request. + # Acceptable formats: + # 1. + # "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", + # LOCATION here refers to GCP Locations: + # https://cloud.google.com/about/locations/ + # @param [String] filter + # Filter expression to restrict the recommendations returned. Supported + # filter fields: state_info.state + # Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive + # values are ignored. If not specified, the server will determine the number + # of results to return. + # @param [String] page_token + # Optional. If present, retrieves the next batch of results from the preceding + # call to + # this method. `page_token` must be the value of `next_page_token` from the + # previous response. The values of other method parameters must be identical + # to those in the previous call. + # @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::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse] + # + # @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_project_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/recommendations', options) + command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation + command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.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 + + # Marks the Recommendation State as Claimed. Users can use this method to + # indicate to the Recommender API that they are starting to apply the + # recommendation themselves. This stops the recommendation content from being + # updated. Associated insights are frozen and placed in the ACCEPTED state. + # MarkRecommendationClaimed can be applied to recommendations in CLAIMED, + # SUCCEEDED, FAILED, or ACTIVE state. + # Requires the recommender.*.update IAM permission for the specified + # recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest] google_cloud_recommender_v1_mark_recommendation_claimed_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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] + # + # @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 mark_project_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:markClaimed', options) + command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation + command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object + command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation + 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 + + # Marks the Recommendation State as Failed. Users can use this method to + # indicate to the Recommender API that they have applied the recommendation + # themselves, and the operation failed. This stops the recommendation content + # from being updated. Associated insights are frozen and placed in the + # ACCEPTED state. + # MarkRecommendationFailed can be applied to recommendations in ACTIVE, + # CLAIMED, SUCCEEDED, or FAILED state. + # Requires the recommender.*.update IAM permission for the specified + # recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest] google_cloud_recommender_v1_mark_recommendation_failed_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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] + # + # @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 mark_project_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:markFailed', options) + command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation + command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object + command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation + 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 + + # Marks the Recommendation State as Succeeded. Users can use this method to + # indicate to the Recommender API that they have applied the recommendation + # themselves, and the operation was successful. This stops the recommendation + # content from being updated. Associated insights are frozen and placed in + # the ACCEPTED state. + # MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, + # CLAIMED, SUCCEEDED, or FAILED state. + # Requires the recommender.*.update IAM permission for the specified + # recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest] google_cloud_recommender_v1_mark_recommendation_succeeded_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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] + # + # @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 mark_project_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options) + command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation + command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object + command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation + 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 + + 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 diff --git a/generated/google/apis/run_v1.rb b/generated/google/apis/run_v1.rb index 949c59b0e..df44e647c 100644 --- a/generated/google/apis/run_v1.rb +++ b/generated/google/apis/run_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1 VERSION = 'V1' - REVISION = '20200505' + REVISION = '20200521' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1/classes.rb b/generated/google/apis/run_v1/classes.rb index 1f0bc968e..0b69eeb4f 100644 --- a/generated/google/apis/run_v1/classes.rb +++ b/generated/google/apis/run_v1/classes.rb @@ -887,6 +887,14 @@ module Google # @return [Array] attr_accessor :resource_records + # Cloud Run fully managed: not supported + # Cloud Run on GKE: supported + # Holds the URL that will serve the traffic of the DomainMapping. + # +optional + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + def initialize(**args) update!(**args) end @@ -897,6 +905,7 @@ module Google @mapped_route_name = args[:mapped_route_name] if args.key?(:mapped_route_name) @observed_generation = args[:observed_generation] if args.key?(:observed_generation) @resource_records = args[:resource_records] if args.key?(:resource_records) + @url = args[:url] if args.key?(:url) end end diff --git a/generated/google/apis/run_v1/representations.rb b/generated/google/apis/run_v1/representations.rb index 23cf4d281..c0c1f2c51 100644 --- a/generated/google/apis/run_v1/representations.rb +++ b/generated/google/apis/run_v1/representations.rb @@ -614,6 +614,7 @@ module Google property :observed_generation, as: 'observedGeneration' collection :resource_records, as: 'resourceRecords', class: Google::Apis::RunV1::ResourceRecord, decorator: Google::Apis::RunV1::ResourceRecord::Representation + property :url, as: 'url' end end diff --git a/generated/google/apis/run_v1alpha1.rb b/generated/google/apis/run_v1alpha1.rb index 51800d861..cb105a862 100644 --- a/generated/google/apis/run_v1alpha1.rb +++ b/generated/google/apis/run_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200505' + REVISION = '20200521' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1alpha1/classes.rb b/generated/google/apis/run_v1alpha1/classes.rb index 80b2504de..4670c80a4 100644 --- a/generated/google/apis/run_v1alpha1/classes.rb +++ b/generated/google/apis/run_v1alpha1/classes.rb @@ -1815,6 +1815,14 @@ module Google # @return [Array] attr_accessor :resource_records + # Cloud Run fully managed: not supported + # Cloud Run on GKE: supported + # Holds the URL that will serve the traffic of the DomainMapping. + # +optional + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + def initialize(**args) update!(**args) end @@ -1825,6 +1833,7 @@ module Google @mapped_route_name = args[:mapped_route_name] if args.key?(:mapped_route_name) @observed_generation = args[:observed_generation] if args.key?(:observed_generation) @resource_records = args[:resource_records] if args.key?(:resource_records) + @url = args[:url] if args.key?(:url) end end diff --git a/generated/google/apis/run_v1alpha1/representations.rb b/generated/google/apis/run_v1alpha1/representations.rb index f0316162d..17da28f18 100644 --- a/generated/google/apis/run_v1alpha1/representations.rb +++ b/generated/google/apis/run_v1alpha1/representations.rb @@ -1064,6 +1064,7 @@ module Google property :observed_generation, as: 'observedGeneration' collection :resource_records, as: 'resourceRecords', class: Google::Apis::RunV1alpha1::ResourceRecord, decorator: Google::Apis::RunV1alpha1::ResourceRecord::Representation + property :url, as: 'url' end end diff --git a/generated/google/apis/sourcerepo_v1.rb b/generated/google/apis/sourcerepo_v1.rb index c88732263..39e4e943a 100644 --- a/generated/google/apis/sourcerepo_v1.rb +++ b/generated/google/apis/sourcerepo_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/source-repositories/docs/apis module SourcerepoV1 VERSION = 'V1' - REVISION = '20200415' + REVISION = '20200520' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/sourcerepo_v1/classes.rb b/generated/google/apis/sourcerepo_v1/classes.rb index 9251a6130..ca09d2a4f 100644 --- a/generated/google/apis/sourcerepo_v1/classes.rb +++ b/generated/google/apis/sourcerepo_v1/classes.rb @@ -438,10 +438,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -456,7 +459,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -534,6 +539,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -681,10 +689,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -699,7 +710,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/sourcerepo_v1/service.rb b/generated/google/apis/sourcerepo_v1/service.rb index 9eb5231d7..c8a04aade 100644 --- a/generated/google/apis/sourcerepo_v1/service.rb +++ b/generated/google/apis/sourcerepo_v1/service.rb @@ -223,6 +223,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/spanner_v1.rb b/generated/google/apis/spanner_v1.rb index 32a80a965..d64a49a35 100644 --- a/generated/google/apis/spanner_v1.rb +++ b/generated/google/apis/spanner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/spanner/ module SpannerV1 VERSION = 'V1' - REVISION = '20200522' + REVISION = '20200526' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/spanner_v1/classes.rb b/generated/google/apis/spanner_v1/classes.rb index 01cec8d23..5e037a5f3 100644 --- a/generated/google/apis/spanner_v1/classes.rb +++ b/generated/google/apis/spanner_v1/classes.rb @@ -3207,8 +3207,7 @@ module Google # @return [Hash] attr_accessor :labels - # The name of the session. This is always system-assigned; values provided - # when creating a session are ignored. + # Output only. The name of the session. This is always system-assigned. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name diff --git a/generated/google/apis/spanner_v1/service.rb b/generated/google/apis/spanner_v1/service.rb index 23f81a2a5..1607751a9 100644 --- a/generated/google/apis/spanner_v1/service.rb +++ b/generated/google/apis/spanner_v1/service.rb @@ -537,9 +537,9 @@ module Google # * `metadata.database:prod` - The database the backup was taken from has # a name containing the string "prod". # * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. - # CreateBackupMetadata) AND`
- # `(metadata.name:howl) AND`
- # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
+ # CreateBackupMetadata) AND` \ + # `(metadata.name:howl) AND` \ + # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ # `(error:*)` - Returns operations where: # * The operation's metadata type is CreateBackupMetadata. # * The backup name contains the string "howl". @@ -1140,11 +1140,11 @@ module Google # Here are a few examples: # * `done:true` - The operation is complete. # * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. - # RestoreDatabaseMetadata) AND`
- # `(metadata.source_type:BACKUP) AND`
- # `(metadata.backup_info.backup:backup_howl) AND`
- # `(metadata.name:restored_howl) AND`
- # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
+ # RestoreDatabaseMetadata) AND` \ + # `(metadata.source_type:BACKUP) AND` \ + # `(metadata.backup_info.backup:backup_howl) AND` \ + # `(metadata.name:restored_howl) AND` \ + # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ # `(error:*)` - Return operations where: # * The operation's metadata type is RestoreDatabaseMetadata. # * The database is restored from a backup.