Class: Google::Apis::ChromepolicyV1::ChromePolicyService
- Inherits:
- 
      Google::Apis::Core::BaseService
      
        - Object
- Google::Apis::Core::BaseService
- Google::Apis::ChromepolicyV1::ChromePolicyService
 
- Defined in:
- lib/google/apis/chromepolicy_v1/service.rb
Overview
Chrome Policy API
The Chrome Policy API is a suite of services that allows Chrome administrators to control the policies applied to their managed Chrome OS devices and Chrome browsers.
Instance Attribute Summary collapse
- 
  
    
      #key  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    API key. 
- 
  
    
      #quota_user  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    Available to use for quota purposes for server-side applications. 
Instance Method Summary collapse
- 
  
    
      #batch_customer_policy_group_delete(customer, google_chrome_policy_v1_batch_delete_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty 
    
    
  
  
  
  
  
  
  
  
  
    Delete multiple policy values that are applied to a specific group. 
- 
  
    
      #batch_customer_policy_group_modify(customer, google_chrome_policy_v1_batch_modify_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty 
    
    
  
  
  
  
  
  
  
  
  
    Modify multiple policy values that are applied to a specific group. 
- 
  
    
      #batch_customer_policy_orgunit_inherit(customer, google_chrome_policy_v1_batch_inherit_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty 
    
    
  
  
  
  
  
  
  
  
  
    Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). 
- 
  
    
      #batch_customer_policy_orgunit_modify(customer, google_chrome_policy_v1_batch_modify_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty 
    
    
  
  
  
  
  
  
  
  
  
    Modify multiple policy values that are applied to a specific org unit. 
- 
  
    
      #get_customer_policy_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchema 
    
    
  
  
  
  
  
  
  
  
  
    Get a specific policy schema for a customer by its resource name. 
- 
  
    
      #initialize  ⇒ ChromePolicyService 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    A new instance of ChromePolicyService. 
- 
  
    
      #list_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_v1_list_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListGroupPriorityOrderingResponse 
    
    
  
  
  
  
  
  
  
  
  
    Retrieve a group priority ordering for an app. 
- 
  
    
      #list_customer_policy_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListPolicySchemasResponse 
    
    
  
  
  
  
  
  
  
  
  
    Gets a list of policy schemas that match a specified filter value for a given customer. 
- 
  
    
      #resolve_customer_policy(customer, google_chrome_policy_v1_resolve_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ResolveResponse 
    
    
  
  
  
  
  
  
  
  
  
    Gets the resolved policy values for a list of policies that match a search query. 
- 
  
    
      #update_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_v1_update_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty 
    
    
  
  
  
  
  
  
  
  
  
    Update a group priority ordering for an app. 
- 
  
    
      #upload_medium(customer, google_chrome_policy_v1_upload_policy_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1UploadPolicyFileResponse 
    
    
  
  
  
  
  
  
  
  
  
    Creates an enterprise file from the content provided by user. 
