Class: Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client

Inherits:

Object

Object
Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client

show all

Includes:: Paths

Defined in:: lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb

Overview

Client for the AnalyticsAdminService service.

Service Interface for the Analytics Admin API (GA4).

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

.configure {|config| ... } ⇒ Client::Configuration
Configure the AnalyticsAdminService Client class.

Instance Method Summary collapse

#approve_display_video360_advertiser_link_proposal(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse
Approves a DisplayVideo360AdvertiserLinkProposal.
#archive_custom_dimension(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Archives a CustomDimension on a property.
#archive_custom_metric(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Archives a CustomMetric on a property.
#audit_user_links(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>
Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.
#batch_create_user_links(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse
Creates information about multiple users' links to an account or property.
#batch_delete_user_links(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes information about multiple users' links to an account or property.
#batch_get_user_links(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse
Gets information about multiple users' links to an account or property.
#batch_update_user_links(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse
Updates information about multiple users' links to an account or property.
#cancel_display_video360_advertiser_link_proposal(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal
Cancels a DisplayVideo360AdvertiserLinkProposal.
#configure {|config| ... } ⇒ Client::Configuration
Configure the AnalyticsAdminService Client instance.
#create_conversion_event(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent
Creates a conversion event with the specified attributes.
#create_custom_dimension(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension
Creates a CustomDimension.
#create_custom_metric(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric
Creates a CustomMetric.
#create_display_video360_advertiser_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink
Creates a DisplayVideo360AdvertiserLink.
#create_display_video360_advertiser_link_proposal(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal
Creates a DisplayVideo360AdvertiserLinkProposal.
#create_firebase_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::FirebaseLink
Creates a FirebaseLink.
#create_google_ads_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink
Creates a GoogleAdsLink.
#create_measurement_protocol_secret(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
Creates a measurement protocol secret.
#create_property(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Creates an "GA4" property with the specified location and attributes.
#create_user_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::UserLink
Creates a user link on an account or property.
#create_web_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream
Creates a web stream with the specified location and attributes.
#delete_account(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Marks target Account as soft-deleted (ie: "trashed") and returns it.
#delete_android_app_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an android app stream on a property.
#delete_conversion_event(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a conversion event in a property.
#delete_display_video360_advertiser_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a DisplayVideo360AdvertiserLink on a property.
#delete_display_video360_advertiser_link_proposal(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
#delete_firebase_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a FirebaseLink on a property.
#delete_google_ads_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a GoogleAdsLink on a property.
#delete_ios_app_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an iOS app stream on a property.
#delete_measurement_protocol_secret(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes target MeasurementProtocolSecret.
#delete_property(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Marks target Property as soft-deleted (ie: "trashed") and returns it.
#delete_user_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a user link on an account or property.
#delete_web_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a web stream on a property.
#get_account(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Account
Lookup for a single Account.
#get_android_app_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
Lookup for a single AndroidAppDataStream.
#get_conversion_event(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent
Retrieve a single conversion event.
#get_custom_dimension(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension
Lookup for a single CustomDimension.
#get_custom_metric(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric
Lookup for a single CustomMetric.
#get_data_retention_settings(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings
Returns the singleton data retention settings for this property.
#get_data_sharing_settings(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataSharingSettings
Get data sharing settings on an account.
#get_display_video360_advertiser_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink
Look up a single DisplayVideo360AdvertiserLink.
#get_display_video360_advertiser_link_proposal(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
#get_enhanced_measurement_settings(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
Returns the singleton enhanced measurement settings for this web stream.
#get_global_site_tag(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GlobalSiteTag
Returns the Site Tag for the specified web stream.
#get_google_signals_settings(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings
Lookup for Google Signals settings for a property.
#get_ios_app_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream
Lookup for a single IosAppDataStream.
#get_measurement_protocol_secret(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
Lookup for a single "GA4" MeasurementProtocolSecret.
#get_property(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Lookup for a single "GA4" Property.
#get_user_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::UserLink
Gets information about a user's link to an account or property.
#get_web_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream
Lookup for a single WebDataStream.
#initialize {|config| ... } ⇒ Client constructor
Create a new AnalyticsAdminService client object.
#list_account_summaries(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>
Returns summaries of all accounts accessible by the caller.
#list_accounts(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>
Returns all accounts accessible by the caller.
#list_android_app_data_streams(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>
Returns child android app streams under the specified parent property.
#list_conversion_events(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>
Returns a list of conversion events in the specified parent property.
#list_custom_dimensions(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>
Lists CustomDimensions on a property.
#list_custom_metrics(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>
Lists CustomMetrics on a property.
#list_display_video360_advertiser_link_proposals(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>
Lists DisplayVideo360AdvertiserLinkProposals on a property.
#list_display_video360_advertiser_links(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>
Lists all DisplayVideo360AdvertiserLinks on a property.
#list_firebase_links(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>
Lists FirebaseLinks on a property.
#list_google_ads_links(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>
Lists GoogleAdsLinks on a property.
#list_ios_app_data_streams(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>
Returns child iOS app data streams under the specified parent property.
#list_measurement_protocol_secrets(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>
Returns child MeasurementProtocolSecrets under the specified parent Property.
#list_properties(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>
Returns child Properties under the specified parent Account.
#list_user_links(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>
Lists all user links on an account or property.
#list_web_data_streams(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>
Returns child web data streams under the specified parent property.
#provision_account_ticket(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse
Requests a ticket for creating an account.
#search_change_history_events(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>
Searches through all changes to an account or its children given the specified set of filters.
#update_account(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Account
Updates an account.
#update_android_app_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream
Updates an android app stream on a property.
#update_custom_dimension(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension
Updates a CustomDimension on a property.
#update_custom_metric(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric
Updates a CustomMetric on a property.
#update_data_retention_settings(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings
Updates the singleton data retention settings for this property.
#update_display_video360_advertiser_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink
Updates a DisplayVideo360AdvertiserLink on a property.
#update_enhanced_measurement_settings(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
Updates the singleton enhanced measurement settings for this web stream.
#update_google_ads_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink
Updates a GoogleAdsLink on a property.
#update_google_signals_settings(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings
Updates Google Signals settings for a property.
#update_ios_app_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream
Updates an iOS app stream on a property.
#update_measurement_protocol_secret(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
Updates a measurement protocol secret.
#update_property(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Updates a property.
#update_user_link(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::UserLink
Updates a user link on an account or property.
#update_web_data_stream(request, options = nil) {|response, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream
Updates a web stream on a property.

Methods included from Paths

#account_path, #android_app_data_stream_path, #conversion_event_path, #custom_dimension_path, #custom_metric_path, #data_retention_settings_path, #data_sharing_settings_path, #display_video360_advertiser_link_path, #display_video360_advertiser_link_proposal_path, #enhanced_measurement_settings_path, #firebase_link_path, #global_site_tag_path, #google_ads_link_path, #google_signals_settings_path, #ios_app_data_stream_path, #measurement_protocol_secret_path, #property_path, #user_link_path, #web_data_stream_path

Constructor Details

#initialize {|config| ... } ⇒ `Client`

Create a new AnalyticsAdminService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a client using a custom configuration
client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the AnalyticsAdminService client.

Yield Parameters:

config (Client::Configuration)

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 198

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/analytics/admin/v1alpha/analytics_admin_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @analytics_admin_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ `Client::Configuration`

Configure the AnalyticsAdminService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all AnalyticsAdminService clients
::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 56

def self.configure
  @configure ||= begin
    namespace = ["Google", "Analytics", "Admin", "V1alpha"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.get_account.timeout = 60.0

    default_config.rpcs.list_accounts.timeout = 60.0

    default_config.rpcs.delete_account.timeout = 60.0

    default_config.rpcs.update_account.timeout = 60.0

    default_config.rpcs.provision_account_ticket.timeout = 60.0

    default_config.rpcs.get_property.timeout = 60.0

    default_config.rpcs.list_properties.timeout = 60.0

    default_config.rpcs.create_property.timeout = 60.0

    default_config.rpcs.delete_property.timeout = 60.0

    default_config.rpcs.update_property.timeout = 60.0

    default_config.rpcs.get_user_link.timeout = 60.0

    default_config.rpcs.batch_get_user_links.timeout = 60.0

    default_config.rpcs.list_user_links.timeout = 60.0

    default_config.rpcs.audit_user_links.timeout = 60.0

    default_config.rpcs.create_user_link.timeout = 60.0

    default_config.rpcs.batch_create_user_links.timeout = 60.0

    default_config.rpcs.update_user_link.timeout = 60.0

    default_config.rpcs.batch_update_user_links.timeout = 60.0

    default_config.rpcs.delete_user_link.timeout = 60.0

    default_config.rpcs.batch_delete_user_links.timeout = 60.0

    default_config.rpcs.get_web_data_stream.timeout = 60.0

    default_config.rpcs.update_web_data_stream.timeout = 60.0

    default_config.rpcs.create_web_data_stream.timeout = 60.0

    default_config.rpcs.list_web_data_streams.timeout = 60.0

    default_config.rpcs.get_ios_app_data_stream.timeout = 60.0

    default_config.rpcs.delete_ios_app_data_stream.timeout = 60.0

    default_config.rpcs.update_ios_app_data_stream.timeout = 60.0

    default_config.rpcs.list_ios_app_data_streams.timeout = 60.0

    default_config.rpcs.get_android_app_data_stream.timeout = 60.0

    default_config.rpcs.delete_android_app_data_stream.timeout = 60.0

    default_config.rpcs.update_android_app_data_stream.timeout = 60.0

    default_config.rpcs.list_android_app_data_streams.timeout = 60.0

    default_config.rpcs.get_enhanced_measurement_settings.timeout = 60.0

    default_config.rpcs.update_enhanced_measurement_settings.timeout = 60.0

    default_config.rpcs.create_firebase_link.timeout = 60.0

    default_config.rpcs.delete_firebase_link.timeout = 60.0

    default_config.rpcs.list_firebase_links.timeout = 60.0

    default_config.rpcs.get_global_site_tag.timeout = 60.0

    default_config.rpcs.create_google_ads_link.timeout = 60.0

    default_config.rpcs.update_google_ads_link.timeout = 60.0

    default_config.rpcs.delete_google_ads_link.timeout = 60.0

    default_config.rpcs.list_google_ads_links.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#approve_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse` #approve_display_video360_advertiser_link_proposal(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse`

Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalRequest.new

# Call the approve_display_video360_advertiser_link_proposal method.
result = client.approve_display_video360_advertiser_link_proposal request

# The returned object is of type Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse.
p result

Overloads:

#approve_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse

Pass arguments to approve_display_video360_advertiser_link_proposal via a request object, either of type Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#approve_display_video360_advertiser_link_proposal(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse

Pass arguments to approve_display_video360_advertiser_link_proposal via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6372

def approve_display_video360_advertiser_link_proposal request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.approve_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.approve_display_video360_advertiser_link_proposal.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.approve_display_video360_advertiser_link_proposal.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :approve_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#archive_custom_dimension(request, options = nil) ⇒ `::Google::Protobuf::Empty` #archive_custom_dimension(name: nil) ⇒ `::Google::Protobuf::Empty`

Archives a CustomDimension on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest.new

# Call the archive_custom_dimension method.
result = client.archive_custom_dimension request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#archive_custom_dimension(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to archive_custom_dimension via a request object, either of type Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#archive_custom_dimension(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to archive_custom_dimension via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6826

def archive_custom_dimension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomDimensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.archive_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.archive_custom_dimension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.archive_custom_dimension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :archive_custom_dimension, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#archive_custom_metric(request, options = nil) ⇒ `::Google::Protobuf::Empty` #archive_custom_metric(name: nil) ⇒ `::Google::Protobuf::Empty`

Archives a CustomMetric on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest.new

# Call the archive_custom_metric method.
result = client.archive_custom_metric request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#archive_custom_metric(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to archive_custom_metric via a request object, either of type Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#archive_custom_metric(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to archive_custom_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 7276

def archive_custom_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ArchiveCustomMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.archive_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.archive_custom_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.archive_custom_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :archive_custom_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#audit_user_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>` #audit_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>`

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.

If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::AuditUserLinksRequest.new

# Call the audit_user_links method.
result = client.audit_user_links request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::AuditUserLink.
  p response
end

Overloads:

#audit_user_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>

Pass arguments to audit_user_links via a request object, either of type Google::Analytics::Admin::V1alpha::AuditUserLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::AuditUserLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#audit_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>

Pass arguments to audit_user_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: accounts/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous AuditUserLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to AuditUserLinks must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1597

def audit_user_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::AuditUserLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.audit_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.audit_user_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.audit_user_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :audit_user_links, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :audit_user_links, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_create_user_links(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse` #batch_create_user_links(parent: nil, notify_new_users: nil, requests: nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse`

Creates information about multiple users' links to an account or property.

This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest.new

# Call the batch_create_user_links method.
result = client.batch_create_user_links request

# The returned object is of type Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse.
p result

Overloads:

#batch_create_user_links(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse

Pass arguments to batch_create_user_links via a request object, either of type BatchCreateUserLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#batch_create_user_links(parent: nil, notify_new_users: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse

Pass arguments to batch_create_user_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234
- notify_new_users (::Boolean) (defaults to: nil) —
  Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.
- requests (::Array<::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash>) (defaults to: nil) —
  Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1790

def batch_create_user_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_create_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_create_user_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_create_user_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :batch_create_user_links, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_delete_user_links(request, options = nil) ⇒ `::Google::Protobuf::Empty` #batch_delete_user_links(parent: nil, requests: nil) ⇒ `::Google::Protobuf::Empty`

Deletes information about multiple users' links to an account or property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest.new

# Call the batch_delete_user_links method.
result = client.batch_delete_user_links request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#batch_delete_user_links(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to batch_delete_user_links via a request object, either of type BatchDeleteUserLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#batch_delete_user_links(parent: nil, requests: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to batch_delete_user_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234
- requests (::Array<::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash>) (defaults to: nil) —
  Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2142

def batch_delete_user_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchDeleteUserLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_delete_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_delete_user_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_delete_user_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :batch_delete_user_links, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_get_user_links(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse` #batch_get_user_links(parent: nil, names: nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse`

Gets information about multiple users' links to an account or property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::BatchGetUserLinksRequest.new

# Call the batch_get_user_links method.
result = client.batch_get_user_links request

# The returned object is of type Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse.
p result

Overloads:

#batch_get_user_links(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse

Pass arguments to batch_get_user_links via a request object, either of type BatchGetUserLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchGetUserLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#batch_get_user_links(parent: nil, names: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse

Pass arguments to batch_get_user_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234
- names (::Array<::String>) (defaults to: nil) —
  Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1386

def batch_get_user_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_get_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_get_user_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_get_user_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :batch_get_user_links, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_update_user_links(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse` #batch_update_user_links(parent: nil, requests: nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse`

Updates information about multiple users' links to an account or property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest.new

# Call the batch_update_user_links method.
result = client.batch_update_user_links request

# The returned object is of type Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse.
p result

Overloads:

#batch_update_user_links(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse

Pass arguments to batch_update_user_links via a request object, either of type BatchUpdateUserLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#batch_update_user_links(parent: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse

Pass arguments to batch_update_user_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234
- requests (::Array<::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash>) (defaults to: nil) —
  Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1966

def batch_update_user_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_update_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_update_user_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_update_user_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :batch_update_user_links, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal` #cancel_display_video360_advertiser_link_proposal(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal`

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either:

Declining a proposal initiated from Display & Video 360
Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CancelDisplayVideo360AdvertiserLinkProposalRequest.new

# Call the cancel_display_video360_advertiser_link_proposal method.
result = client.cancel_display_video360_advertiser_link_proposal request

# The returned object is of type Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal.
p result

Overloads:

#cancel_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

Pass arguments to cancel_display_video360_advertiser_link_proposal via a request object, either of type CancelDisplayVideo360AdvertiserLinkProposalRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CancelDisplayVideo360AdvertiserLinkProposalRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#cancel_display_video360_advertiser_link_proposal(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

Pass arguments to cancel_display_video360_advertiser_link_proposal via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6462

def cancel_display_video360_advertiser_link_proposal request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CancelDisplayVideo360AdvertiserLinkProposalRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_display_video360_advertiser_link_proposal.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_display_video360_advertiser_link_proposal.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :cancel_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ `Client::Configuration`

Configure the AnalyticsAdminService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 177

def configure
  yield @config if block_given?
  @config
end

#create_conversion_event(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent` #create_conversion_event(conversion_event: nil, parent: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent`

Creates a conversion event with the specified attributes.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateConversionEventRequest.new

# Call the create_conversion_event method.
result = client.create_conversion_event request

# The returned object is of type Google::Analytics::Admin::V1alpha::ConversionEvent.
p result

Overloads:

#create_conversion_event(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent

Pass arguments to create_conversion_event via a request object, either of type CreateConversionEventRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_conversion_event(conversion_event: nil, parent: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent

Pass arguments to create_conversion_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- conversion_event (::Google::Analytics::Admin::V1alpha::ConversionEvent, ::Hash) (defaults to: nil) —
  Required. The conversion event to create.
- parent (::String) (defaults to: nil) —
  Required. The resource name of the parent property where this conversion event will be created. Format: properties/123

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::ConversionEvent)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::ConversionEvent)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5187

def create_conversion_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateConversionEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_conversion_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_conversion_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_conversion_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_conversion_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_custom_dimension(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension` #create_custom_dimension(parent: nil, custom_dimension: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension`

Creates a CustomDimension.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest.new

# Call the create_custom_dimension method.
result = client.create_custom_dimension request

# The returned object is of type Google::Analytics::Admin::V1alpha::CustomDimension.
p result

Overloads:

#create_custom_dimension(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

Pass arguments to create_custom_dimension via a request object, either of type CreateCustomDimensionRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_custom_dimension(parent: nil, custom_dimension: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

Pass arguments to create_custom_dimension via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- custom_dimension (::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash) (defaults to: nil) —
  Required. The CustomDimension to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::CustomDimension)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::CustomDimension)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6549

def create_custom_dimension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomDimensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_custom_dimension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_custom_dimension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_custom_dimension, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_custom_metric(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric` #create_custom_metric(parent: nil, custom_metric: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric`

Creates a CustomMetric.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest.new

# Call the create_custom_metric method.
result = client.create_custom_metric request

# The returned object is of type Google::Analytics::Admin::V1alpha::CustomMetric.
p result

Overloads:

#create_custom_metric(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

Pass arguments to create_custom_metric via a request object, either of type CreateCustomMetricRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_custom_metric(parent: nil, custom_metric: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

Pass arguments to create_custom_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- custom_metric (::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash) (defaults to: nil) —
  Required. The CustomMetric to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::CustomMetric)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::CustomMetric)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6999

def create_custom_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateCustomMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_custom_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_custom_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_custom_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_display_video360_advertiser_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink` #create_display_video360_advertiser_link(parent: nil, display_video_360_advertiser_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink`

Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkRequest.new

# Call the create_display_video360_advertiser_link method.
result = client.create_display_video360_advertiser_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink.
p result

Overloads:

#create_display_video360_advertiser_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink

Pass arguments to create_display_video360_advertiser_link via a request object, either of type CreateDisplayVideo360AdvertiserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_display_video360_advertiser_link(parent: nil, display_video_360_advertiser_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink

Pass arguments to create_display_video360_advertiser_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- display_video_360_advertiser_link (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink, ::Hash) (defaults to: nil) —
  Required. The DisplayVideo360AdvertiserLink to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5745

def create_display_video360_advertiser_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_display_video360_advertiser_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_display_video360_advertiser_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_display_video360_advertiser_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal` #create_display_video360_advertiser_link_proposal(parent: nil, display_video_360_advertiser_link_proposal: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal`

Creates a DisplayVideo360AdvertiserLinkProposal.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkProposalRequest.new

# Call the create_display_video360_advertiser_link_proposal method.
result = client.create_display_video360_advertiser_link_proposal request

# The returned object is of type Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal.
p result

Overloads:

#create_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

Pass arguments to create_display_video360_advertiser_link_proposal via a request object, either of type CreateDisplayVideo360AdvertiserLinkProposalRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkProposalRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_display_video360_advertiser_link_proposal(parent: nil, display_video_360_advertiser_link_proposal: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

Pass arguments to create_display_video360_advertiser_link_proposal via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- display_video_360_advertiser_link_proposal (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal, ::Hash) (defaults to: nil) —
  Required. The DisplayVideo360AdvertiserLinkProposal to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6197

def create_display_video360_advertiser_link_proposal request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateDisplayVideo360AdvertiserLinkProposalRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_display_video360_advertiser_link_proposal.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_display_video360_advertiser_link_proposal.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_firebase_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::FirebaseLink` #create_firebase_link(parent: nil, firebase_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::FirebaseLink`

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateFirebaseLinkRequest.new

# Call the create_firebase_link method.
result = client.create_firebase_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::FirebaseLink.
p result

Overloads:

#create_firebase_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::FirebaseLink

Pass arguments to create_firebase_link via a request object, either of type CreateFirebaseLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateFirebaseLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_firebase_link(parent: nil, firebase_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::FirebaseLink

Pass arguments to create_firebase_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Format: properties/{property_id} Example: properties/1234
- firebase_link (::Google::Analytics::Admin::V1alpha::FirebaseLink, ::Hash) (defaults to: nil) —
  Required. The Firebase link to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::FirebaseLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::FirebaseLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3614

def create_firebase_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateFirebaseLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_firebase_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_firebase_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_firebase_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_firebase_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_google_ads_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink` #create_google_ads_link(parent: nil, google_ads_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink`

Creates a GoogleAdsLink.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateGoogleAdsLinkRequest.new

# Call the create_google_ads_link method.
result = client.create_google_ads_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::GoogleAdsLink.
p result

Overloads:

#create_google_ads_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink

Pass arguments to create_google_ads_link via a request object, either of type CreateGoogleAdsLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateGoogleAdsLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_google_ads_link(parent: nil, google_ads_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink

Pass arguments to create_google_ads_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- google_ads_link (::Google::Analytics::Admin::V1alpha::GoogleAdsLink, ::Hash) (defaults to: nil) —
  Required. The GoogleAdsLink to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::GoogleAdsLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::GoogleAdsLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3980

def create_google_ads_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateGoogleAdsLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_google_ads_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_google_ads_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_google_ads_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_google_ads_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret` #create_measurement_protocol_secret(parent: nil, measurement_protocol_secret: nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret`

Creates a measurement protocol secret.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest.new

# Call the create_measurement_protocol_secret method.
result = client.create_measurement_protocol_secret request

# The returned object is of type Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret.
p result

Overloads:

#create_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

Pass arguments to create_measurement_protocol_secret via a request object, either of type CreateMeasurementProtocolSecretRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_measurement_protocol_secret(parent: nil, measurement_protocol_secret: nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

Pass arguments to create_measurement_protocol_secret via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The parent resource where this secret will be created. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}
- measurement_protocol_secret (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash) (defaults to: nil) —
  Required. The measurement protocol secret to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4629

def create_measurement_protocol_secret request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateMeasurementProtocolSecretRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_measurement_protocol_secret.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_measurement_protocol_secret.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_measurement_protocol_secret, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #create_property(property: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

Creates an "GA4" property with the specified location and attributes.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreatePropertyRequest.new

# Call the create_property method.
result = client.create_property request

# The returned object is of type Google::Analytics::Admin::V1alpha::Property.
p result

Overloads:

#create_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to create_property via a request object, either of type CreatePropertyRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreatePropertyRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_property(property: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to create_property via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- property (::Google::Analytics::Admin::V1alpha::Property, ::Hash) (defaults to: nil) —
  Required. The property to create. Note: the supplied property must specify its parent.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::Property)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::Property)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1029

def create_property request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreatePropertyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_property.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_property.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_property, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_user_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink` #create_user_link(parent: nil, notify_new_user: nil, user_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink`

Creates a user link on an account or property.

If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateUserLinkRequest.new

# Call the create_user_link method.
result = client.create_user_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::UserLink.
p result

Overloads:

#create_user_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

Pass arguments to create_user_link via a request object, either of type CreateUserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_user_link(parent: nil, notify_new_user: nil, user_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

Pass arguments to create_user_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: accounts/1234
- notify_new_user (::Boolean) (defaults to: nil) —
  Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.
- user_link (::Google::Analytics::Admin::V1alpha::UserLink, ::Hash) (defaults to: nil) —
  Required. The user link to create.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::UserLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::UserLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1692

def create_user_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateUserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_user_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_user_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_user_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_web_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream` #create_web_data_stream(web_data_stream: nil, parent: nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream`

Creates a web stream with the specified location and attributes.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest.new

# Call the create_web_data_stream method.
result = client.create_web_data_stream request

# The returned object is of type Google::Analytics::Admin::V1alpha::WebDataStream.
p result

Overloads:

#create_web_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

Pass arguments to create_web_data_stream via a request object, either of type CreateWebDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#create_web_data_stream(web_data_stream: nil, parent: nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

Pass arguments to create_web_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- web_data_stream (::Google::Analytics::Admin::V1alpha::WebDataStream, ::Hash) (defaults to: nil) —
  Required. The web stream to create.
- parent (::String) (defaults to: nil) —
  Required. The parent resource where this web data stream will be created. Format: properties/123

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::WebDataStream)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::WebDataStream)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2494

def create_web_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::CreateWebDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_web_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_web_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_web_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :create_web_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_account(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_account(name: nil) ⇒ `::Google::Protobuf::Empty`

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteAccountRequest.new

# Call the delete_account method.
result = client.delete_account request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_account(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_account via a request object, either of type DeleteAccountRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteAccountRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_account(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_account via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 479

def delete_account request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteAccountRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_account.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_account.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_account.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_account, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_android_app_data_stream(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_android_app_data_stream(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes an android app stream on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest.new

# Call the delete_android_app_data_stream method.
result = client.delete_android_app_data_stream request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_android_app_data_stream(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_android_app_data_stream via a request object, either of type DeleteAndroidAppDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_android_app_data_stream(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_android_app_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/123/androidAppDataStreams/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3144

def delete_android_app_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteAndroidAppDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_android_app_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_android_app_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_android_app_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_android_app_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_conversion_event(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_conversion_event(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a conversion event in a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest.new

# Call the delete_conversion_event method.
result = client.delete_conversion_event request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_conversion_event(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_conversion_event via a request object, either of type DeleteConversionEventRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_conversion_event(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_conversion_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5361

def delete_conversion_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteConversionEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_conversion_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_conversion_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_conversion_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_conversion_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_display_video360_advertiser_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_display_video360_advertiser_link(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a DisplayVideo360AdvertiserLink on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkRequest.new

# Call the delete_display_video360_advertiser_link method.
result = client.delete_display_video360_advertiser_link request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_display_video360_advertiser_link(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_display_video360_advertiser_link via a request object, either of type DeleteDisplayVideo360AdvertiserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_display_video360_advertiser_link(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_display_video360_advertiser_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5831

def delete_display_video360_advertiser_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_display_video360_advertiser_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_display_video360_advertiser_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_display_video360_advertiser_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_display_video360_advertiser_link_proposal(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkProposalRequest.new

# Call the delete_display_video360_advertiser_link_proposal method.
result = client.delete_display_video360_advertiser_link_proposal request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_display_video360_advertiser_link_proposal via a request object, either of type DeleteDisplayVideo360AdvertiserLinkProposalRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkProposalRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_display_video360_advertiser_link_proposal(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_display_video360_advertiser_link_proposal via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6284

def delete_display_video360_advertiser_link_proposal request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteDisplayVideo360AdvertiserLinkProposalRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_display_video360_advertiser_link_proposal.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_display_video360_advertiser_link_proposal.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_firebase_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_firebase_link(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a FirebaseLink on a property

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteFirebaseLinkRequest.new

# Call the delete_firebase_link method.
result = client.delete_firebase_link request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_firebase_link(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_firebase_link via a request object, either of type DeleteFirebaseLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteFirebaseLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_firebase_link(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_firebase_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3700

def delete_firebase_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteFirebaseLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_firebase_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_firebase_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_firebase_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_firebase_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_google_ads_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_google_ads_link(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a GoogleAdsLink on a property

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteGoogleAdsLinkRequest.new

# Call the delete_google_ads_link method.
result = client.delete_google_ads_link request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_google_ads_link(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_google_ads_link via a request object, either of type DeleteGoogleAdsLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteGoogleAdsLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_google_ads_link(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_google_ads_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Example format: properties/1234/googleAdsLinks/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4154

def delete_google_ads_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteGoogleAdsLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_google_ads_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_google_ads_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_google_ads_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_google_ads_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_ios_app_data_stream(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_ios_app_data_stream(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes an iOS app stream on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest.new

# Call the delete_ios_app_data_stream method.
result = client.delete_ios_app_data_stream request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_ios_app_data_stream(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_ios_app_data_stream via a request object, either of type DeleteIosAppDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_ios_app_data_stream(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_ios_app_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/123/iosAppDataStreams/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2774

def delete_ios_app_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteIosAppDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_ios_app_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_ios_app_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_ios_app_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_ios_app_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_measurement_protocol_secret(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes target MeasurementProtocolSecret.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest.new

# Call the delete_measurement_protocol_secret method.
result = client.delete_measurement_protocol_secret request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_measurement_protocol_secret via a request object, either of type DeleteMeasurementProtocolSecretRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_measurement_protocol_secret(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_measurement_protocol_secret via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4718

def delete_measurement_protocol_secret request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteMeasurementProtocolSecretRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_measurement_protocol_secret.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_measurement_protocol_secret.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_measurement_protocol_secret, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #delete_property(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not an GA4 Property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeletePropertyRequest.new

# Call the delete_property method.
result = client.delete_property request

# The returned object is of type Google::Analytics::Admin::V1alpha::Property.
p result

Overloads:

#delete_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to delete_property via a request object, either of type DeletePropertyRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeletePropertyRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_property(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to delete_property via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::Property)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::Property)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1118

def delete_property request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeletePropertyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_property.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_property.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_property, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_user_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_user_link(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a user link on an account or property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest.new

# Call the delete_user_link method.
result = client.delete_user_link request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_user_link(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_user_link via a request object, either of type DeleteUserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_user_link(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_user_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Example format: accounts/1234/userLinks/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2051

def delete_user_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteUserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_user_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_user_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_user_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_web_data_stream(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_web_data_stream(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a web stream on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest.new

# Call the delete_web_data_stream method.
result = client.delete_web_data_stream request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_web_data_stream(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_web_data_stream via a request object, either of type DeleteWebDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#delete_web_data_stream(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_web_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2316

def delete_web_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::DeleteWebDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_web_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_web_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_web_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :delete_web_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_account(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account` #get_account(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account`

Lookup for a single Account.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetAccountRequest.new

# Call the get_account method.
result = client.get_account request

# The returned object is of type Google::Analytics::Admin::V1alpha::Account.
p result

Overloads:

#get_account(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account

Pass arguments to get_account via a request object, either of type GetAccountRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetAccountRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_account(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account

Pass arguments to get_account via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::Account)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::Account)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 282

def get_account request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAccountRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_account.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_account.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_account.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_account, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_android_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream` #get_android_app_data_stream(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream`

Lookup for a single AndroidAppDataStream

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest.new

# Call the get_android_app_data_stream method.
result = client.get_android_app_data_stream request

# The returned object is of type Google::Analytics::Admin::V1alpha::AndroidAppDataStream.
p result

Overloads:

#get_android_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream

Pass arguments to get_android_app_data_stream via a request object, either of type GetAndroidAppDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_android_app_data_stream(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream

Pass arguments to get_android_app_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/123/androidAppDataStreams/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::AndroidAppDataStream)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::AndroidAppDataStream)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3057

def get_android_app_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetAndroidAppDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_android_app_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_android_app_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_android_app_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_android_app_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_conversion_event(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent` #get_conversion_event(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent`

Retrieve a single conversion event.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetConversionEventRequest.new

# Call the get_conversion_event method.
result = client.get_conversion_event request

# The returned object is of type Google::Analytics::Admin::V1alpha::ConversionEvent.
p result

Overloads:

#get_conversion_event(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent

Pass arguments to get_conversion_event via a request object, either of type GetConversionEventRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetConversionEventRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_conversion_event(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent

Pass arguments to get_conversion_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::ConversionEvent)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::ConversionEvent)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5274

def get_conversion_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetConversionEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_conversion_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_conversion_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_conversion_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_conversion_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_custom_dimension(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension` #get_custom_dimension(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension`

Lookup for a single CustomDimension.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest.new

# Call the get_custom_dimension method.
result = client.get_custom_dimension request

# The returned object is of type Google::Analytics::Admin::V1alpha::CustomDimension.
p result

Overloads:

#get_custom_dimension(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

Pass arguments to get_custom_dimension via a request object, either of type GetCustomDimensionRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_custom_dimension(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

Pass arguments to get_custom_dimension via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::CustomDimension)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::CustomDimension)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6912

def get_custom_dimension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomDimensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_custom_dimension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_custom_dimension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_custom_dimension, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_custom_metric(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric` #get_custom_metric(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric`

Lookup for a single CustomMetric.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetCustomMetricRequest.new

# Call the get_custom_metric method.
result = client.get_custom_metric request

# The returned object is of type Google::Analytics::Admin::V1alpha::CustomMetric.
p result

Overloads:

#get_custom_metric(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

Pass arguments to get_custom_metric via a request object, either of type GetCustomMetricRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_custom_metric(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

Pass arguments to get_custom_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::CustomMetric)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::CustomMetric)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 7362

def get_custom_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetCustomMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_custom_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_custom_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_custom_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_data_retention_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings` #get_data_retention_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings`

Returns the singleton data retention settings for this property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetDataRetentionSettingsRequest.new

# Call the get_data_retention_settings method.
result = client.get_data_retention_settings request

# The returned object is of type Google::Analytics::Admin::V1alpha::DataRetentionSettings.
p result

Overloads:

#get_data_retention_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings

Pass arguments to get_data_retention_settings via a request object, either of type GetDataRetentionSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetDataRetentionSettingsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_data_retention_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings

Pass arguments to get_data_retention_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DataRetentionSettings)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataRetentionSettings)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 7450

def get_data_retention_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetDataRetentionSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_data_retention_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_data_retention_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_data_retention_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_data_retention_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_data_sharing_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataSharingSettings` #get_data_sharing_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataSharingSettings`

Get data sharing settings on an account. Data sharing settings are singletons.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetDataSharingSettingsRequest.new

# Call the get_data_sharing_settings method.
result = client.get_data_sharing_settings request

# The returned object is of type Google::Analytics::Admin::V1alpha::DataSharingSettings.
p result

Overloads:

#get_data_sharing_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataSharingSettings

Pass arguments to get_data_sharing_settings via a request object, either of type GetDataSharingSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetDataSharingSettingsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_data_sharing_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataSharingSettings

Pass arguments to get_data_sharing_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DataSharingSettings)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataSharingSettings)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4344

def get_data_sharing_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetDataSharingSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_data_sharing_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_data_sharing_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_data_sharing_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_data_sharing_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_display_video360_advertiser_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink` #get_display_video360_advertiser_link(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink`

Look up a single DisplayVideo360AdvertiserLink

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkRequest.new

# Call the get_display_video360_advertiser_link method.
result = client.get_display_video360_advertiser_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink.
p result

Overloads:

#get_display_video360_advertiser_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink

Pass arguments to get_display_video360_advertiser_link via a request object, either of type GetDisplayVideo360AdvertiserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_display_video360_advertiser_link(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink

Pass arguments to get_display_video360_advertiser_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5551

def get_display_video360_advertiser_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_display_video360_advertiser_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_display_video360_advertiser_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_display_video360_advertiser_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal` #get_display_video360_advertiser_link_proposal(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal`

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkProposalRequest.new

# Call the get_display_video360_advertiser_link_proposal method.
result = client.get_display_video360_advertiser_link_proposal request

# The returned object is of type Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal.
p result

Overloads:

#get_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

Pass arguments to get_display_video360_advertiser_link_proposal via a request object, either of type GetDisplayVideo360AdvertiserLinkProposalRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkProposalRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_display_video360_advertiser_link_proposal(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

Pass arguments to get_display_video360_advertiser_link_proposal via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6006

def get_display_video360_advertiser_link_proposal request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetDisplayVideo360AdvertiserLinkProposalRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_display_video360_advertiser_link_proposal.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_display_video360_advertiser_link_proposal.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_display_video360_advertiser_link_proposal, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_enhanced_measurement_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings` #get_enhanced_measurement_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings`

Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest.new

# Call the get_enhanced_measurement_settings method.
result = client.get_enhanced_measurement_settings request

# The returned object is of type Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.
p result

Overloads:

#get_enhanced_measurement_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings

Pass arguments to get_enhanced_measurement_settings via a request object, either of type GetEnhancedMeasurementSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_enhanced_measurement_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings

Pass arguments to get_enhanced_measurement_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3432

def get_enhanced_measurement_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetEnhancedMeasurementSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_enhanced_measurement_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_enhanced_measurement_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_enhanced_measurement_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_enhanced_measurement_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_global_site_tag(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GlobalSiteTag` #get_global_site_tag(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GlobalSiteTag`

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetGlobalSiteTagRequest.new

# Call the get_global_site_tag method.
result = client.get_global_site_tag request

# The returned object is of type Google::Analytics::Admin::V1alpha::GlobalSiteTag.
p result

Overloads:

#get_global_site_tag(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GlobalSiteTag

Pass arguments to get_global_site_tag via a request object, either of type GetGlobalSiteTagRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetGlobalSiteTagRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_global_site_tag(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GlobalSiteTag

Pass arguments to get_global_site_tag via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/webDataStreams/{stream_id}/globalSiteTag Example: "properties/123/webDataStreams/456/globalSiteTag"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::GlobalSiteTag)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::GlobalSiteTag)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3893

def get_global_site_tag request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetGlobalSiteTagRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_global_site_tag.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_global_site_tag.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_global_site_tag.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_global_site_tag, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_google_signals_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings` #get_google_signals_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings`

Lookup for Google Signals settings for a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest.new

# Call the get_google_signals_settings method.
result = client.get_google_signals_settings request

# The returned object is of type Google::Analytics::Admin::V1alpha::GoogleSignalsSettings.
p result

Overloads:

#get_google_signals_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings

Pass arguments to get_google_signals_settings via a request object, either of type GetGoogleSignalsSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_google_signals_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings

Pass arguments to get_google_signals_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5009

def get_google_signals_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetGoogleSignalsSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_google_signals_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_google_signals_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_google_signals_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_google_signals_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_ios_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream` #get_ios_app_data_stream(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream`

Lookup for a single IosAppDataStream

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest.new

# Call the get_ios_app_data_stream method.
result = client.get_ios_app_data_stream request

# The returned object is of type Google::Analytics::Admin::V1alpha::IosAppDataStream.
p result

Overloads:

#get_ios_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream

Pass arguments to get_ios_app_data_stream via a request object, either of type GetIosAppDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_ios_app_data_stream(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream

Pass arguments to get_ios_app_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/123/iosAppDataStreams/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::IosAppDataStream)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::IosAppDataStream)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2687

def get_ios_app_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetIosAppDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_ios_app_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_ios_app_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_ios_app_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_ios_app_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret` #get_measurement_protocol_secret(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret`

Lookup for a single "GA4" MeasurementProtocolSecret.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest.new

# Call the get_measurement_protocol_secret method.
result = client.get_measurement_protocol_secret request

# The returned object is of type Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret.
p result

Overloads:

#get_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

Pass arguments to get_measurement_protocol_secret via a request object, either of type GetMeasurementProtocolSecretRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_measurement_protocol_secret(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

Pass arguments to get_measurement_protocol_secret via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4433

def get_measurement_protocol_secret request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetMeasurementProtocolSecretRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_measurement_protocol_secret.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_measurement_protocol_secret.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_measurement_protocol_secret, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #get_property(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

Lookup for a single "GA4" Property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetPropertyRequest.new

# Call the get_property method.
result = client.get_property request

# The returned object is of type Google::Analytics::Admin::V1alpha::Property.
p result

Overloads:

#get_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to get_property via a request object, either of type GetPropertyRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetPropertyRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_property(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to get_property via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::Property)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::Property)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 828

def get_property request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetPropertyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_property.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_property.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_property, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_user_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink` #get_user_link(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink`

Gets information about a user's link to an account or property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetUserLinkRequest.new

# Call the get_user_link method.
result = client.get_user_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::UserLink.
p result

Overloads:

#get_user_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

Pass arguments to get_user_link via a request object, either of type GetUserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetUserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_user_link(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

Pass arguments to get_user_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Example format: accounts/1234/userLinks/5678

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::UserLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::UserLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1294

def get_user_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetUserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_user_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_user_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_user_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_web_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream` #get_web_data_stream(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream`

Lookup for a single WebDataStream

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest.new

# Call the get_web_data_stream method.
result = client.get_web_data_stream request

# The returned object is of type Google::Analytics::Admin::V1alpha::WebDataStream.
p result

Overloads:

#get_web_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

Pass arguments to get_web_data_stream via a request object, either of type GetWebDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#get_web_data_stream(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

Pass arguments to get_web_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::WebDataStream)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::WebDataStream)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2229

def get_web_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::GetWebDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_web_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_web_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_web_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :get_web_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_account_summaries(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>` #list_account_summaries(page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>`

Returns summaries of all accounts accessible by the caller.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest.new

# Call the list_account_summaries method.
result = client.list_account_summaries request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::AccountSummary.
  p response
end

Overloads:

#list_account_summaries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>

Pass arguments to list_account_summaries via a request object, either of type ListAccountSummariesRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_account_summaries(page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>

Pass arguments to list_account_summaries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- page_size (::Integer) (defaults to: nil) —
  The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListAccountSummaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountSummaries must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 748

def list_account_summaries request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAccountSummariesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_account_summaries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_account_summaries.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_account_summaries.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_account_summaries, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_account_summaries, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_accounts(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>` #list_accounts(page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>`

Returns all accounts accessible by the caller.

Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListAccountsRequest.new

# Call the list_accounts method.
result = client.list_accounts request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::Account.
  p response
end

Overloads:

#list_accounts(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>

Pass arguments to list_accounts via a request object, either of type ListAccountsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListAccountsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_accounts(page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>

Pass arguments to list_accounts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.
- show_deleted (::Boolean) (defaults to: nil) —
  Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 389

def list_accounts request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAccountsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_accounts.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_accounts.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_accounts.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_accounts, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_accounts, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_android_app_data_streams(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>` #list_android_app_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>`

Returns child android app streams under the specified parent property.

Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest.new

# Call the list_android_app_data_streams method.
result = client.list_android_app_data_streams request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream.
  p response
end

Overloads:

#list_android_app_data_streams(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>

Pass arguments to list_android_app_data_streams via a request object, either of type ListAndroidAppDataStreamsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_android_app_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>

Pass arguments to list_android_app_data_streams via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: "properties/123"
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return.
  
  If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAndroidAppDataStreams must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AndroidAppDataStream>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3341

def list_android_app_data_streams request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListAndroidAppDataStreamsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_android_app_data_streams.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_android_app_data_streams.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_android_app_data_streams.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_android_app_data_streams, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_android_app_data_streams, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_conversion_events(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>` #list_conversion_events(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>`

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListConversionEventsRequest.new

# Call the list_conversion_events method.
result = client.list_conversion_events request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::ConversionEvent.
  p response
end

Overloads:

#list_conversion_events(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>

Pass arguments to list_conversion_events via a request object, either of type ListConversionEventsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_conversion_events(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>

Pass arguments to list_conversion_events via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the parent property. Example: 'properties/123'
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListConversionEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConversionEvents must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5464

def list_conversion_events request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListConversionEventsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_conversion_events.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_conversion_events.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_conversion_events.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_conversion_events, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_conversion_events, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_custom_dimensions(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>` #list_custom_dimensions(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>`

Lists CustomDimensions on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest.new

# Call the list_custom_dimensions method.
result = client.list_custom_dimensions request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomDimension.
  p response
end

Overloads:

#list_custom_dimensions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>

Pass arguments to list_custom_dimensions via a request object, either of type ListCustomDimensionsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_custom_dimensions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>

Pass arguments to list_custom_dimensions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListCustomDimensions call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListCustomDimensions must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6739

def list_custom_dimensions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomDimensionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_custom_dimensions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_custom_dimensions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_custom_dimensions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_custom_dimensions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_dimensions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_custom_metrics(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>` #list_custom_metrics(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>`

Lists CustomMetrics on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest.new

# Call the list_custom_metrics method.
result = client.list_custom_metrics request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomMetric.
  p response
end

Overloads:

#list_custom_metrics(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>

Pass arguments to list_custom_metrics via a request object, either of type ListCustomMetricsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_custom_metrics(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>

Pass arguments to list_custom_metrics via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListCustomMetrics call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListCustomMetrics must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 7189

def list_custom_metrics request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListCustomMetricsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_custom_metrics.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_custom_metrics.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_custom_metrics.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_custom_metrics, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_metrics, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_display_video360_advertiser_link_proposals(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>` #list_display_video360_advertiser_link_proposals(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>`

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinkProposalsRequest.new

# Call the list_display_video360_advertiser_link_proposals method.
result = client.list_display_video360_advertiser_link_proposals request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal.
  p response
end

Overloads:

#list_display_video360_advertiser_link_proposals(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>

Pass arguments to list_display_video360_advertiser_link_proposals via a request object, either of type ListDisplayVideo360AdvertiserLinkProposalsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinkProposalsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_display_video360_advertiser_link_proposals(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>

Pass arguments to list_display_video360_advertiser_link_proposals via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListDisplayVideo360AdvertiserLinkProposals call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinkProposals must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6109

def list_display_video360_advertiser_link_proposals request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinkProposalsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_display_video360_advertiser_link_proposals.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_display_video360_advertiser_link_proposals.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_display_video360_advertiser_link_proposals.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_display_video360_advertiser_link_proposals, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_display_video360_advertiser_link_proposals, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_display_video360_advertiser_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>` #list_display_video360_advertiser_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>`

Lists all DisplayVideo360AdvertiserLinks on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinksRequest.new

# Call the list_display_video360_advertiser_links method.
result = client.list_display_video360_advertiser_links request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink.
  p response
end

Overloads:

#list_display_video360_advertiser_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>

Pass arguments to list_display_video360_advertiser_links via a request object, either of type ListDisplayVideo360AdvertiserLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_display_video360_advertiser_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>

Pass arguments to list_display_video360_advertiser_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListDisplayVideo360AdvertiserLinks call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinks must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5653

def list_display_video360_advertiser_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListDisplayVideo360AdvertiserLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_display_video360_advertiser_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_display_video360_advertiser_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_display_video360_advertiser_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_display_video360_advertiser_links, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_display_video360_advertiser_links, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_firebase_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>` #list_firebase_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>`

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListFirebaseLinksRequest.new

# Call the list_firebase_links method.
result = client.list_firebase_links request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::FirebaseLink.
  p response
end

Overloads:

#list_firebase_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>

Pass arguments to list_firebase_links via a request object, either of type ListFirebaseLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListFirebaseLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_firebase_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>

Pass arguments to list_firebase_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Format: properties/{property_id} Example: properties/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListFirebaseLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3803

def list_firebase_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListFirebaseLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_firebase_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_firebase_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_firebase_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_firebase_links, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_firebase_links, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_google_ads_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>` #list_google_ads_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>`

Lists GoogleAdsLinks on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListGoogleAdsLinksRequest.new

# Call the list_google_ads_links method.
result = client.list_google_ads_links request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::GoogleAdsLink.
  p response
end

Overloads:

#list_google_ads_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>

Pass arguments to list_google_ads_links via a request object, either of type ListGoogleAdsLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListGoogleAdsLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_google_ads_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>

Pass arguments to list_google_ads_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListGoogleAdsLinks call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListGoogleAdsLinks must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4255

def list_google_ads_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListGoogleAdsLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_google_ads_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_google_ads_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_google_ads_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_google_ads_links, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_google_ads_links, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_ios_app_data_streams(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>` #list_ios_app_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>`

Returns child iOS app data streams under the specified parent property.

iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest.new

# Call the list_ios_app_data_streams method.
result = client.list_ios_app_data_streams request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::IosAppDataStream.
  p response
end

Overloads:

#list_ios_app_data_streams(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>

Pass arguments to list_ios_app_data_streams via a request object, either of type ListIosAppDataStreamsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_ios_app_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>

Pass arguments to list_ios_app_data_streams via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: "properties/123"
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListIosAppDataStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIosAppDataStreams must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2969

def list_ios_app_data_streams request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListIosAppDataStreamsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_ios_app_data_streams.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_ios_app_data_streams.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_ios_app_data_streams.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_ios_app_data_streams, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_ios_app_data_streams, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_measurement_protocol_secrets(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>` #list_measurement_protocol_secrets(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>`

Returns child MeasurementProtocolSecrets under the specified parent Property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest.new

# Call the list_measurement_protocol_secrets method.
result = client.list_measurement_protocol_secrets request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret.
  p response
end

Overloads:

#list_measurement_protocol_secrets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>

Pass arguments to list_measurement_protocol_secrets via a request object, either of type ListMeasurementProtocolSecretsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_measurement_protocol_secrets(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>

Pass arguments to list_measurement_protocol_secrets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The resource name of the parent stream. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListMeasurementProtocolSecrets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMeasurementProtocolSecrets must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4538

def list_measurement_protocol_secrets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListMeasurementProtocolSecretsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_measurement_protocol_secrets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_measurement_protocol_secrets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_measurement_protocol_secrets.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_measurement_protocol_secrets, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_measurement_protocol_secrets, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_properties(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>` #list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>`

Returns child Properties under the specified parent Account.

Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListPropertiesRequest.new

# Call the list_properties method.
result = client.list_properties request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::Property.
  p response
end

Overloads:

#list_properties(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>

Pass arguments to list_properties via a request object, either of type ListPropertiesRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListPropertiesRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>

Pass arguments to list_properties via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- filter (::String) (defaults to: nil) —
  Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:
```
| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
```
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListProperties call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties must match the call that provided the page token.
- show_deleted (::Boolean) (defaults to: nil) —
  Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 950

def list_properties request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListPropertiesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_properties.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_properties.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_properties.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_properties, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_properties, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_user_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>` #list_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>`

Lists all user links on an account or property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListUserLinksRequest.new

# Call the list_user_links method.
result = client.list_user_links request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::UserLink.
  p response
end

Overloads:

#list_user_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>

Pass arguments to list_user_links via a request object, either of type ListUserLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListUserLinksRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>

Pass arguments to list_user_links via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Example format: accounts/1234
- page_size (::Integer) (defaults to: nil) —
  The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListUserLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserLinks must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1487

def list_user_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListUserLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_user_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_user_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_user_links, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_user_links, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_web_data_streams(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>` #list_web_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>`

Returns child web data streams under the specified parent property.

Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest.new

# Call the list_web_data_streams method.
result = client.list_web_data_streams request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::WebDataStream.
  p response
end

Overloads:

#list_web_data_streams(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>

Pass arguments to list_web_data_streams via a request object, either of type ListWebDataStreamsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#list_web_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>

Pass arguments to list_web_data_streams via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123"
- page_size (::Integer) (defaults to: nil) —
  The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- page_token (::String) (defaults to: nil) —
  A page token, received from a previous ListWebDataStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWebDataStreams must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2599

def list_web_data_streams request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ListWebDataStreamsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_web_data_streams.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_web_data_streams.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_web_data_streams.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :list_web_data_streams, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :list_web_data_streams, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#provision_account_ticket(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse` #provision_account_ticket(account: nil, redirect_uri: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse`

Requests a ticket for creating an account.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::ProvisionAccountTicketRequest.new

# Call the provision_account_ticket method.
result = client.provision_account_ticket request

# The returned object is of type Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse.
p result

Overloads:

#provision_account_ticket(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse

Pass arguments to provision_account_ticket via a request object, either of type ProvisionAccountTicketRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#provision_account_ticket(account: nil, redirect_uri: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse

Pass arguments to provision_account_ticket via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- account (::Google::Analytics::Admin::V1alpha::Account, ::Hash) (defaults to: nil) —
  The account to create.
- redirect_uri (::String) (defaults to: nil) —
  Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 657

def provision_account_ticket request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.provision_account_ticket.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.provision_account_ticket.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.provision_account_ticket.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :provision_account_ticket, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_change_history_events(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>` #search_change_history_events(account: nil, property: nil, resource_type: nil, action: nil, actor_email: nil, earliest_change_time: nil, latest_change_time: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>`

Searches through all changes to an account or its children given the specified set of filters.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest.new

# Call the search_change_history_events method.
result = client.search_change_history_events request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent.
  p response
end

Overloads:

#search_change_history_events(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>

Pass arguments to search_change_history_events via a request object, either of type SearchChangeHistoryEventsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#search_change_history_events(account: nil, property: nil, resource_type: nil, action: nil, actor_email: nil, earliest_change_time: nil, latest_change_time: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>

Pass arguments to search_change_history_events via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- account (::String) (defaults to: nil) —
  Required. The account resource for which to return change history resources.
- property (::String) (defaults to: nil) —
  Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.
- resource_type (::Array<::Google::Analytics::Admin::V1alpha::ChangeHistoryResourceType>) (defaults to: nil) —
  Optional. If set, only return changes if they are for a resource that matches at least one of these types.
- action (::Array<::Google::Analytics::Admin::V1alpha::ActionType>) (defaults to: nil) —
  Optional. If set, only return changes that match one or more of these types of actions.
- actor_email (::Array<::String>) (defaults to: nil) —
  Optional. If set, only return changes if they are made by a user in this list.
- earliest_change_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —
  Optional. If set, only return changes made after this time (inclusive).
- latest_change_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —
  Optional. If set, only return changes made before this time (inclusive).
- page_size (::Integer) (defaults to: nil) —
  Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- page_token (::String) (defaults to: nil) —
  Optional. A page token, received from a previous SearchChangeHistoryEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchChangeHistoryEvents must match the call that provided the page token.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4922

def search_change_history_events request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::SearchChangeHistoryEventsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_change_history_events.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.account
    header_params["account"] = request.account
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search_change_history_events.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_change_history_events.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :search_change_history_events, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @analytics_admin_service_stub, :search_change_history_events, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_account(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account` #update_account(account: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account`

Updates an account.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateAccountRequest.new

# Call the update_account method.
result = client.update_account request

# The returned object is of type Google::Analytics::Admin::V1alpha::Account.
p result

Overloads:

#update_account(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account

Pass arguments to update_account via a request object, either of type UpdateAccountRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateAccountRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_account(account: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account

Pass arguments to update_account via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- account (::Google::Analytics::Admin::V1alpha::Account, ::Hash) (defaults to: nil) —
  Required. The account to update. The account's name field is used to identify the account.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::Account)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::Account)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 569

def update_account request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAccountRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_account.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.account&.name
    header_params["account.name"] = request.account.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_account.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_account.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_account, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_android_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream` #update_android_app_data_stream(android_app_data_stream: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream`

Updates an android app stream on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest.new

# Call the update_android_app_data_stream method.
result = client.update_android_app_data_stream request

# The returned object is of type Google::Analytics::Admin::V1alpha::AndroidAppDataStream.
p result

Overloads:

#update_android_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream

Pass arguments to update_android_app_data_stream via a request object, either of type UpdateAndroidAppDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_android_app_data_stream(android_app_data_stream: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream

Pass arguments to update_android_app_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- android_app_data_stream (::Google::Analytics::Admin::V1alpha::AndroidAppDataStream, ::Hash) (defaults to: nil) —
  Required. The android app stream to update. The name field is used to identify the android app stream to be updated.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::AndroidAppDataStream)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::AndroidAppDataStream)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3234

def update_android_app_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateAndroidAppDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_android_app_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.android_app_data_stream&.name
    header_params["android_app_data_stream.name"] = request.android_app_data_stream.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_android_app_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_android_app_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_android_app_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_custom_dimension(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension` #update_custom_dimension(custom_dimension: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension`

Updates a CustomDimension on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest.new

# Call the update_custom_dimension method.
result = client.update_custom_dimension request

# The returned object is of type Google::Analytics::Admin::V1alpha::CustomDimension.
p result

Overloads:

#update_custom_dimension(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

Pass arguments to update_custom_dimension via a request object, either of type UpdateCustomDimensionRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_custom_dimension(custom_dimension: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

Pass arguments to update_custom_dimension via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- custom_dimension (::Google::Analytics::Admin::V1alpha::CustomDimension, ::Hash) (defaults to: nil) —
  The CustomDimension to update
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::CustomDimension)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::CustomDimension)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 6638

def update_custom_dimension request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomDimensionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.custom_dimension&.name
    header_params["custom_dimension.name"] = request.custom_dimension.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_custom_dimension.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_custom_dimension.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_custom_dimension, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_custom_metric(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric` #update_custom_metric(custom_metric: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric`

Updates a CustomMetric on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest.new

# Call the update_custom_metric method.
result = client.update_custom_metric request

# The returned object is of type Google::Analytics::Admin::V1alpha::CustomMetric.
p result

Overloads:

#update_custom_metric(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

Pass arguments to update_custom_metric via a request object, either of type UpdateCustomMetricRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_custom_metric(custom_metric: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

Pass arguments to update_custom_metric via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- custom_metric (::Google::Analytics::Admin::V1alpha::CustomMetric, ::Hash) (defaults to: nil) —
  The CustomMetric to update
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::CustomMetric)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::CustomMetric)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 7088

def update_custom_metric request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateCustomMetricRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.custom_metric&.name
    header_params["custom_metric.name"] = request.custom_metric.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_custom_metric.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_custom_metric.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_custom_metric, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_data_retention_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings` #update_data_retention_settings(data_retention_settings: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings`

Updates the singleton data retention settings for this property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateDataRetentionSettingsRequest.new

# Call the update_data_retention_settings method.
result = client.update_data_retention_settings request

# The returned object is of type Google::Analytics::Admin::V1alpha::DataRetentionSettings.
p result

Overloads:

#update_data_retention_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings

Pass arguments to update_data_retention_settings via a request object, either of type UpdateDataRetentionSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateDataRetentionSettingsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_data_retention_settings(data_retention_settings: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings

Pass arguments to update_data_retention_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- data_retention_settings (::Google::Analytics::Admin::V1alpha::DataRetentionSettings, ::Hash) (defaults to: nil) —
  Required. The settings to update. The name field is used to identify the settings to be updated.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DataRetentionSettings)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataRetentionSettings)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 7540

def update_data_retention_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateDataRetentionSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_data_retention_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.data_retention_settings&.name
    header_params["data_retention_settings.name"] = request.data_retention_settings.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_data_retention_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_data_retention_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_data_retention_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_display_video360_advertiser_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink` #update_display_video360_advertiser_link(display_video_360_advertiser_link: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink`

Updates a DisplayVideo360AdvertiserLink on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateDisplayVideo360AdvertiserLinkRequest.new

# Call the update_display_video360_advertiser_link method.
result = client.update_display_video360_advertiser_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink.
p result

Overloads:

#update_display_video360_advertiser_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink

Pass arguments to update_display_video360_advertiser_link via a request object, either of type UpdateDisplayVideo360AdvertiserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateDisplayVideo360AdvertiserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_display_video360_advertiser_link(display_video_360_advertiser_link: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink

Pass arguments to update_display_video360_advertiser_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- display_video_360_advertiser_link (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink, ::Hash) (defaults to: nil) —
  The DisplayVideo360AdvertiserLink to update
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5920

def update_display_video360_advertiser_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateDisplayVideo360AdvertiserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.display_video_360_advertiser_link&.name
    header_params["display_video_360_advertiser_link.name"] = request.display_video_360_advertiser_link.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_display_video360_advertiser_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_display_video360_advertiser_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_display_video360_advertiser_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_enhanced_measurement_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings` #update_enhanced_measurement_settings(enhanced_measurement_settings: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings`

Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest.new

# Call the update_enhanced_measurement_settings method.
result = client.update_enhanced_measurement_settings request

# The returned object is of type Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings.
p result

Overloads:

#update_enhanced_measurement_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings

Pass arguments to update_enhanced_measurement_settings via a request object, either of type UpdateEnhancedMeasurementSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_enhanced_measurement_settings(enhanced_measurement_settings: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings

Pass arguments to update_enhanced_measurement_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- enhanced_measurement_settings (::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings, ::Hash) (defaults to: nil) —
  Required. The settings to update. The name field is used to identify the settings to be updated.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 3524

def update_enhanced_measurement_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateEnhancedMeasurementSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_enhanced_measurement_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.enhanced_measurement_settings&.name
    header_params["enhanced_measurement_settings.name"] = request.enhanced_measurement_settings.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_enhanced_measurement_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_enhanced_measurement_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_enhanced_measurement_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_google_ads_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink` #update_google_ads_link(google_ads_link: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink`

Updates a GoogleAdsLink on a property

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateGoogleAdsLinkRequest.new

# Call the update_google_ads_link method.
result = client.update_google_ads_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::GoogleAdsLink.
p result

Overloads:

#update_google_ads_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink

Pass arguments to update_google_ads_link via a request object, either of type UpdateGoogleAdsLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateGoogleAdsLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_google_ads_link(google_ads_link: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink

Pass arguments to update_google_ads_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- google_ads_link (::Google::Analytics::Admin::V1alpha::GoogleAdsLink, ::Hash) (defaults to: nil) —
  The GoogleAdsLink to update
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::GoogleAdsLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::GoogleAdsLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4069

def update_google_ads_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateGoogleAdsLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_google_ads_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.google_ads_link&.name
    header_params["google_ads_link.name"] = request.google_ads_link.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_google_ads_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_google_ads_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_google_ads_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_google_signals_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings` #update_google_signals_settings(google_signals_settings: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings`

Updates Google Signals settings for a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest.new

# Call the update_google_signals_settings method.
result = client.update_google_signals_settings request

# The returned object is of type Google::Analytics::Admin::V1alpha::GoogleSignalsSettings.
p result

Overloads:

#update_google_signals_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings

Pass arguments to update_google_signals_settings via a request object, either of type UpdateGoogleSignalsSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_google_signals_settings(google_signals_settings: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings

Pass arguments to update_google_signals_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- google_signals_settings (::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings, ::Hash) (defaults to: nil) —
  Required. The settings to update. The name field is used to identify the settings to be updated.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 5099

def update_google_signals_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateGoogleSignalsSettingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_google_signals_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.google_signals_settings&.name
    header_params["google_signals_settings.name"] = request.google_signals_settings.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_google_signals_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_google_signals_settings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_google_signals_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_ios_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream` #update_ios_app_data_stream(ios_app_data_stream: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream`

Updates an iOS app stream on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest.new

# Call the update_ios_app_data_stream method.
result = client.update_ios_app_data_stream request

# The returned object is of type Google::Analytics::Admin::V1alpha::IosAppDataStream.
p result

Overloads:

#update_ios_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream

Pass arguments to update_ios_app_data_stream via a request object, either of type UpdateIosAppDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_ios_app_data_stream(ios_app_data_stream: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream

Pass arguments to update_ios_app_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- ios_app_data_stream (::Google::Analytics::Admin::V1alpha::IosAppDataStream, ::Hash) (defaults to: nil) —
  Required. The iOS app stream to update. The name field is used to identify the iOS app stream to be updated.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::IosAppDataStream)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::IosAppDataStream)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2864

def update_ios_app_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateIosAppDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_ios_app_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.ios_app_data_stream&.name
    header_params["ios_app_data_stream.name"] = request.ios_app_data_stream.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_ios_app_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_ios_app_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_ios_app_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret` #update_measurement_protocol_secret(measurement_protocol_secret: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret`

Updates a measurement protocol secret.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest.new

# Call the update_measurement_protocol_secret method.
result = client.update_measurement_protocol_secret request

# The returned object is of type Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret.
p result

Overloads:

#update_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

Pass arguments to update_measurement_protocol_secret via a request object, either of type UpdateMeasurementProtocolSecretRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_measurement_protocol_secret(measurement_protocol_secret: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

Pass arguments to update_measurement_protocol_secret via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- measurement_protocol_secret (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash) (defaults to: nil) —
  Required. The measurement protocol secret to update.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  The list of fields to be updated. Omitted fields will not be updated.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 4805

def update_measurement_protocol_secret request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateMeasurementProtocolSecretRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.measurement_protocol_secret&.name
    header_params["measurement_protocol_secret.name"] = request.measurement_protocol_secret.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_measurement_protocol_secret.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_measurement_protocol_secret.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_measurement_protocol_secret, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #update_property(property: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

Updates a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdatePropertyRequest.new

# Call the update_property method.
result = client.update_property request

# The returned object is of type Google::Analytics::Admin::V1alpha::Property.
p result

Overloads:

#update_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to update_property via a request object, either of type UpdatePropertyRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdatePropertyRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_property(property: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

Pass arguments to update_property via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- property (::Google::Analytics::Admin::V1alpha::Property, ::Hash) (defaults to: nil) —
  Required. The property to update. The property's name field is used to identify the property to be updated.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::Property)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::Property)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1209

def update_property request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdatePropertyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.property&.name
    header_params["property.name"] = request.property.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_property.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_property.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_property, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_user_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink` #update_user_link(user_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink`

Updates a user link on an account or property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest.new

# Call the update_user_link method.
result = client.update_user_link request

# The returned object is of type Google::Analytics::Admin::V1alpha::UserLink.
p result

Overloads:

#update_user_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

Pass arguments to update_user_link via a request object, either of type UpdateUserLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_user_link(user_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

Pass arguments to update_user_link via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- user_link (::Google::Analytics::Admin::V1alpha::UserLink, ::Hash) (defaults to: nil) —
  Required. The user link to update.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::UserLink)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::UserLink)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 1875

def update_user_link request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateUserLinkRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.user_link&.name
    header_params["user_link.name"] = request.user_link.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_user_link.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_user_link.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_user_link, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_web_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream` #update_web_data_stream(web_data_stream: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream`

Updates a web stream on a property.

Examples:

Basic example

require "google/analytics/admin/v1alpha"

# Create a client object. The client can be reused for multiple calls.
client = Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest.new

# Call the update_web_data_stream method.
result = client.update_web_data_stream request

# The returned object is of type Google::Analytics::Admin::V1alpha::WebDataStream.
p result

Overloads:

#update_web_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

Pass arguments to update_web_data_stream via a request object, either of type UpdateWebDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#update_web_data_stream(web_data_stream: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

Pass arguments to update_web_data_stream via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- web_data_stream (::Google::Analytics::Admin::V1alpha::WebDataStream, ::Hash) (defaults to: nil) —
  Required. The web stream to update. The name field is used to identify the web stream to be updated.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Yields:

(response, operation) —
Access the result along with the RPC operation

Yield Parameters:

response (::Google::Analytics::Admin::V1alpha::WebDataStream)
operation (::GRPC::ActiveCall::Operation)

Returns:

(::Google::Analytics::Admin::V1alpha::WebDataStream)

Raises:

(::Google::Cloud::Error) —
if the RPC is aborted.

# File 'lib/google/analytics/admin/v1alpha/analytics_admin_service/client.rb', line 2406

def update_web_data_stream request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Analytics::Admin::V1alpha::UpdateWebDataStreamRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_web_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Analytics::Admin::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.web_data_stream&.name
    header_params["web_data_stream.name"] = request.web_data_stream.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_web_data_stream.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_web_data_stream.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @analytics_admin_service_stub.call_rpc :update_web_data_stream, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

Class: Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Client

Overview

Defined Under Namespace

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

Constructor Details

#initialize {|config| ... } ⇒ Client

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Instance Method Details

#archive_custom_dimension(request, options = nil) ⇒ ::Google::Protobuf::Empty #archive_custom_dimension(name: nil) ⇒ ::Google::Protobuf::Empty

#archive_custom_metric(request, options = nil) ⇒ ::Google::Protobuf::Empty #archive_custom_metric(name: nil) ⇒ ::Google::Protobuf::Empty

#audit_user_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink> #audit_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>

#batch_create_user_links(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse #batch_create_user_links(parent: nil, notify_new_users: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse

#batch_delete_user_links(request, options = nil) ⇒ ::Google::Protobuf::Empty #batch_delete_user_links(parent: nil, requests: nil) ⇒ ::Google::Protobuf::Empty

#batch_get_user_links(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse #batch_get_user_links(parent: nil, names: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse

#batch_update_user_links(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse #batch_update_user_links(parent: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse

#cancel_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal #cancel_display_video360_advertiser_link_proposal(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

#configure {|config| ... } ⇒ Client::Configuration

#create_conversion_event(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent #create_conversion_event(conversion_event: nil, parent: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent

#create_custom_dimension(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension #create_custom_dimension(parent: nil, custom_dimension: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

#create_custom_metric(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric #create_custom_metric(parent: nil, custom_metric: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

#create_firebase_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::FirebaseLink #create_firebase_link(parent: nil, firebase_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::FirebaseLink

#create_google_ads_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink #create_google_ads_link(parent: nil, google_ads_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink

#create_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret #create_measurement_protocol_secret(parent: nil, measurement_protocol_secret: nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

#create_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property #create_property(property: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

#create_user_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink #create_user_link(parent: nil, notify_new_user: nil, user_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

#create_web_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream #create_web_data_stream(web_data_stream: nil, parent: nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

#delete_account(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_account(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_android_app_data_stream(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_android_app_data_stream(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_conversion_event(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_conversion_event(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_display_video360_advertiser_link(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_display_video360_advertiser_link(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_display_video360_advertiser_link_proposal(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_firebase_link(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_firebase_link(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_google_ads_link(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_google_ads_link(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_ios_app_data_stream(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_ios_app_data_stream(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_measurement_protocol_secret(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property #delete_property(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

#delete_user_link(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_user_link(name: nil) ⇒ ::Google::Protobuf::Empty

#delete_web_data_stream(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_web_data_stream(name: nil) ⇒ ::Google::Protobuf::Empty

#get_account(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account #get_account(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account

#get_android_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream #get_android_app_data_stream(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream

#get_conversion_event(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent #get_conversion_event(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent

#get_custom_dimension(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension #get_custom_dimension(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

#get_custom_metric(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric #get_custom_metric(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

#get_data_retention_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings #get_data_retention_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings

#get_data_sharing_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataSharingSettings #get_data_sharing_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataSharingSettings

#get_display_video360_advertiser_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink #get_display_video360_advertiser_link(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink

#get_display_video360_advertiser_link_proposal(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal #get_display_video360_advertiser_link_proposal(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal

#get_enhanced_measurement_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings #get_enhanced_measurement_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings

#get_global_site_tag(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GlobalSiteTag #get_global_site_tag(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GlobalSiteTag

#get_google_signals_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings #get_google_signals_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings

#get_ios_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream #get_ios_app_data_stream(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream

#get_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret #get_measurement_protocol_secret(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

#get_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property #get_property(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Property

#get_user_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink #get_user_link(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::UserLink

#get_web_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream #get_web_data_stream(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::WebDataStream

#list_account_summaries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary> #list_account_summaries(page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>

#list_accounts(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account> #list_accounts(page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>

#list_conversion_events(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent> #list_conversion_events(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>

#list_custom_dimensions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension> #list_custom_dimensions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>

#list_custom_metrics(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric> #list_custom_metrics(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>

#list_firebase_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink> #list_firebase_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>

#list_google_ads_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink> #list_google_ads_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>

#list_ios_app_data_streams(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream> #list_ios_app_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>

#list_properties(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property> #list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>

#list_user_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink> #list_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>

#list_web_data_streams(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream> #list_web_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>

#provision_account_ticket(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse #provision_account_ticket(account: nil, redirect_uri: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse

#update_account(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account #update_account(account: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Account

#update_android_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream #update_android_app_data_stream(android_app_data_stream: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AndroidAppDataStream

#update_custom_dimension(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension #update_custom_dimension(custom_dimension: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension

#update_custom_metric(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric #update_custom_metric(custom_metric: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric

#update_data_retention_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings #update_data_retention_settings(data_retention_settings: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings

#update_enhanced_measurement_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings #update_enhanced_measurement_settings(enhanced_measurement_settings: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings

#update_google_ads_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink #update_google_ads_link(google_ads_link: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink

#update_google_signals_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings #update_google_signals_settings(google_signals_settings: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings

#update_ios_app_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream #update_ios_app_data_stream(ios_app_data_stream: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::IosAppDataStream

#update_measurement_protocol_secret(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret #update_measurement_protocol_secret(measurement_protocol_secret: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret

#initialize {|config| ... } ⇒ `Client`

.configure {|config| ... } ⇒ `Client::Configuration`

#archive_custom_dimension(request, options = nil) ⇒ `::Google::Protobuf::Empty` #archive_custom_dimension(name: nil) ⇒ `::Google::Protobuf::Empty`

#archive_custom_metric(request, options = nil) ⇒ `::Google::Protobuf::Empty` #archive_custom_metric(name: nil) ⇒ `::Google::Protobuf::Empty`

#audit_user_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>` #audit_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>`

#batch_create_user_links(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse` #batch_create_user_links(parent: nil, notify_new_users: nil, requests: nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse`

#batch_delete_user_links(request, options = nil) ⇒ `::Google::Protobuf::Empty` #batch_delete_user_links(parent: nil, requests: nil) ⇒ `::Google::Protobuf::Empty`

#batch_get_user_links(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse` #batch_get_user_links(parent: nil, names: nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse`

#batch_update_user_links(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse` #batch_update_user_links(parent: nil, requests: nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse`

#cancel_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal` #cancel_display_video360_advertiser_link_proposal(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal`

#configure {|config| ... } ⇒ `Client::Configuration`

#create_conversion_event(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent` #create_conversion_event(conversion_event: nil, parent: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent`

#create_custom_dimension(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension` #create_custom_dimension(parent: nil, custom_dimension: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension`

#create_custom_metric(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric` #create_custom_metric(parent: nil, custom_metric: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric`

#create_firebase_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::FirebaseLink` #create_firebase_link(parent: nil, firebase_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::FirebaseLink`

#create_google_ads_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink` #create_google_ads_link(parent: nil, google_ads_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink`

#create_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret` #create_measurement_protocol_secret(parent: nil, measurement_protocol_secret: nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret`

#create_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #create_property(property: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

#create_user_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink` #create_user_link(parent: nil, notify_new_user: nil, user_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink`

#create_web_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream` #create_web_data_stream(web_data_stream: nil, parent: nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream`

#delete_account(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_account(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_android_app_data_stream(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_android_app_data_stream(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_conversion_event(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_conversion_event(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_display_video360_advertiser_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_display_video360_advertiser_link(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_display_video360_advertiser_link_proposal(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_firebase_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_firebase_link(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_google_ads_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_google_ads_link(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_ios_app_data_stream(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_ios_app_data_stream(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_measurement_protocol_secret(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #delete_property(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

#delete_user_link(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_user_link(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_web_data_stream(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_web_data_stream(name: nil) ⇒ `::Google::Protobuf::Empty`

#get_account(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account` #get_account(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account`

#get_android_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream` #get_android_app_data_stream(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream`

#get_conversion_event(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent` #get_conversion_event(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ConversionEvent`

#get_custom_dimension(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension` #get_custom_dimension(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension`

#get_custom_metric(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric` #get_custom_metric(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric`

#get_data_retention_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings` #get_data_retention_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings`

#get_data_sharing_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataSharingSettings` #get_data_sharing_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataSharingSettings`

#get_display_video360_advertiser_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink` #get_display_video360_advertiser_link(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink`

#get_display_video360_advertiser_link_proposal(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal` #get_display_video360_advertiser_link_proposal(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal`

#get_enhanced_measurement_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings` #get_enhanced_measurement_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings`

#get_global_site_tag(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GlobalSiteTag` #get_global_site_tag(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GlobalSiteTag`

#get_google_signals_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings` #get_google_signals_settings(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings`

#get_ios_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream` #get_ios_app_data_stream(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream`

#get_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret` #get_measurement_protocol_secret(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret`

#get_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #get_property(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

#get_user_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink` #get_user_link(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink`

#get_web_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream` #get_web_data_stream(name: nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream`

#list_account_summaries(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>` #list_account_summaries(page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>`

#list_accounts(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>` #list_accounts(page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>`

#list_conversion_events(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>` #list_conversion_events(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>`

#list_custom_dimensions(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>` #list_custom_dimensions(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>`

#list_custom_metrics(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>` #list_custom_metrics(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>`

#list_firebase_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>` #list_firebase_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>`

#list_google_ads_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>` #list_google_ads_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>`

#list_ios_app_data_streams(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>` #list_ios_app_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::IosAppDataStream>`

#list_properties(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>` #list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>`

#list_user_links(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>` #list_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>`

#list_web_data_streams(request, options = nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>` #list_web_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::PagedEnumerable<::Google::Analytics::Admin::V1alpha::WebDataStream>`

#provision_account_ticket(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse` #provision_account_ticket(account: nil, redirect_uri: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse`

#update_account(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account` #update_account(account: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Account`

#update_android_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream` #update_android_app_data_stream(android_app_data_stream: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AndroidAppDataStream`

#update_custom_dimension(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension` #update_custom_dimension(custom_dimension: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomDimension`

#update_custom_metric(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric` #update_custom_metric(custom_metric: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CustomMetric`

#update_data_retention_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings` #update_data_retention_settings(data_retention_settings: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataRetentionSettings`

#update_enhanced_measurement_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings` #update_enhanced_measurement_settings(enhanced_measurement_settings: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings`

#update_google_ads_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink` #update_google_ads_link(google_ads_link: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleAdsLink`

#update_google_signals_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings` #update_google_signals_settings(google_signals_settings: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings`

#update_ios_app_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream` #update_ios_app_data_stream(ios_app_data_stream: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::IosAppDataStream`

#update_measurement_protocol_secret(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret` #update_measurement_protocol_secret(measurement_protocol_secret: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret`

#update_property(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property` #update_property(property: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Property`

#update_user_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink` #update_user_link(user_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::UserLink`

#update_web_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream` #update_web_data_stream(web_data_stream: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::WebDataStream`