google-apis-analyticsadmin_v1alpha 0.45.0 → 0.47.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -238,8 +238,9 @@ module Google
238
238
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount] google_analytics_admin_v1alpha_account_object
239
239
  # @param [String] update_mask
240
240
  # Required. The list of fields to be updated. Field names must be in snake case (
241
- # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
242
- # entire entity, use one path with the string "*" to match all fields.
241
+ # for example, "field_to_update"). Omitted fields will not be updated. To
242
+ # replace the entire entity, use one path with the string "*" to match all
243
+ # fields.
243
244
  # @param [String] fields
244
245
  # Selector specifying which fields to include in a partial response.
245
246
  # @param [String] quota_user
@@ -334,6 +335,323 @@ module Google
334
335
  execute_or_queue_command(command, &block)
335
336
  end
336
337
 
338
+ # Creates information about multiple access bindings to an account or property.
339
+ # This method is transactional. If any AccessBinding cannot be created, none of
340
+ # the AccessBindings will be created.
341
+ # @param [String] parent
342
+ # Required. The account or property that owns the access bindings. The parent
343
+ # field in the CreateAccessBindingRequest messages must either be empty or match
344
+ # this field. Formats: - accounts/`account` - properties/`property`
345
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest] google_analytics_admin_v1alpha_batch_create_access_bindings_request_object
346
+ # @param [String] fields
347
+ # Selector specifying which fields to include in a partial response.
348
+ # @param [String] quota_user
349
+ # Available to use for quota purposes for server-side applications. Can be any
350
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
351
+ # @param [Google::Apis::RequestOptions] options
352
+ # Request-specific options
353
+ #
354
+ # @yield [result, err] Result & error if block supplied
355
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse] parsed result object
356
+ # @yieldparam err [StandardError] error object if request failed
357
+ #
358
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse]
359
+ #
360
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
361
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
362
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
363
+ def batch_account_access_binding_create(parent, google_analytics_admin_v1alpha_batch_create_access_bindings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
364
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings:batchCreate', options)
365
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest::Representation
366
+ command.request_object = google_analytics_admin_v1alpha_batch_create_access_bindings_request_object
367
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse::Representation
368
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse
369
+ command.params['parent'] = parent unless parent.nil?
370
+ command.query['fields'] = fields unless fields.nil?
371
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
372
+ execute_or_queue_command(command, &block)
373
+ end
374
+
375
+ # Deletes information about multiple users' links to an account or property.
376
+ # @param [String] parent
377
+ # Required. The account or property that owns the access bindings. The parent
378
+ # field in the DeleteAccessBindingRequest messages must either be empty or match
379
+ # this field. Formats: - accounts/`account` - properties/`property`
380
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest] google_analytics_admin_v1alpha_batch_delete_access_bindings_request_object
381
+ # @param [String] fields
382
+ # Selector specifying which fields to include in a partial response.
383
+ # @param [String] quota_user
384
+ # Available to use for quota purposes for server-side applications. Can be any
385
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
386
+ # @param [Google::Apis::RequestOptions] options
387
+ # Request-specific options
388
+ #
389
+ # @yield [result, err] Result & error if block supplied
390
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
391
+ # @yieldparam err [StandardError] error object if request failed
392
+ #
393
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
394
+ #
395
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
396
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
397
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
398
+ def batch_account_access_binding_delete(parent, google_analytics_admin_v1alpha_batch_delete_access_bindings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
399
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings:batchDelete', options)
400
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest::Representation
401
+ command.request_object = google_analytics_admin_v1alpha_batch_delete_access_bindings_request_object
402
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
403
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
404
+ command.params['parent'] = parent unless parent.nil?
405
+ command.query['fields'] = fields unless fields.nil?
406
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
407
+ execute_or_queue_command(command, &block)
408
+ end
409
+
410
+ # Gets information about multiple access bindings to an account or property.
411
+ # @param [String] parent
412
+ # Required. The account or property that owns the access bindings. The parent of
413
+ # all provided values for the 'names' field must match this field. Formats: -
414
+ # accounts/`account` - properties/`property`
415
+ # @param [Array<String>, String] names
416
+ # Required. The names of the access bindings to retrieve. A maximum of 1000
417
+ # access bindings can be retrieved in a batch. Formats: - accounts/`account`/
418
+ # accessBindings/`accessBinding` - properties/`property`/accessBindings/`
419
+ # accessBinding`
420
+ # @param [String] fields
421
+ # Selector specifying which fields to include in a partial response.
422
+ # @param [String] quota_user
423
+ # Available to use for quota purposes for server-side applications. Can be any
424
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
425
+ # @param [Google::Apis::RequestOptions] options
426
+ # Request-specific options
427
+ #
428
+ # @yield [result, err] Result & error if block supplied
429
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse] parsed result object
430
+ # @yieldparam err [StandardError] error object if request failed
431
+ #
432
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse]
433
+ #
434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
437
+ def batch_account_access_binding_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
438
+ command = make_simple_command(:get, 'v1alpha/{+parent}/accessBindings:batchGet', options)
439
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse::Representation
440
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse
441
+ command.params['parent'] = parent unless parent.nil?
442
+ command.query['names'] = names unless names.nil?
443
+ command.query['fields'] = fields unless fields.nil?
444
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
445
+ execute_or_queue_command(command, &block)
446
+ end
447
+
448
+ # Updates information about multiple access bindings to an account or property.
449
+ # @param [String] parent
450
+ # Required. The account or property that owns the access bindings. The parent
451
+ # field in the UpdateAccessBindingRequest messages must either be empty or match
452
+ # this field. Formats: - accounts/`account` - properties/`property`
453
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest] google_analytics_admin_v1alpha_batch_update_access_bindings_request_object
454
+ # @param [String] fields
455
+ # Selector specifying which fields to include in a partial response.
456
+ # @param [String] quota_user
457
+ # Available to use for quota purposes for server-side applications. Can be any
458
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
459
+ # @param [Google::Apis::RequestOptions] options
460
+ # Request-specific options
461
+ #
462
+ # @yield [result, err] Result & error if block supplied
463
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse] parsed result object
464
+ # @yieldparam err [StandardError] error object if request failed
465
+ #
466
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse]
467
+ #
468
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
469
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
470
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
471
+ def batch_account_access_binding_update(parent, google_analytics_admin_v1alpha_batch_update_access_bindings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
472
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings:batchUpdate', options)
473
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest::Representation
474
+ command.request_object = google_analytics_admin_v1alpha_batch_update_access_bindings_request_object
475
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse::Representation
476
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse
477
+ command.params['parent'] = parent unless parent.nil?
478
+ command.query['fields'] = fields unless fields.nil?
479
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
480
+ execute_or_queue_command(command, &block)
481
+ end
482
+
483
+ # Creates an access binding on an account or property.
484
+ # @param [String] parent
485
+ # Required. Formats: - accounts/`account` - properties/`property`
486
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] google_analytics_admin_v1alpha_access_binding_object
487
+ # @param [String] fields
488
+ # Selector specifying which fields to include in a partial response.
489
+ # @param [String] quota_user
490
+ # Available to use for quota purposes for server-side applications. Can be any
491
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
492
+ # @param [Google::Apis::RequestOptions] options
493
+ # Request-specific options
494
+ #
495
+ # @yield [result, err] Result & error if block supplied
496
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] parsed result object
497
+ # @yieldparam err [StandardError] error object if request failed
498
+ #
499
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding]
500
+ #
501
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
502
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
503
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
504
+ def create_account_access_binding(parent, google_analytics_admin_v1alpha_access_binding_object = nil, fields: nil, quota_user: nil, options: nil, &block)
505
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings', options)
506
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
507
+ command.request_object = google_analytics_admin_v1alpha_access_binding_object
508
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
509
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding
510
+ command.params['parent'] = parent unless parent.nil?
511
+ command.query['fields'] = fields unless fields.nil?
512
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
513
+ execute_or_queue_command(command, &block)
514
+ end
515
+
516
+ # Deletes an access binding on an account or property.
517
+ # @param [String] name
518
+ # Required. Formats: - accounts/`account`/accessBindings/`accessBinding` -
519
+ # properties/`property`/accessBindings/`accessBinding`
520
+ # @param [String] fields
521
+ # Selector specifying which fields to include in a partial response.
522
+ # @param [String] quota_user
523
+ # Available to use for quota purposes for server-side applications. Can be any
524
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
525
+ # @param [Google::Apis::RequestOptions] options
526
+ # Request-specific options
527
+ #
528
+ # @yield [result, err] Result & error if block supplied
529
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
530
+ # @yieldparam err [StandardError] error object if request failed
531
+ #
532
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
533
+ #
534
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
535
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
536
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
537
+ def delete_account_access_binding(name, fields: nil, quota_user: nil, options: nil, &block)
538
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
539
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
540
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
541
+ command.params['name'] = name unless name.nil?
542
+ command.query['fields'] = fields unless fields.nil?
543
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
544
+ execute_or_queue_command(command, &block)
545
+ end
546
+
547
+ # Gets information about an access binding.
548
+ # @param [String] name
549
+ # Required. The name of the access binding to retrieve. Formats: - accounts/`
550
+ # account`/accessBindings/`accessBinding` - properties/`property`/accessBindings/
551
+ # `accessBinding`
552
+ # @param [String] fields
553
+ # Selector specifying which fields to include in a partial response.
554
+ # @param [String] quota_user
555
+ # Available to use for quota purposes for server-side applications. Can be any
556
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
557
+ # @param [Google::Apis::RequestOptions] options
558
+ # Request-specific options
559
+ #
560
+ # @yield [result, err] Result & error if block supplied
561
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] parsed result object
562
+ # @yieldparam err [StandardError] error object if request failed
563
+ #
564
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding]
565
+ #
566
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
567
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
568
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
569
+ def get_account_access_binding(name, fields: nil, quota_user: nil, options: nil, &block)
570
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
571
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
572
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding
573
+ command.params['name'] = name unless name.nil?
574
+ command.query['fields'] = fields unless fields.nil?
575
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
576
+ execute_or_queue_command(command, &block)
577
+ end
578
+
579
+ # Lists all access bindings on an account or property.
580
+ # @param [String] parent
581
+ # Required. Formats: - accounts/`account` - properties/`property`
582
+ # @param [Fixnum] page_size
583
+ # The maximum number of access bindings to return. The service may return fewer
584
+ # than this value. If unspecified, at most 200 access bindings will be returned.
585
+ # The maximum value is 500; values above 500 will be coerced to 500.
586
+ # @param [String] page_token
587
+ # A page token, received from a previous `ListAccessBindings` call. Provide this
588
+ # to retrieve the subsequent page. When paginating, all other parameters
589
+ # provided to `ListAccessBindings` must match the call that provided the page
590
+ # token.
591
+ # @param [String] fields
592
+ # Selector specifying which fields to include in a partial response.
593
+ # @param [String] quota_user
594
+ # Available to use for quota purposes for server-side applications. Can be any
595
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
596
+ # @param [Google::Apis::RequestOptions] options
597
+ # Request-specific options
598
+ #
599
+ # @yield [result, err] Result & error if block supplied
600
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse] parsed result object
601
+ # @yieldparam err [StandardError] error object if request failed
602
+ #
603
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse]
604
+ #
605
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
606
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
607
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
608
+ def list_account_access_bindings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
609
+ command = make_simple_command(:get, 'v1alpha/{+parent}/accessBindings', options)
610
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse::Representation
611
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse
612
+ command.params['parent'] = parent unless parent.nil?
613
+ command.query['pageSize'] = page_size unless page_size.nil?
614
+ command.query['pageToken'] = page_token unless page_token.nil?
615
+ command.query['fields'] = fields unless fields.nil?
616
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
617
+ execute_or_queue_command(command, &block)
618
+ end
619
+
620
+ # Updates an access binding on an account or property.
621
+ # @param [String] name
622
+ # Output only. Resource name of this binding. Format: accounts/`account`/
623
+ # accessBindings/`access_binding` or properties/`property`/accessBindings/`
624
+ # access_binding` Example: "accounts/100/accessBindings/200"
625
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] google_analytics_admin_v1alpha_access_binding_object
626
+ # @param [String] fields
627
+ # Selector specifying which fields to include in a partial response.
628
+ # @param [String] quota_user
629
+ # Available to use for quota purposes for server-side applications. Can be any
630
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
631
+ # @param [Google::Apis::RequestOptions] options
632
+ # Request-specific options
633
+ #
634
+ # @yield [result, err] Result & error if block supplied
635
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] parsed result object
636
+ # @yieldparam err [StandardError] error object if request failed
637
+ #
638
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding]
639
+ #
640
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
641
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
642
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
643
+ def patch_account_access_binding(name, google_analytics_admin_v1alpha_access_binding_object = nil, fields: nil, quota_user: nil, options: nil, &block)
644
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
645
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
646
+ command.request_object = google_analytics_admin_v1alpha_access_binding_object
647
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
648
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding
649
+ command.params['name'] = name unless name.nil?
650
+ command.query['fields'] = fields unless fields.nil?
651
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
652
+ execute_or_queue_command(command, &block)
653
+ end
654
+
337
655
  # Lists all user links on an account or property, including implicit ones that
338
656
  # come from effective permissions granted by groups or organization admin roles.
339
657
  # If a returned user link does not have direct permissions, they cannot be
@@ -691,7 +1009,7 @@ module Google
691
1009
 
692
1010
  # Acknowledges the terms of user data collection for the specified property.
693
1011
  # This acknowledgement must be completed (either in the Google Analytics UI or
694
- # via this API) before MeasurementProtocolSecret resources may be created.
1012
+ # through this API) before MeasurementProtocolSecret resources may be created.
695
1013
  # @param [String] property
696
1014
  # Required. The property for which to acknowledge user data collection.
697
1015
  # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest] google_analytics_admin_v1alpha_acknowledge_user_data_collection_request_object
@@ -1235,6 +1553,323 @@ module Google
1235
1553
  execute_or_queue_command(command, &block)
1236
1554
  end
1237
1555
 
1556
+ # Creates information about multiple access bindings to an account or property.
1557
+ # This method is transactional. If any AccessBinding cannot be created, none of
1558
+ # the AccessBindings will be created.
1559
+ # @param [String] parent
1560
+ # Required. The account or property that owns the access bindings. The parent
1561
+ # field in the CreateAccessBindingRequest messages must either be empty or match
1562
+ # this field. Formats: - accounts/`account` - properties/`property`
1563
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest] google_analytics_admin_v1alpha_batch_create_access_bindings_request_object
1564
+ # @param [String] fields
1565
+ # Selector specifying which fields to include in a partial response.
1566
+ # @param [String] quota_user
1567
+ # Available to use for quota purposes for server-side applications. Can be any
1568
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1569
+ # @param [Google::Apis::RequestOptions] options
1570
+ # Request-specific options
1571
+ #
1572
+ # @yield [result, err] Result & error if block supplied
1573
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse] parsed result object
1574
+ # @yieldparam err [StandardError] error object if request failed
1575
+ #
1576
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse]
1577
+ #
1578
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1579
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1580
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1581
+ def batch_property_access_binding_create(parent, google_analytics_admin_v1alpha_batch_create_access_bindings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1582
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings:batchCreate', options)
1583
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest::Representation
1584
+ command.request_object = google_analytics_admin_v1alpha_batch_create_access_bindings_request_object
1585
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse::Representation
1586
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse
1587
+ command.params['parent'] = parent unless parent.nil?
1588
+ command.query['fields'] = fields unless fields.nil?
1589
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1590
+ execute_or_queue_command(command, &block)
1591
+ end
1592
+
1593
+ # Deletes information about multiple users' links to an account or property.
1594
+ # @param [String] parent
1595
+ # Required. The account or property that owns the access bindings. The parent
1596
+ # field in the DeleteAccessBindingRequest messages must either be empty or match
1597
+ # this field. Formats: - accounts/`account` - properties/`property`
1598
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest] google_analytics_admin_v1alpha_batch_delete_access_bindings_request_object
1599
+ # @param [String] fields
1600
+ # Selector specifying which fields to include in a partial response.
1601
+ # @param [String] quota_user
1602
+ # Available to use for quota purposes for server-side applications. Can be any
1603
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1604
+ # @param [Google::Apis::RequestOptions] options
1605
+ # Request-specific options
1606
+ #
1607
+ # @yield [result, err] Result & error if block supplied
1608
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1609
+ # @yieldparam err [StandardError] error object if request failed
1610
+ #
1611
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1612
+ #
1613
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1614
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1615
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1616
+ def batch_property_access_binding_delete(parent, google_analytics_admin_v1alpha_batch_delete_access_bindings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1617
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings:batchDelete', options)
1618
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest::Representation
1619
+ command.request_object = google_analytics_admin_v1alpha_batch_delete_access_bindings_request_object
1620
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1621
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1622
+ command.params['parent'] = parent unless parent.nil?
1623
+ command.query['fields'] = fields unless fields.nil?
1624
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1625
+ execute_or_queue_command(command, &block)
1626
+ end
1627
+
1628
+ # Gets information about multiple access bindings to an account or property.
1629
+ # @param [String] parent
1630
+ # Required. The account or property that owns the access bindings. The parent of
1631
+ # all provided values for the 'names' field must match this field. Formats: -
1632
+ # accounts/`account` - properties/`property`
1633
+ # @param [Array<String>, String] names
1634
+ # Required. The names of the access bindings to retrieve. A maximum of 1000
1635
+ # access bindings can be retrieved in a batch. Formats: - accounts/`account`/
1636
+ # accessBindings/`accessBinding` - properties/`property`/accessBindings/`
1637
+ # accessBinding`
1638
+ # @param [String] fields
1639
+ # Selector specifying which fields to include in a partial response.
1640
+ # @param [String] quota_user
1641
+ # Available to use for quota purposes for server-side applications. Can be any
1642
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1643
+ # @param [Google::Apis::RequestOptions] options
1644
+ # Request-specific options
1645
+ #
1646
+ # @yield [result, err] Result & error if block supplied
1647
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse] parsed result object
1648
+ # @yieldparam err [StandardError] error object if request failed
1649
+ #
1650
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse]
1651
+ #
1652
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1653
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1654
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1655
+ def batch_property_access_binding_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
1656
+ command = make_simple_command(:get, 'v1alpha/{+parent}/accessBindings:batchGet', options)
1657
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse::Representation
1658
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse
1659
+ command.params['parent'] = parent unless parent.nil?
1660
+ command.query['names'] = names unless names.nil?
1661
+ command.query['fields'] = fields unless fields.nil?
1662
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1663
+ execute_or_queue_command(command, &block)
1664
+ end
1665
+
1666
+ # Updates information about multiple access bindings to an account or property.
1667
+ # @param [String] parent
1668
+ # Required. The account or property that owns the access bindings. The parent
1669
+ # field in the UpdateAccessBindingRequest messages must either be empty or match
1670
+ # this field. Formats: - accounts/`account` - properties/`property`
1671
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest] google_analytics_admin_v1alpha_batch_update_access_bindings_request_object
1672
+ # @param [String] fields
1673
+ # Selector specifying which fields to include in a partial response.
1674
+ # @param [String] quota_user
1675
+ # Available to use for quota purposes for server-side applications. Can be any
1676
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1677
+ # @param [Google::Apis::RequestOptions] options
1678
+ # Request-specific options
1679
+ #
1680
+ # @yield [result, err] Result & error if block supplied
1681
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse] parsed result object
1682
+ # @yieldparam err [StandardError] error object if request failed
1683
+ #
1684
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse]
1685
+ #
1686
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1687
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1688
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1689
+ def batch_property_access_binding_update(parent, google_analytics_admin_v1alpha_batch_update_access_bindings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1690
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings:batchUpdate', options)
1691
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest::Representation
1692
+ command.request_object = google_analytics_admin_v1alpha_batch_update_access_bindings_request_object
1693
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse::Representation
1694
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse
1695
+ command.params['parent'] = parent unless parent.nil?
1696
+ command.query['fields'] = fields unless fields.nil?
1697
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1698
+ execute_or_queue_command(command, &block)
1699
+ end
1700
+
1701
+ # Creates an access binding on an account or property.
1702
+ # @param [String] parent
1703
+ # Required. Formats: - accounts/`account` - properties/`property`
1704
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] google_analytics_admin_v1alpha_access_binding_object
1705
+ # @param [String] fields
1706
+ # Selector specifying which fields to include in a partial response.
1707
+ # @param [String] quota_user
1708
+ # Available to use for quota purposes for server-side applications. Can be any
1709
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1710
+ # @param [Google::Apis::RequestOptions] options
1711
+ # Request-specific options
1712
+ #
1713
+ # @yield [result, err] Result & error if block supplied
1714
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] parsed result object
1715
+ # @yieldparam err [StandardError] error object if request failed
1716
+ #
1717
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding]
1718
+ #
1719
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1720
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1721
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1722
+ def create_property_access_binding(parent, google_analytics_admin_v1alpha_access_binding_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1723
+ command = make_simple_command(:post, 'v1alpha/{+parent}/accessBindings', options)
1724
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
1725
+ command.request_object = google_analytics_admin_v1alpha_access_binding_object
1726
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
1727
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding
1728
+ command.params['parent'] = parent unless parent.nil?
1729
+ command.query['fields'] = fields unless fields.nil?
1730
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1731
+ execute_or_queue_command(command, &block)
1732
+ end
1733
+
1734
+ # Deletes an access binding on an account or property.
1735
+ # @param [String] name
1736
+ # Required. Formats: - accounts/`account`/accessBindings/`accessBinding` -
1737
+ # properties/`property`/accessBindings/`accessBinding`
1738
+ # @param [String] fields
1739
+ # Selector specifying which fields to include in a partial response.
1740
+ # @param [String] quota_user
1741
+ # Available to use for quota purposes for server-side applications. Can be any
1742
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1743
+ # @param [Google::Apis::RequestOptions] options
1744
+ # Request-specific options
1745
+ #
1746
+ # @yield [result, err] Result & error if block supplied
1747
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
1748
+ # @yieldparam err [StandardError] error object if request failed
1749
+ #
1750
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
1751
+ #
1752
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1753
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1754
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1755
+ def delete_property_access_binding(name, fields: nil, quota_user: nil, options: nil, &block)
1756
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1757
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
1758
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
1759
+ command.params['name'] = name unless name.nil?
1760
+ command.query['fields'] = fields unless fields.nil?
1761
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1762
+ execute_or_queue_command(command, &block)
1763
+ end
1764
+
1765
+ # Gets information about an access binding.
1766
+ # @param [String] name
1767
+ # Required. The name of the access binding to retrieve. Formats: - accounts/`
1768
+ # account`/accessBindings/`accessBinding` - properties/`property`/accessBindings/
1769
+ # `accessBinding`
1770
+ # @param [String] fields
1771
+ # Selector specifying which fields to include in a partial response.
1772
+ # @param [String] quota_user
1773
+ # Available to use for quota purposes for server-side applications. Can be any
1774
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1775
+ # @param [Google::Apis::RequestOptions] options
1776
+ # Request-specific options
1777
+ #
1778
+ # @yield [result, err] Result & error if block supplied
1779
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] parsed result object
1780
+ # @yieldparam err [StandardError] error object if request failed
1781
+ #
1782
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding]
1783
+ #
1784
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1785
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1786
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1787
+ def get_property_access_binding(name, fields: nil, quota_user: nil, options: nil, &block)
1788
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
1789
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
1790
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding
1791
+ command.params['name'] = name unless name.nil?
1792
+ command.query['fields'] = fields unless fields.nil?
1793
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1794
+ execute_or_queue_command(command, &block)
1795
+ end
1796
+
1797
+ # Lists all access bindings on an account or property.
1798
+ # @param [String] parent
1799
+ # Required. Formats: - accounts/`account` - properties/`property`
1800
+ # @param [Fixnum] page_size
1801
+ # The maximum number of access bindings to return. The service may return fewer
1802
+ # than this value. If unspecified, at most 200 access bindings will be returned.
1803
+ # The maximum value is 500; values above 500 will be coerced to 500.
1804
+ # @param [String] page_token
1805
+ # A page token, received from a previous `ListAccessBindings` call. Provide this
1806
+ # to retrieve the subsequent page. When paginating, all other parameters
1807
+ # provided to `ListAccessBindings` must match the call that provided the page
1808
+ # token.
1809
+ # @param [String] fields
1810
+ # Selector specifying which fields to include in a partial response.
1811
+ # @param [String] quota_user
1812
+ # Available to use for quota purposes for server-side applications. Can be any
1813
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1814
+ # @param [Google::Apis::RequestOptions] options
1815
+ # Request-specific options
1816
+ #
1817
+ # @yield [result, err] Result & error if block supplied
1818
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse] parsed result object
1819
+ # @yieldparam err [StandardError] error object if request failed
1820
+ #
1821
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse]
1822
+ #
1823
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1824
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1825
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1826
+ def list_property_access_bindings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1827
+ command = make_simple_command(:get, 'v1alpha/{+parent}/accessBindings', options)
1828
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse::Representation
1829
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccessBindingsResponse
1830
+ command.params['parent'] = parent unless parent.nil?
1831
+ command.query['pageSize'] = page_size unless page_size.nil?
1832
+ command.query['pageToken'] = page_token unless page_token.nil?
1833
+ command.query['fields'] = fields unless fields.nil?
1834
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1835
+ execute_or_queue_command(command, &block)
1836
+ end
1837
+
1838
+ # Updates an access binding on an account or property.
1839
+ # @param [String] name
1840
+ # Output only. Resource name of this binding. Format: accounts/`account`/
1841
+ # accessBindings/`access_binding` or properties/`property`/accessBindings/`
1842
+ # access_binding` Example: "accounts/100/accessBindings/200"
1843
+ # @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] google_analytics_admin_v1alpha_access_binding_object
1844
+ # @param [String] fields
1845
+ # Selector specifying which fields to include in a partial response.
1846
+ # @param [String] quota_user
1847
+ # Available to use for quota purposes for server-side applications. Can be any
1848
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1849
+ # @param [Google::Apis::RequestOptions] options
1850
+ # Request-specific options
1851
+ #
1852
+ # @yield [result, err] Result & error if block supplied
1853
+ # @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding] parsed result object
1854
+ # @yieldparam err [StandardError] error object if request failed
1855
+ #
1856
+ # @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding]
1857
+ #
1858
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1859
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1860
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1861
+ def patch_property_access_binding(name, google_analytics_admin_v1alpha_access_binding_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1862
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
1863
+ command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
1864
+ command.request_object = google_analytics_admin_v1alpha_access_binding_object
1865
+ command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding::Representation
1866
+ command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccessBinding
1867
+ command.params['name'] = name unless name.nil?
1868
+ command.query['fields'] = fields unless fields.nil?
1869
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1870
+ execute_or_queue_command(command, &block)
1871
+ end
1872
+
1238
1873
  # Archives an Audience on a property.
1239
1874
  # @param [String] name
1240
1875
  # Required. Example format: properties/1234/audiences/5678