Constructor Details
#initialize ⇒ ChromePolicyService
Returns a new instance of ChromePolicyService.
| 47 48 49 50 51 52 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 47 def initialize super('https://chromepolicy.googleapis.com/', '', client_name: 'google-apis-chromepolicy_v1', client_version: Google::Apis::ChromepolicyV1::GEM_VERSION) @batch_path = 'batch' end | 
Instance Attribute Details
#key ⇒ String
Returns 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.
| 40 41 42 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 40 def key @key end | 
#quota_user ⇒ String
Returns 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.
| 45 46 47 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 45 def quota_user @quota_user end | 
Instance Method Details
#batch_customer_policy_group_delete(customer, google_chrome_policy_v1_batch_delete_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
Delete multiple policy values that are applied to a specific group. All
targets must have the same target format. That is to say that they must point
to the same target resource and must have the same keys specified in 
additionalTargetKeyNames, though the values for those keys may be different.
On failure the request will return the error details as part of the google.rpc.
Status.
| 116 117 118 119 120 121 122 123 124 125 126 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 116 def batch_customer_policy_group_delete(customer, google_chrome_policy_v1_batch_delete_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+customer}/policies/groups:batchDelete', ) command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1BatchDeleteGroupPoliciesRequest::Representation command.request_object = google_chrome_policy_v1_batch_delete_group_policies_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end | 
#batch_customer_policy_group_modify(customer, google_chrome_policy_v1_batch_modify_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
Modify multiple policy values that are applied to a specific group. All
targets must have the same target format. That is to say that they must point
to the same target resource and must have the same keys specified in 
additionalTargetKeyNames, though the values for those keys may be different.
On failure the request will return the error details as part of the google.rpc.
Status.
| 155 156 157 158 159 160 161 162 163 164 165 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 155 def batch_customer_policy_group_modify(customer, google_chrome_policy_v1_batch_modify_group_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+customer}/policies/groups:batchModify', ) command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1BatchModifyGroupPoliciesRequest::Representation command.request_object = google_chrome_policy_v1_batch_modify_group_policies_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end | 
#batch_customer_policy_orgunit_inherit(customer, google_chrome_policy_v1_batch_inherit_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
Modify multiple policy values that are applied to a specific org unit so that
they now inherit the value from a parent (if applicable). All targets must
have the same target format. That is to say that they must point to the same
target resource and must have the same keys specified in 
additionalTargetKeyNames, though the values for those keys may be different.
On failure the request will return the error details as part of the google.rpc.
Status.
| 267 268 269 270 271 272 273 274 275 276 277 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 267 def batch_customer_policy_orgunit_inherit(customer, google_chrome_policy_v1_batch_inherit_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+customer}/policies/orgunits:batchInherit', ) command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1BatchInheritOrgUnitPoliciesRequest::Representation command.request_object = google_chrome_policy_v1_batch_inherit_org_unit_policies_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end | 
#batch_customer_policy_orgunit_modify(customer, google_chrome_policy_v1_batch_modify_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
Modify multiple policy values that are applied to a specific org unit. All
targets must have the same target format. That is to say that they must point
to the same target resource and must have the same keys specified in 
additionalTargetKeyNames, though the values for those keys may be different.
On failure the request will return the error details as part of the google.rpc.
Status.
| 306 307 308 309 310 311 312 313 314 315 316 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 306 def batch_customer_policy_orgunit_modify(customer, google_chrome_policy_v1_batch_modify_org_unit_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+customer}/policies/orgunits:batchModify', ) command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1BatchModifyOrgUnitPoliciesRequest::Representation command.request_object = google_chrome_policy_v1_batch_modify_org_unit_policies_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end | 
#get_customer_policy_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchema
Get a specific policy schema for a customer by its resource name.
| 338 339 340 341 342 343 344 345 346 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 338 def get_customer_policy_schema(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchema::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchema 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 | 
#list_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_v1_list_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListGroupPriorityOrderingResponse
Retrieve a group priority ordering for an app. The target app must be supplied
in additionalTargetKeyNames in the PolicyTargetKey. On failure the request
will return the error details as part of the google.rpc.Status.
| 191 192 193 194 195 196 197 198 199 200 201 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 191 def list_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_v1_list_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+customer}/policies/groups:listGroupPriorityOrdering', ) command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListGroupPriorityOrderingRequest::Representation command.request_object = google_chrome_policy_v1_list_group_priority_ordering_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListGroupPriorityOrderingResponse::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListGroupPriorityOrderingResponse command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end | 
#list_customer_policy_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListPolicySchemasResponse
Gets a list of policy schemas that match a specified filter value for a given customer.
| 376 377 378 379 380 381 382 383 384 385 386 387 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 376 def list_customer_policy_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/policySchemas', ) command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListPolicySchemasResponse::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ListPolicySchemasResponse 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 | 
#resolve_customer_policy(customer, google_chrome_policy_v1_resolve_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ResolveResponse
Gets the resolved policy values for a list of policies that match a search query.
| 77 78 79 80 81 82 83 84 85 86 87 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 77 def resolve_customer_policy(customer, google_chrome_policy_v1_resolve_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+customer}/policies:resolve', ) command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ResolveRequest::Representation command.request_object = google_chrome_policy_v1_resolve_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ResolveResponse::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1ResolveResponse command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end | 
#update_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_v1_update_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleProtobufEmpty
Update a group priority ordering for an app. The target app must be supplied
in additionalTargetKeyNames in the PolicyTargetKey. On failure the request
will return the error details as part of the google.rpc.Status.
| 227 228 229 230 231 232 233 234 235 236 237 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 227 def update_customer_policy_group_group_priority_ordering(customer, google_chrome_policy_v1_update_group_priority_ordering_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+customer}/policies/groups:updateGroupPriorityOrdering', ) command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1UpdateGroupPriorityOrderingRequest::Representation command.request_object = google_chrome_policy_v1_update_group_priority_ordering_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleProtobufEmpty command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end | 
#upload_medium(customer, google_chrome_policy_v1_upload_policy_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyV1UploadPolicyFileResponse
Creates an enterprise file from the content provided by user. Returns a public download url for end user.
| 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 | # File 'lib/google/apis/chromepolicy_v1/service.rb', line 415 def upload_medium(customer, google_chrome_policy_v1_upload_policy_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'v1/{+customer}/policies/files:uploadPolicyFile', ) else command = make_upload_command(:post, 'v1/{+customer}/policies/files:uploadPolicyFile', ) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1UploadPolicyFileRequest::Representation command.request_object = google_chrome_policy_v1_upload_policy_file_request_object command.response_representation = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1UploadPolicyFileResponse::Representation command.response_class = Google::Apis::ChromepolicyV1::GoogleChromePolicyV1UploadPolicyFileResponse command.params['customer'] = customer unless customer.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |