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

Inherits:

Object

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

show all

Includes:: Paths

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

Overview

REST 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

#acknowledge_user_data_collection(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse
Acknowledges the terms of user data collection for the specified property.
#approve_display_video360_advertiser_link_proposal(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse
Approves a DisplayVideo360AdvertiserLinkProposal.
#archive_audience(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Archives an Audience on a property.
#archive_custom_dimension(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Archives a CustomDimension on a property.
#archive_custom_metric(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Archives a CustomMetric on a property.
#audit_user_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::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_access_bindings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse
Creates information about multiple access bindings to an account or property.
#batch_create_user_links(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse
Creates information about multiple users' links to an account or property.
#batch_delete_access_bindings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes information about multiple users' links to an account or property.
#batch_delete_user_links(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes information about multiple users' links to an account or property.
#batch_get_access_bindings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse
Gets information about multiple access bindings to an account or property.
#batch_get_user_links(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse
Gets information about multiple users' links to an account or property.
#batch_update_access_bindings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse
Updates information about multiple access bindings to an account or property.
#batch_update_user_links(request, options = nil) {|result, 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) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal
Cancels a DisplayVideo360AdvertiserLinkProposal.
#configure {|config| ... } ⇒ Client::Configuration
Configure the AnalyticsAdminService Client instance.
#create_access_binding(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding
Creates an access binding on an account or property.
#create_ad_sense_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink
Creates an AdSenseLink.
#create_audience(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Audience
Creates an Audience.
#create_channel_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup
Creates a ChannelGroup.
#create_connected_site_tag(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse
Creates a connected site tag for a Universal Analytics property.
#create_conversion_event(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent
Creates a conversion event with the specified attributes.
#create_custom_dimension(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension
Creates a CustomDimension.
#create_custom_metric(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric
Creates a CustomMetric.
#create_data_stream(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataStream
Creates a DataStream.
#create_display_video360_advertiser_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink
Creates a DisplayVideo360AdvertiserLink.
#create_display_video360_advertiser_link_proposal(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal
Creates a DisplayVideo360AdvertiserLinkProposal.
#create_event_create_rule(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule
Creates an EventCreateRule.
#create_expanded_data_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet
Creates a ExpandedDataSet.
#create_firebase_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::FirebaseLink
Creates a FirebaseLink.
#create_google_ads_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink
Creates a GoogleAdsLink.
#create_measurement_protocol_secret(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
Creates a measurement protocol secret.
#create_property(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Creates an "GA4" property with the specified location and attributes.
#create_search_ads360_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link
Creates a SearchAds360Link.
#create_sk_ad_network_conversion_value_schema(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema
Creates a SKAdNetworkConversionValueSchema.
#create_user_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::UserLink
Creates a user link on an account or property.
#delete_access_binding(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an access binding on an account or property.
#delete_account(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Marks target Account as soft-deleted (ie: "trashed") and returns it.
#delete_ad_sense_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an AdSenseLink.
#delete_channel_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a ChannelGroup on a property.
#delete_connected_site_tag(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a connected site tag for a Universal Analytics property.
#delete_conversion_event(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a conversion event in a property.
#delete_data_stream(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a DataStream on a property.
#delete_display_video360_advertiser_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a DisplayVideo360AdvertiserLink on a property.
#delete_display_video360_advertiser_link_proposal(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
#delete_event_create_rule(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an EventCreateRule.
#delete_expanded_data_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a ExpandedDataSet on a property.
#delete_firebase_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a FirebaseLink on a property.
#delete_google_ads_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a GoogleAdsLink on a property.
#delete_measurement_protocol_secret(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes target MeasurementProtocolSecret.
#delete_property(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Marks target Property as soft-deleted (ie: "trashed") and returns it.
#delete_search_ads360_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a SearchAds360Link on a property.
#delete_sk_ad_network_conversion_value_schema(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes target SKAdNetworkConversionValueSchema.
#delete_user_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a user link on an account or property.
#fetch_automated_ga4_configuration_opt_out(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse
Fetches the opt out status for the automated GA4 setup process for a UA property.
#fetch_connected_ga4_property(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse
Given a specified UA property, looks up the GA4 property connected to it.
#get_access_binding(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding
Gets information about an access binding.
#get_account(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Account
Lookup for a single Account.
#get_ad_sense_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink
Looks up a single AdSenseLink.
#get_attribution_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AttributionSettings
Lookup for a AttributionSettings singleton.
#get_audience(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Audience
Lookup for a single Audience.
#get_big_query_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::BigQueryLink
Lookup for a single BigQuery Link.
#get_channel_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup
Lookup for a single ChannelGroup.
#get_conversion_event(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent
Retrieve a single conversion event.
#get_custom_dimension(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension
Lookup for a single CustomDimension.
#get_custom_metric(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric
Lookup for a single CustomMetric.
#get_data_retention_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings
Returns the singleton data retention settings for this property.
#get_data_sharing_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataSharingSettings
Get data sharing settings on an account.
#get_data_stream(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataStream
Lookup for a single DataStream.
#get_display_video360_advertiser_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink
Look up a single DisplayVideo360AdvertiserLink.
#get_display_video360_advertiser_link_proposal(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
#get_enhanced_measurement_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
Returns the enhanced measurement settings for this data stream.
#get_event_create_rule(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule
Lookup for a single EventCreateRule.
#get_expanded_data_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet
Lookup for a single ExpandedDataSet.
#get_global_site_tag(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GlobalSiteTag
Returns the Site Tag for the specified web stream.
#get_google_signals_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings
Lookup for Google Signals settings for a property.
#get_measurement_protocol_secret(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
Lookup for a single "GA4" MeasurementProtocolSecret.
#get_property(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Lookup for a single "GA4" Property.
#get_search_ads360_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link
Look up a single SearchAds360Link.
#get_sk_ad_network_conversion_value_schema(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema
Looks up a single SKAdNetworkConversionValueSchema.
#get_user_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::UserLink
Gets information about a user's link to an account or property.
#initialize {|config| ... } ⇒ Client constructor
Create a new AnalyticsAdminService REST client object.
#list_access_bindings(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>
Lists all access bindings on an account or property.
#list_account_summaries(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>
Returns summaries of all accounts accessible by the caller.
#list_accounts(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>
Returns all accounts accessible by the caller.
#list_ad_sense_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>
Lists AdSenseLinks on a property.
#list_audiences(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Audience>
Lists Audiences on a property.
#list_big_query_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>
Lists BigQuery Links on a property.
#list_channel_groups(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>
Lists ChannelGroups on a property.
#list_connected_site_tags(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse
Lists the connected site tags for a Universal Analytics property.
#list_conversion_events(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>
Returns a list of conversion events in the specified parent property.
#list_custom_dimensions(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>
Lists CustomDimensions on a property.
#list_custom_metrics(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>
Lists CustomMetrics on a property.
#list_data_streams(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DataStream>
Lists DataStreams on a property.
#list_display_video360_advertiser_link_proposals(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>
Lists DisplayVideo360AdvertiserLinkProposals on a property.
#list_display_video360_advertiser_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>
Lists all DisplayVideo360AdvertiserLinks on a property.
#list_event_create_rules(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>
Lists EventCreateRules on a web data stream.
#list_expanded_data_sets(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>
Lists ExpandedDataSets on a property.
#list_firebase_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>
Lists FirebaseLinks on a property.
#list_google_ads_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>
Lists GoogleAdsLinks on a property.
#list_measurement_protocol_secrets(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>
Returns child MeasurementProtocolSecrets under the specified parent Property.
#list_properties(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>
Returns child Properties under the specified parent Account.
#list_search_ads360_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>
Lists all SearchAds360Links on a property.
#list_sk_ad_network_conversion_value_schemas(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema>
Lists SKAdNetworkConversionValueSchema on a stream.
#list_user_links(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>
Lists all user links on an account or property.
#provision_account_ticket(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse
Requests a ticket for creating an account.
#run_access_report(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::RunAccessReportResponse
Returns a customized report of data access records.
#search_change_history_events(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>
Searches through all changes to an account or its children given the specified set of filters.
#set_automated_ga4_configuration_opt_out(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse
Sets the opt out status for the automated GA4 setup process for a UA property.
#update_access_binding(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding
Updates an access binding on an account or property.
#update_account(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Account
Updates an account.
#update_attribution_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::AttributionSettings
Updates attribution settings on a property.
#update_audience(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Audience
Updates an Audience on a property.
#update_channel_group(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup
Updates a ChannelGroup.
#update_conversion_event(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent
Updates a conversion event with the specified attributes.
#update_custom_dimension(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension
Updates a CustomDimension on a property.
#update_custom_metric(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric
Updates a CustomMetric on a property.
#update_data_retention_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataRetentionSettings
Updates the singleton data retention settings for this property.
#update_data_stream(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DataStream
Updates a DataStream on a property.
#update_display_video360_advertiser_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink
Updates a DisplayVideo360AdvertiserLink on a property.
#update_enhanced_measurement_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings
Updates the enhanced measurement settings for this data stream.
#update_event_create_rule(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule
Updates an EventCreateRule.
#update_expanded_data_set(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet
Updates a ExpandedDataSet on a property.
#update_google_ads_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleAdsLink
Updates a GoogleAdsLink on a property.
#update_google_signals_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings
Updates Google Signals settings for a property.
#update_measurement_protocol_secret(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret
Updates a measurement protocol secret.
#update_property(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::Property
Updates a property.
#update_search_ads360_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link
Updates a SearchAds360Link on a property.
#update_sk_ad_network_conversion_value_schema(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema
Updates a SKAdNetworkConversionValueSchema.
#update_user_link(request, options = nil) {|result, operation| ... } ⇒ ::Google::Analytics::Admin::V1alpha::UserLink
Updates a user link on an account or property.

Methods included from Paths

#access_binding_path, #account_path, #ad_sense_link_path, #attribution_settings_path, #audience_path, #big_query_link_path, #channel_group_path, #conversion_event_path, #custom_dimension_path, #custom_metric_path, #data_retention_settings_path, #data_sharing_settings_path, #data_stream_path, #display_video360_advertiser_link_path, #display_video360_advertiser_link_proposal_path, #enhanced_measurement_settings_path, #event_create_rule_path, #expanded_data_set_path, #firebase_link_path, #global_site_tag_path, #google_ads_link_path, #google_signals_settings_path, #measurement_protocol_secret_path, #property_path, #search_ads360_link_path, #sk_ad_network_conversion_value_schema_path, #user_link_path

Constructor Details

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

Create a new AnalyticsAdminService REST client object.

Examples:


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

# Create a client using a custom configuration
client = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::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/rest/client.rb', line 176

def initialize
  # 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 == Configuration::DEFAULT_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 = ::Google::Analytics::Admin::V1alpha::AnalyticsAdminService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
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::Rest::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/rest/client.rb', line 58

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.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.rpcs.get_enhanced_measurement_settings.timeout = 60.0

    default_config.rpcs.update_enhanced_measurement_settings.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#acknowledge_user_data_collection(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse` #acknowledge_user_data_collection(property: nil, acknowledgement: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse`

Acknowledges the terms of user data collection for the specified property.

This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may 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::Rest::Client.new

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

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

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

Overloads:

#acknowledge_user_data_collection(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse

Pass arguments to acknowledge_user_data_collection via a request object, either of type Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionRequest, ::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.
#acknowledge_user_data_collection(property: nil, acknowledgement: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse

Pass arguments to acknowledge_user_data_collection 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 (::String) (defaults to: nil) —
  Required. The property for which to acknowledge user data collection.
- acknowledgement (::String) (defaults to: nil) —
  Required. An acknowledgement that the caller of this method understands the terms of user data collection.
  
  This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.acknowledge_user_data_collection.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.acknowledge_user_data_collection.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.acknowledge_user_data_collection.retry_policy

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

  @analytics_admin_service_stub.acknowledge_user_data_collection request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ApproveDisplayVideo360AdvertiserLinkProposalResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.approve_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.approve_display_video360_advertiser_link_proposal.timeout,
                         metadata:     call_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.approve_display_video360_advertiser_link_proposal request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Archives an Audience 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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to archive_audience via a request object, either of type Google::Analytics::Admin::V1alpha::ArchiveAudienceRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ArchiveAudienceRequest, ::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_audience(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to archive_audience 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/audiences/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.archive_audience.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.archive_audience.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.archive_audience.retry_policy

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

  @analytics_admin_service_stub.archive_audience request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.archive_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.archive_custom_dimension.timeout,
                         metadata:     call_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.archive_custom_dimension request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.archive_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.archive_custom_metric.timeout,
                         metadata:     call_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.archive_custom_metric request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#audit_user_links(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>` #audit_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::AuditUserLink.
  p item
end

Overloads:

#audit_user_links(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.audit_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.audit_user_links.timeout,
                         metadata:     call_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.audit_user_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :audit_user_links, "user_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Creates information about multiple access bindings to an account or property.

This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings 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::Rest::Client.new

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

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

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

Overloads:

#batch_create_access_bindings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse

Pass arguments to batch_create_access_bindings via a request object, either of type BatchCreateAccessBindingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsRequest, ::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_access_bindings(parent: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse

Pass arguments to batch_create_access_bindings 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 owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats:
  - accounts/{account}
  - properties/{property}
- requests (::Array<::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest, ::Hash>) (defaults to: nil) —
  Required. The requests specifying the access bindings to create. A maximum of 1000 access bindings can be created in a batch.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.batch_create_access_bindings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_create_access_bindings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_create_access_bindings.retry_policy

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

  @analytics_admin_service_stub.batch_create_access_bindings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::BatchCreateUserLinksResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.batch_create_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_create_user_links.timeout,
                         metadata:     call_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.batch_create_user_links request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_delete_access_bindings(request, options = nil) ⇒ `::Google::Protobuf::Empty` #batch_delete_access_bindings(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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to batch_delete_access_bindings via a request object, either of type BatchDeleteAccessBindingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchDeleteAccessBindingsRequest, ::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_access_bindings(parent: nil, requests: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to batch_delete_access_bindings 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 owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this field. Formats:
  - accounts/{account}
  - properties/{property}
- requests (::Array<::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest, ::Hash>) (defaults to: nil) —
  Required. The requests specifying the access bindings to delete. A maximum of 1000 access bindings can be deleted in a batch.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.batch_delete_access_bindings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_delete_access_bindings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_delete_access_bindings.retry_policy

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

  @analytics_admin_service_stub.batch_delete_access_bindings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.batch_delete_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_delete_user_links.timeout,
                         metadata:     call_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.batch_delete_user_links request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Gets information about multiple access bindings 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::Rest::Client.new

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

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

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

Overloads:

#batch_get_access_bindings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse

Pass arguments to batch_get_access_bindings via a request object, either of type BatchGetAccessBindingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsRequest, ::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_access_bindings(parent: nil, names: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse

Pass arguments to batch_get_access_bindings 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 owns the access bindings. The parent of all provided values for the 'names' field must match this field. Formats:
  - accounts/{account}
  - properties/{property}
- names (::Array<::String>) (defaults to: nil) —
  Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats:
  - accounts/{account}/accessBindings/{accessBinding}
  - properties/{property}/accessBindings/{accessBinding}

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.batch_get_access_bindings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_get_access_bindings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_get_access_bindings.retry_policy

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

  @analytics_admin_service_stub.batch_get_access_bindings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::BatchGetUserLinksResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.batch_get_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_get_user_links.timeout,
                         metadata:     call_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.batch_get_user_links request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Updates information about multiple access bindings 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::Rest::Client.new

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

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

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

Overloads:

#batch_update_access_bindings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse

Pass arguments to batch_update_access_bindings via a request object, either of type BatchUpdateAccessBindingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsRequest, ::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_access_bindings(parent: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse

Pass arguments to batch_update_access_bindings 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 owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
  - accounts/{account}
  - properties/{property}
- requests (::Array<::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest, ::Hash>) (defaults to: nil) —
  Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.batch_update_access_bindings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_update_access_bindings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_update_access_bindings.retry_policy

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

  @analytics_admin_service_stub.batch_update_access_bindings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::BatchUpdateUserLinksResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.batch_update_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_update_user_links.timeout,
                         metadata:     call_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.batch_update_user_links request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.cancel_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.cancel_display_video360_advertiser_link_proposal.timeout,
                         metadata:     call_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.cancel_display_video360_advertiser_link_proposal request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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/rest/client.rb', line 155

def configure
  yield @config if block_given?
  @config
end

#create_access_binding(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AccessBinding` #create_access_binding(parent: nil, access_binding: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AccessBinding`

Creates an access binding 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::Rest::Client.new

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

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

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

Overloads:

#create_access_binding(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding

Pass arguments to create_access_binding via a request object, either of type CreateAccessBindingRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateAccessBindingRequest, ::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_access_binding(parent: nil, access_binding: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding

Pass arguments to create_access_binding 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. Formats:
  - accounts/{account}
  - properties/{property}
- access_binding (::Google::Analytics::Admin::V1alpha::AccessBinding, ::Hash) (defaults to: nil) —
  Required. The access binding to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AccessBinding)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AccessBinding)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_access_binding.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_access_binding.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_access_binding.retry_policy

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

  @analytics_admin_service_stub.create_access_binding request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_ad_sense_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AdSenseLink` #create_ad_sense_link(parent: nil, adsense_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AdSenseLink`

Creates an AdSenseLink.

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::Rest::Client.new

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

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

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

Overloads:

#create_ad_sense_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink

Pass arguments to create_ad_sense_link via a request object, either of type CreateAdSenseLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateAdSenseLinkRequest, ::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_ad_sense_link(parent: nil, adsense_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink

Pass arguments to create_ad_sense_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. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234
- adsense_link (::Google::Analytics::Admin::V1alpha::AdSenseLink, ::Hash) (defaults to: nil) —
  Required. The AdSense Link to create

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AdSenseLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AdSenseLink)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_ad_sense_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_ad_sense_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_ad_sense_link.retry_policy

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

  @analytics_admin_service_stub.create_ad_sense_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_audience(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Audience` #create_audience(parent: nil, audience: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Audience`

Creates an Audience.

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::Rest::Client.new

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

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

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

Overloads:

#create_audience(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience

Pass arguments to create_audience via a request object, either of type CreateAudienceRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateAudienceRequest, ::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_audience(parent: nil, audience: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience

Pass arguments to create_audience 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
- audience (::Google::Analytics::Admin::V1alpha::Audience, ::Hash) (defaults to: nil) —
  Required. The audience to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Audience)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::Audience)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_audience.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_audience.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_audience.retry_policy

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

  @analytics_admin_service_stub.create_audience request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_channel_group(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ChannelGroup` #create_channel_group(parent: nil, channel_group: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ChannelGroup`

Creates a ChannelGroup.

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::Rest::Client.new

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

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

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

Overloads:

#create_channel_group(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup

Pass arguments to create_channel_group via a request object, either of type CreateChannelGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateChannelGroupRequest, ::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_channel_group(parent: nil, channel_group: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup

Pass arguments to create_channel_group 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 property for which to create a ChannelGroup. Example format: properties/1234
- channel_group (::Google::Analytics::Admin::V1alpha::ChannelGroup, ::Hash) (defaults to: nil) —
  Required. The ChannelGroup to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ChannelGroup)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ChannelGroup)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_channel_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_channel_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_channel_group.retry_policy

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

  @analytics_admin_service_stub.create_channel_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_connected_site_tag(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse` #create_connected_site_tag(property: nil, connected_site_tag: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse`

Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.

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::Rest::Client.new

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

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

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

Overloads:

#create_connected_site_tag(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse

Pass arguments to create_connected_site_tag via a request object, either of type CreateConnectedSiteTagRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagRequest, ::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_connected_site_tag(property: nil, connected_site_tag: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse

Pass arguments to create_connected_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:
- property (::String) (defaults to: nil) —
  The Universal Analytics property to create connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234
- connected_site_tag (::Google::Analytics::Admin::V1alpha::ConnectedSiteTag, ::Hash) (defaults to: nil) —
  Required. The tag to add to the Universal Analytics property

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_connected_site_tag.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_connected_site_tag.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_connected_site_tag.retry_policy

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

  @analytics_admin_service_stub.create_connected_site_tag request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ConversionEvent)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_conversion_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_conversion_event.timeout,
                         metadata:     call_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.create_conversion_event request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::CustomDimension)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_custom_dimension.timeout,
                         metadata:     call_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.create_custom_dimension request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::CustomMetric)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_custom_metric.timeout,
                         metadata:     call_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.create_custom_metric request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataStream` #create_data_stream(parent: nil, data_stream: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataStream`

Creates a DataStream.

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::Rest::Client.new

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

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

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

Overloads:

#create_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataStream

Pass arguments to create_data_stream via a request object, either of type CreateDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateDataStreamRequest, ::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_data_stream(parent: nil, data_stream: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataStream

Pass arguments to create_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:
- parent (::String) (defaults to: nil) —
  Required. Example format: properties/1234
- data_stream (::Google::Analytics::Admin::V1alpha::DataStream, ::Hash) (defaults to: nil) —
  Required. The DataStream to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DataStream)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataStream)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_data_stream.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_data_stream.retry_policy

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

  @analytics_admin_service_stub.create_data_stream request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_display_video360_advertiser_link.timeout,
                         metadata:     call_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.create_display_video360_advertiser_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_display_video360_advertiser_link_proposal.timeout,
                         metadata:     call_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.create_display_video360_advertiser_link_proposal request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_event_create_rule(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::EventCreateRule` #create_event_create_rule(parent: nil, event_create_rule: nil) ⇒ `::Google::Analytics::Admin::V1alpha::EventCreateRule`

Creates an EventCreateRule.

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::Rest::Client.new

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

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

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

Overloads:

#create_event_create_rule(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule

Pass arguments to create_event_create_rule via a request object, either of type CreateEventCreateRuleRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateEventCreateRuleRequest, ::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_event_create_rule(parent: nil, event_create_rule: nil) ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule

Pass arguments to create_event_create_rule 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/123/dataStreams/456
- event_create_rule (::Google::Analytics::Admin::V1alpha::EventCreateRule, ::Hash) (defaults to: nil) —
  Required. The EventCreateRule to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::EventCreateRule)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::EventCreateRule)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_event_create_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_event_create_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_event_create_rule.retry_policy

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

  @analytics_admin_service_stub.create_event_create_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_expanded_data_set(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ExpandedDataSet` #create_expanded_data_set(parent: nil, expanded_data_set: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ExpandedDataSet`

Creates a ExpandedDataSet.

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::Rest::Client.new

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

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

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

Overloads:

#create_expanded_data_set(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet

Pass arguments to create_expanded_data_set via a request object, either of type CreateExpandedDataSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateExpandedDataSetRequest, ::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_expanded_data_set(parent: nil, expanded_data_set: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet

Pass arguments to create_expanded_data_set 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
- expanded_data_set (::Google::Analytics::Admin::V1alpha::ExpandedDataSet, ::Hash) (defaults to: nil) —
  Required. The ExpandedDataSet to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ExpandedDataSet)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ExpandedDataSet)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_expanded_data_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_expanded_data_set.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_expanded_data_set.retry_policy

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

  @analytics_admin_service_stub.create_expanded_data_set request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::FirebaseLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_firebase_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_firebase_link.timeout,
                         metadata:     call_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.create_firebase_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::GoogleAdsLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_google_ads_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_google_ads_link.timeout,
                         metadata:     call_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.create_google_ads_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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. Format: properties/{property}/dataStreams/{dataStream}
- measurement_protocol_secret (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret, ::Hash) (defaults to: nil) —
  Required. The measurement protocol secret to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_measurement_protocol_secret.timeout,
                         metadata:     call_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.create_measurement_protocol_secret request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Property)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_property.timeout,
                         metadata:     call_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.create_property request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_search_ads360_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::SearchAds360Link` #create_search_ads360_link(parent: nil, search_ads_360_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::SearchAds360Link`

Creates a SearchAds360Link.

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::Rest::Client.new

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

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

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

Overloads:

#create_search_ads360_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link

Pass arguments to create_search_ads360_link via a request object, either of type CreateSearchAds360LinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateSearchAds360LinkRequest, ::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_search_ads360_link(parent: nil, search_ads_360_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link

Pass arguments to create_search_ads360_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
- search_ads_360_link (::Google::Analytics::Admin::V1alpha::SearchAds360Link, ::Hash) (defaults to: nil) —
  Required. The SearchAds360Link to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::SearchAds360Link)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::SearchAds360Link)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_search_ads360_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_search_ads360_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_search_ads360_link.retry_policy

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

  @analytics_admin_service_stub.create_search_ads360_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_sk_ad_network_conversion_value_schema(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema` #create_sk_ad_network_conversion_value_schema(parent: nil, skadnetwork_conversion_value_schema: nil) ⇒ `::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema`

Creates a SKAdNetworkConversionValueSchema.

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::Rest::Client.new

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

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

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

Overloads:

#create_sk_ad_network_conversion_value_schema(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema

Pass arguments to create_sk_ad_network_conversion_value_schema via a request object, either of type CreateSKAdNetworkConversionValueSchemaRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::CreateSKAdNetworkConversionValueSchemaRequest, ::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_sk_ad_network_conversion_value_schema(parent: nil, skadnetwork_conversion_value_schema: nil) ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema

Pass arguments to create_sk_ad_network_conversion_value_schema 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 schema will be created. Format: properties/{property}/dataStreams/{dataStream}
- skadnetwork_conversion_value_schema (::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema, ::Hash) (defaults to: nil) —
  Required. SKAdNetwork conversion value schema to create.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.create_sk_ad_network_conversion_value_schema.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_sk_ad_network_conversion_value_schema.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_sk_ad_network_conversion_value_schema.retry_policy

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

  @analytics_admin_service_stub.create_sk_ad_network_conversion_value_schema request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::UserLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.create_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_user_link.timeout,
                         metadata:     call_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.create_user_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes an access binding 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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_access_binding via a request object, either of type DeleteAccessBindingRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteAccessBindingRequest, ::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_access_binding(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_access_binding 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. Formats:
  - accounts/{account}/accessBindings/{accessBinding}
  - properties/{property}/accessBindings/{accessBinding}

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_access_binding.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_access_binding.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_access_binding.retry_policy

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

  @analytics_admin_service_stub.delete_access_binding request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_account.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_account.timeout,
                         metadata:     call_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.delete_account request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes an AdSenseLink.

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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_ad_sense_link via a request object, either of type DeleteAdSenseLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteAdSenseLinkRequest, ::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_ad_sense_link(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_ad_sense_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. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_ad_sense_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_ad_sense_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_ad_sense_link.retry_policy

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

  @analytics_admin_service_stub.delete_ad_sense_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a ChannelGroup 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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_channel_group via a request object, either of type DeleteChannelGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteChannelGroupRequest, ::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_channel_group(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_channel_group 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 ChannelGroup to delete. Example format: properties/1234/channelGroups/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_channel_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_channel_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_channel_group.retry_policy

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

  @analytics_admin_service_stub.delete_channel_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_connected_site_tag(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_connected_site_tag(property: nil, tag_id: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_connected_site_tag via a request object, either of type DeleteConnectedSiteTagRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteConnectedSiteTagRequest, ::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_connected_site_tag(property: nil, tag_id: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_connected_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:
- property (::String) (defaults to: nil) —
  The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234
- tag_id (::String) (defaults to: nil) —
  Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345).

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_connected_site_tag.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_connected_site_tag.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_connected_site_tag.retry_policy

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

  @analytics_admin_service_stub.delete_connected_site_tag request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_conversion_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_conversion_event.timeout,
                         metadata:     call_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.delete_conversion_event request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a DataStream 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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_data_stream via a request object, either of type DeleteDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteDataStreamRequest, ::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_data_stream(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_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 DataStream to delete. Example format: properties/1234/dataStreams/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_data_stream.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_data_stream.retry_policy

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

  @analytics_admin_service_stub.delete_data_stream request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_display_video360_advertiser_link.timeout,
                         metadata:     call_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.delete_display_video360_advertiser_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_display_video360_advertiser_link_proposal.timeout,
                         metadata:     call_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.delete_display_video360_advertiser_link_proposal request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes an EventCreateRule.

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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_event_create_rule via a request object, either of type DeleteEventCreateRuleRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteEventCreateRuleRequest, ::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_event_create_rule(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_event_create_rule 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/123/dataStreams/456/eventCreateRules/789

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_event_create_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_event_create_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_event_create_rule.retry_policy

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

  @analytics_admin_service_stub.delete_event_create_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a ExpandedDataSet 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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_expanded_data_set via a request object, either of type DeleteExpandedDataSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteExpandedDataSetRequest, ::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_expanded_data_set(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_expanded_data_set 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/expandedDataSets/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_expanded_data_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_expanded_data_set.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_expanded_data_set.retry_policy

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

  @analytics_admin_service_stub.delete_expanded_data_set request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_firebase_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_firebase_link.timeout,
                         metadata:     call_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.delete_firebase_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_google_ads_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_google_ads_link.timeout,
                         metadata:     call_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.delete_google_ads_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_measurement_protocol_secret.timeout,
                         metadata:     call_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.delete_measurement_protocol_secret request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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 a 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Property)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_property.timeout,
                         metadata:     call_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.delete_property request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a SearchAds360Link 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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_search_ads360_link via a request object, either of type DeleteSearchAds360LinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteSearchAds360LinkRequest, ::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_search_ads360_link(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_search_ads360_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 SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_search_ads360_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_search_ads360_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_search_ads360_link.retry_policy

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

  @analytics_admin_service_stub.delete_search_ads360_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes target SKAdNetworkConversionValueSchema.

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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to delete_sk_ad_network_conversion_value_schema via a request object, either of type DeleteSKAdNetworkConversionValueSchemaRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::DeleteSKAdNetworkConversionValueSchemaRequest, ::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_sk_ad_network_conversion_value_schema(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_sk_ad_network_conversion_value_schema 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 SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.delete_sk_ad_network_conversion_value_schema.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_sk_ad_network_conversion_value_schema.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_sk_ad_network_conversion_value_schema.retry_policy

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

  @analytics_admin_service_stub.delete_sk_ad_network_conversion_value_schema request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

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

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

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
  call_metadata = @config.rpcs.delete_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_user_link.timeout,
                         metadata:     call_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.delete_user_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on 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::Rest::Client.new

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

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

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

Overloads:

#fetch_automated_ga4_configuration_opt_out(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse

Pass arguments to fetch_automated_ga4_configuration_opt_out via a request object, either of type FetchAutomatedGa4ConfigurationOptOutRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutRequest, ::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.
#fetch_automated_ga4_configuration_opt_out(property: nil) ⇒ ::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse

Pass arguments to fetch_automated_ga4_configuration_opt_out 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 (::String) (defaults to: nil) —
  Required. The UA property to get the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::FetchAutomatedGa4ConfigurationOptOutResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.fetch_automated_ga4_configuration_opt_out.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_automated_ga4_configuration_opt_out.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.fetch_automated_ga4_configuration_opt_out.retry_policy

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

  @analytics_admin_service_stub.fetch_automated_ga4_configuration_opt_out request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

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::Rest::Client.new

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

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

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

Overloads:

#fetch_connected_ga4_property(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse

Pass arguments to fetch_connected_ga4_property via a request object, either of type FetchConnectedGa4PropertyRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyRequest, ::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.
#fetch_connected_ga4_property(property: nil) ⇒ ::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse

Pass arguments to fetch_connected_ga4_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 (::String) (defaults to: nil) —
  Required. The UA property for which to look up the connected GA4 property. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internal_web_property_id} Example: properties/1234

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::FetchConnectedGa4PropertyResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.fetch_connected_ga4_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_connected_ga4_property.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.fetch_connected_ga4_property.retry_policy

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

  @analytics_admin_service_stub.fetch_connected_ga4_property request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Gets information about an access binding.

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::Rest::Client.new

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

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

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

Overloads:

#get_access_binding(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding

Pass arguments to get_access_binding via a request object, either of type GetAccessBindingRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetAccessBindingRequest, ::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_access_binding(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding

Pass arguments to get_access_binding 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 access binding to retrieve. Formats:
  - accounts/{account}/accessBindings/{accessBinding}
  - properties/{property}/accessBindings/{accessBinding}

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AccessBinding)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AccessBinding)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_access_binding.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_access_binding.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_access_binding.retry_policy

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

  @analytics_admin_service_stub.get_access_binding request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Account)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_account.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_account.timeout,
                         metadata:     call_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.get_account request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Looks up a single AdSenseLink.

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::Rest::Client.new

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

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

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

Overloads:

#get_ad_sense_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink

Pass arguments to get_ad_sense_link via a request object, either of type GetAdSenseLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetAdSenseLinkRequest, ::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_ad_sense_link(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink

Pass arguments to get_ad_sense_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. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AdSenseLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AdSenseLink)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_ad_sense_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_ad_sense_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_ad_sense_link.retry_policy

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

  @analytics_admin_service_stub.get_ad_sense_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lookup for a AttributionSettings singleton.

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::Rest::Client.new

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

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

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

Overloads:

#get_attribution_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AttributionSettings

Pass arguments to get_attribution_settings via a request object, either of type GetAttributionSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetAttributionSettingsRequest, ::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_attribution_settings(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AttributionSettings

Pass arguments to get_attribution_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 attribution settings to retrieve. Format: properties/{property}/attributionSettings

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AttributionSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AttributionSettings)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_attribution_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_attribution_settings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_attribution_settings.retry_policy

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

  @analytics_admin_service_stub.get_attribution_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

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::Rest::Client.new

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

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

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

Overloads:

#get_audience(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience

Pass arguments to get_audience via a request object, either of type GetAudienceRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetAudienceRequest, ::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_audience(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience

Pass arguments to get_audience 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 Audience to get. Example format: properties/1234/audiences/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Audience)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::Audience)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_audience.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_audience.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_audience.retry_policy

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

  @analytics_admin_service_stub.get_audience request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lookup for a single BigQuery Link.

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::Rest::Client.new

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

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

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

Overloads:

#get_big_query_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BigQueryLink

Pass arguments to get_big_query_link via a request object, either of type GetBigQueryLinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetBigQueryLinkRequest, ::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_big_query_link(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BigQueryLink

Pass arguments to get_big_query_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 BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::BigQueryLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::BigQueryLink)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_big_query_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_big_query_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_big_query_link.retry_policy

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

  @analytics_admin_service_stub.get_big_query_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lookup for a single ChannelGroup.

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::Rest::Client.new

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

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

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

Overloads:

#get_channel_group(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup

Pass arguments to get_channel_group via a request object, either of type GetChannelGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetChannelGroupRequest, ::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_channel_group(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup

Pass arguments to get_channel_group 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 ChannelGroup to get. Example format: properties/1234/channelGroups/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ChannelGroup)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ChannelGroup)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_channel_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_channel_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_channel_group.retry_policy

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

  @analytics_admin_service_stub.get_channel_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ConversionEvent)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_conversion_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_conversion_event.timeout,
                         metadata:     call_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.get_conversion_event request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::CustomDimension)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_custom_dimension.timeout,
                         metadata:     call_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.get_custom_dimension request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::CustomMetric)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_custom_metric.timeout,
                         metadata:     call_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.get_custom_metric request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DataRetentionSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataRetentionSettings)

Raises:

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

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

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
  call_metadata = @config.rpcs.get_data_retention_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_data_retention_settings.timeout,
                         metadata:     call_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.get_data_retention_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DataSharingSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataSharingSettings)

Raises:

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

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

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
  call_metadata = @config.rpcs.get_data_sharing_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_data_sharing_settings.timeout,
                         metadata:     call_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.get_data_sharing_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lookup for a single DataStream.

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::Rest::Client.new

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

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

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

Overloads:

#get_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataStream

Pass arguments to get_data_stream via a request object, either of type GetDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetDataStreamRequest, ::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_stream(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataStream

Pass arguments to get_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 DataStream to get. Example format: properties/1234/dataStreams/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DataStream)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataStream)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_data_stream.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_data_stream.retry_policy

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

  @analytics_admin_service_stub.get_data_stream request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_display_video360_advertiser_link.timeout,
                         metadata:     call_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.get_display_video360_advertiser_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_display_video360_advertiser_link_proposal.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_display_video360_advertiser_link_proposal.timeout,
                         metadata:     call_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.get_display_video360_advertiser_link_proposal request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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 enhanced measurement settings for this data 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::Rest::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}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)

Raises:

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

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

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
  call_metadata = @config.rpcs.get_enhanced_measurement_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_enhanced_measurement_settings.timeout,
                         metadata:     call_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.get_enhanced_measurement_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lookup for a single EventCreateRule.

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::Rest::Client.new

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

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

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

Overloads:

#get_event_create_rule(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule

Pass arguments to get_event_create_rule via a request object, either of type GetEventCreateRuleRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetEventCreateRuleRequest, ::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_event_create_rule(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule

Pass arguments to get_event_create_rule 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 EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::EventCreateRule)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::EventCreateRule)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_event_create_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_event_create_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_event_create_rule.retry_policy

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

  @analytics_admin_service_stub.get_event_create_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lookup for a single ExpandedDataSet.

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::Rest::Client.new

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

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

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

Overloads:

#get_expanded_data_set(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet

Pass arguments to get_expanded_data_set via a request object, either of type GetExpandedDataSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetExpandedDataSetRequest, ::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_expanded_data_set(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet

Pass arguments to get_expanded_data_set 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 ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ExpandedDataSet)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ExpandedDataSet)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_expanded_data_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_expanded_data_set.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_expanded_data_set.retry_policy

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

  @analytics_admin_service_stub.get_expanded_data_set request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag"

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::GlobalSiteTag)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::GlobalSiteTag)

Raises:

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

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

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
  call_metadata = @config.rpcs.get_global_site_tag.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_global_site_tag.timeout,
                         metadata:     call_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.get_global_site_tag request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)

Raises:

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

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

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
  call_metadata = @config.rpcs.get_google_signals_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_google_signals_settings.timeout,
                         metadata:     call_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.get_google_signals_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_measurement_protocol_secret.timeout,
                         metadata:     call_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.get_measurement_protocol_secret request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Property)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_property.timeout,
                         metadata:     call_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.get_property request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Look up a single SearchAds360Link

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::Rest::Client.new

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

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

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

Overloads:

#get_search_ads360_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link

Pass arguments to get_search_ads360_link via a request object, either of type GetSearchAds360LinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetSearchAds360LinkRequest, ::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_search_ads360_link(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link

Pass arguments to get_search_ads360_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 SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::SearchAds360Link)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::SearchAds360Link)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_search_ads360_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_search_ads360_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_search_ads360_link.retry_policy

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

  @analytics_admin_service_stub.get_search_ads360_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Looks up a single SKAdNetworkConversionValueSchema.

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::Rest::Client.new

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

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

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

Overloads:

#get_sk_ad_network_conversion_value_schema(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema

Pass arguments to get_sk_ad_network_conversion_value_schema via a request object, either of type GetSKAdNetworkConversionValueSchemaRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::GetSKAdNetworkConversionValueSchemaRequest, ::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_sk_ad_network_conversion_value_schema(name: nil) ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema

Pass arguments to get_sk_ad_network_conversion_value_schema 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 SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.get_sk_ad_network_conversion_value_schema.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_sk_ad_network_conversion_value_schema.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_sk_ad_network_conversion_value_schema.retry_policy

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

  @analytics_admin_service_stub.get_sk_ad_network_conversion_value_schema request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::UserLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.get_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_user_link.timeout,
                         metadata:     call_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.get_user_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists all access bindings 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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::AccessBinding.
  p item
end

Overloads:

#list_access_bindings(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>

Pass arguments to list_access_bindings via a request object, either of type ListAccessBindingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListAccessBindingsRequest, ::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_access_bindings(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>

Pass arguments to list_access_bindings 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. Formats:
  - accounts/{account}
  - properties/{property}
- page_size (::Integer) (defaults to: nil) —
  The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings 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 ListAccessBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccessBindings must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccessBinding>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_access_bindings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_access_bindings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_access_bindings.retry_policy

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

  @analytics_admin_service_stub.list_access_bindings request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_access_bindings, "access_bindings", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_account_summaries(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>` #list_account_summaries(page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::AccountSummary.
  p item
end

Overloads:

#list_account_summaries(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AccountSummary>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_account_summaries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_account_summaries.timeout,
                         metadata:     call_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.list_account_summaries request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_account_summaries, "account_summaries", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_accounts(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>` #list_accounts(page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::Account.
  p item
end

Overloads:

#list_accounts(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Account>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_accounts.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_accounts.timeout,
                         metadata:     call_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.list_accounts request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_accounts, "accounts", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists AdSenseLinks 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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::AdSenseLink.
  p item
end

Overloads:

#list_ad_sense_links(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>

Pass arguments to list_ad_sense_links via a request object, either of type ListAdSenseLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListAdSenseLinksRequest, ::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_ad_sense_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>

Pass arguments to list_ad_sense_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. Resource name of the parent property. Format: properties/{propertyId} Example: 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 ListAdSenseLinks call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListAdSenseLinks must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AdSenseLink>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_ad_sense_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_ad_sense_links.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_ad_sense_links.retry_policy

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

  @analytics_admin_service_stub.list_ad_sense_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_ad_sense_links, "adsense_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::Audience.
  p item
end

Overloads:

#list_audiences(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Audience>

Pass arguments to list_audiences via a request object, either of type ListAudiencesRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListAudiencesRequest, ::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_audiences(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Audience>

Pass arguments to list_audiences 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 ListAudiences call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListAudiences must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Audience>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Audience>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_audiences.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_audiences.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_audiences.retry_policy

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

  @analytics_admin_service_stub.list_audiences request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_audiences, "audiences", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists BigQuery Links 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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::BigQueryLink.
  p item
end

Overloads:

#list_big_query_links(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>

Pass arguments to list_big_query_links via a request object, either of type ListBigQueryLinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListBigQueryLinksRequest, ::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_big_query_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>

Pass arguments to list_big_query_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 name of the property to list BigQuery links under. 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 ListBigQueryLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBigQueryLinks must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::BigQueryLink>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_big_query_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_big_query_links.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_big_query_links.retry_policy

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

  @analytics_admin_service_stub.list_big_query_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_big_query_links, "bigquery_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists ChannelGroups 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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::ChannelGroup.
  p item
end

Overloads:

#list_channel_groups(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>

Pass arguments to list_channel_groups via a request object, either of type ListChannelGroupsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListChannelGroupsRequest, ::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_channel_groups(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>

Pass arguments to list_channel_groups 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 property for which to list ChannelGroups. 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 ListChannelGroups call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListChannelGroups must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChannelGroup>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_channel_groups.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_channel_groups.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_channel_groups.retry_policy

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

  @analytics_admin_service_stub.list_channel_groups request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_channel_groups, "channel_groups", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on 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::Rest::Client.new

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

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

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

Overloads:

#list_connected_site_tags(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse

Pass arguments to list_connected_site_tags via a request object, either of type ListConnectedSiteTagsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsRequest, ::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_connected_site_tags(property: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse

Pass arguments to list_connected_site_tags 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 (::String) (defaults to: nil) —
  The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. A maximum of 20 connected site tags will be returned. Example Format: properties/1234

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ListConnectedSiteTagsResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_connected_site_tags.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_connected_site_tags.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_connected_site_tags.retry_policy

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

  @analytics_admin_service_stub.list_connected_site_tags request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_conversion_events(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>` #list_conversion_events(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::ConversionEvent.
  p item
end

Overloads:

#list_conversion_events(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ConversionEvent>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_conversion_events.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_conversion_events.timeout,
                         metadata:     call_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.list_conversion_events request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_conversion_events, "conversion_events", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_custom_dimensions(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>` #list_custom_dimensions(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomDimension.
  p item
end

Overloads:

#list_custom_dimensions(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomDimension>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_custom_dimensions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_custom_dimensions.timeout,
                         metadata:     call_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.list_custom_dimensions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_dimensions, "custom_dimensions", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_custom_metrics(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>` #list_custom_metrics(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::CustomMetric.
  p item
end

Overloads:

#list_custom_metrics(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::CustomMetric>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_custom_metrics.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_custom_metrics.timeout,
                         metadata:     call_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.list_custom_metrics request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_custom_metrics, "custom_metrics", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists DataStreams 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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::DataStream.
  p item
end

Overloads:

#list_data_streams(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DataStream>

Pass arguments to list_data_streams via a request object, either of type ListDataStreamsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListDataStreamsRequest, ::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_data_streams(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DataStream>

Pass arguments to list_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. 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 ListDataStreams call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListDataStreams must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DataStream>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DataStream>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_data_streams.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_data_streams.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_data_streams.retry_policy

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

  @analytics_admin_service_stub.list_data_streams request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_data_streams, "data_streams", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_display_video360_advertiser_link_proposals(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>` #list_display_video360_advertiser_link_proposals(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal.
  p item
end

Overloads:

#list_display_video360_advertiser_link_proposals(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLinkProposal>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_display_video360_advertiser_link_proposals.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_display_video360_advertiser_link_proposals.timeout,
                         metadata:     call_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.list_display_video360_advertiser_link_proposals request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_display_video360_advertiser_link_proposals, "display_video_360_advertiser_link_proposals", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_display_video360_advertiser_links(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>` #list_display_video360_advertiser_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink.
  p item
end

Overloads:

#list_display_video360_advertiser_links(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_display_video360_advertiser_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_display_video360_advertiser_links.timeout,
                         metadata:     call_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.list_display_video360_advertiser_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_display_video360_advertiser_links, "display_video_360_advertiser_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists EventCreateRules on a web data stream.

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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::EventCreateRule.
  p item
end

Overloads:

#list_event_create_rules(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>

Pass arguments to list_event_create_rules via a request object, either of type ListEventCreateRulesRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListEventCreateRulesRequest, ::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_event_create_rules(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>

Pass arguments to list_event_create_rules 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/123/dataStreams/456
- 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 ListEventCreateRules call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListEventCreateRules must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::EventCreateRule>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_event_create_rules.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_event_create_rules.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_event_create_rules.retry_policy

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

  @analytics_admin_service_stub.list_event_create_rules request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_event_create_rules, "event_create_rules", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists ExpandedDataSets 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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::ExpandedDataSet.
  p item
end

Overloads:

#list_expanded_data_sets(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>

Pass arguments to list_expanded_data_sets via a request object, either of type ListExpandedDataSetsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListExpandedDataSetsRequest, ::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_expanded_data_sets(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>

Pass arguments to list_expanded_data_sets 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 ListExpandedDataSets call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListExpandedDataSet must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ExpandedDataSet>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_expanded_data_sets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_expanded_data_sets.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_expanded_data_sets.retry_policy

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

  @analytics_admin_service_stub.list_expanded_data_sets request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_expanded_data_sets, "expanded_data_sets", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_firebase_links(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>` #list_firebase_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::FirebaseLink.
  p item
end

Overloads:

#list_firebase_links(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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 ListFirebaseLinks must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::FirebaseLink>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_firebase_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_firebase_links.timeout,
                         metadata:     call_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.list_firebase_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_firebase_links, "firebase_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_google_ads_links(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>` #list_google_ads_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::GoogleAdsLink.
  p item
end

Overloads:

#list_google_ads_links(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::GoogleAdsLink>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_google_ads_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_google_ads_links.timeout,
                         metadata:     call_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.list_google_ads_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_google_ads_links, "google_ads_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_measurement_protocol_secrets(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>` #list_measurement_protocol_secrets(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret.
  p item
end

Overloads:

#list_measurement_protocol_secrets(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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. Format: properties/{property}/dataStreams/{dataStream}/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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_measurement_protocol_secrets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_measurement_protocol_secrets.timeout,
                         metadata:     call_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.list_measurement_protocol_secrets request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_measurement_protocol_secrets, "measurement_protocol_secrets", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_properties(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>` #list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::Property.
  p item
end

Overloads:

#list_properties(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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/property) or ancestor:(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.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor: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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::Property>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_properties.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_properties.timeout,
                         metadata:     call_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.list_properties request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_properties, "properties", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists all SearchAds360Links 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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::SearchAds360Link.
  p item
end

Overloads:

#list_search_ads360_links(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>

Pass arguments to list_search_ads360_links via a request object, either of type ListSearchAds360LinksRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListSearchAds360LinksRequest, ::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_search_ads360_links(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>

Pass arguments to list_search_ads360_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 ListSearchAds360Links call. Provide this to retrieve the subsequent page.
  
  When paginating, all other parameters provided to ListSearchAds360Links must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SearchAds360Link>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_search_ads360_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_search_ads360_links.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_search_ads360_links.retry_policy

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

  @analytics_admin_service_stub.list_search_ads360_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_search_ads360_links, "search_ads_360_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.

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::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema.
  p item
end

Overloads:

#list_sk_ad_network_conversion_value_schemas(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema>

Pass arguments to list_sk_ad_network_conversion_value_schemas via a request object, either of type ListSKAdNetworkConversionValueSchemasRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::ListSKAdNetworkConversionValueSchemasRequest, ::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_sk_ad_network_conversion_value_schemas(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema>

Pass arguments to list_sk_ad_network_conversion_value_schemas 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}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema Example: properties/1234/dataStreams/5678/sKAdNetworkConversionValueSchema
- 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 ListSKAdNetworkConversionValueSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSKAdNetworkConversionValueSchema must match the call that provided the page token.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema>)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.list_sk_ad_network_conversion_value_schemas.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_sk_ad_network_conversion_value_schemas.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_sk_ad_network_conversion_value_schemas.retry_policy

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

  @analytics_admin_service_stub.list_sk_ad_network_conversion_value_schemas request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_sk_ad_network_conversion_value_schemas, "skadnetwork_conversion_value_schemas", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_user_links(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>` #list_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::UserLink.
  p item
end

Overloads:

#list_user_links(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::UserLink>)

Raises:

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

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

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
  call_metadata = @config.rpcs.list_user_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_user_links.timeout,
                         metadata:     call_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.list_user_links request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :list_user_links, "user_links", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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 Cloud Console as a Redirect URI.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ProvisionAccountTicketResponse)

Raises:

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

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

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
  call_metadata = @config.rpcs.provision_account_ticket.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.provision_account_ticket.timeout,
                         metadata:     call_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.provision_account_ticket request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#run_access_report(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::RunAccessReportResponse` #run_access_report(entity: nil, dimensions: nil, metrics: nil, date_ranges: nil, dimension_filter: nil, metric_filter: nil, offset: nil, limit: nil, time_zone: nil, order_bys: nil, return_entity_quota: nil) ⇒ `::Google::Analytics::Admin::V1alpha::RunAccessReportResponse`

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.

Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators.

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

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::Rest::Client.new

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

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

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

Overloads:

#run_access_report(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::RunAccessReportResponse

Pass arguments to run_access_report via a request object, either of type RunAccessReportRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::RunAccessReportRequest, ::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.
#run_access_report(entity: nil, dimensions: nil, metrics: nil, date_ranges: nil, dimension_filter: nil, metric_filter: nil, offset: nil, limit: nil, time_zone: nil, order_bys: nil, return_entity_quota: nil) ⇒ ::Google::Analytics::Admin::V1alpha::RunAccessReportResponse

Pass arguments to run_access_report 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:
- entity (::String) (defaults to: nil) —
  The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.
  
  To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID.
- dimensions (::Array<::Google::Analytics::Admin::V1alpha::AccessDimension, ::Hash>) (defaults to: nil) —
  The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
- metrics (::Array<::Google::Analytics::Admin::V1alpha::AccessMetric, ::Hash>) (defaults to: nil) —
  The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
- date_ranges (::Array<::Google::Analytics::Admin::V1alpha::AccessDateRange, ::Hash>) (defaults to: nil) —
  Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
- dimension_filter (::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash) (defaults to: nil) —
  Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.
- metric_filter (::Google::Analytics::Admin::V1alpha::AccessFilterExpression, ::Hash) (defaults to: nil) —
  Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
- offset (::Integer) (defaults to: nil) —
  The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with limit entries.
  
  To learn more about this pagination parameter, see Pagination.
- limit (::Integer) (defaults to: nil) —
  The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. limit must be positive.
  
  The API may return fewer rows than the requested limit, if there aren't as many remaining rows as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can't get more than 300 rows, even if you set limit to a higher value.
  
  To learn more about this pagination parameter, see Pagination.
- time_zone (::String) (defaults to: nil) —
  This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report.
  
  Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".
- order_bys (::Array<::Google::Analytics::Admin::V1alpha::AccessOrderBy, ::Hash>) (defaults to: nil) —
  Specifies how rows are ordered in the response.
- return_entity_quota (::Boolean) (defaults to: nil) —
  Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::RunAccessReportResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::RunAccessReportResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.run_access_report.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.run_access_report.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.run_access_report.retry_policy

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

  @analytics_admin_service_stub.run_access_report request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_change_history_events(request, options = nil) ⇒ `::Gapic::Rest::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::Rest::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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent.
  p item
end

Overloads:

#search_change_history_events(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::ChangeHistoryEvent>)

Raises:

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

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

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
  call_metadata = @config.rpcs.search_change_history_events.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_change_history_events.timeout,
                         metadata:     call_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.search_change_history_events request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @analytics_admin_service_stub, :search_change_history_events, "change_history_events", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_automated_ga4_configuration_opt_out(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse` #set_automated_ga4_configuration_opt_out(property: nil, opt_out: nil) ⇒ `::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse`

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on 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::Rest::Client.new

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

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

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

Overloads:

#set_automated_ga4_configuration_opt_out(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse

Pass arguments to set_automated_ga4_configuration_opt_out via a request object, either of type SetAutomatedGa4ConfigurationOptOutRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutRequest, ::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.
#set_automated_ga4_configuration_opt_out(property: nil, opt_out: nil) ⇒ ::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse

Pass arguments to set_automated_ga4_configuration_opt_out 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 (::String) (defaults to: nil) —
  Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234
- opt_out (::Boolean) (defaults to: nil) —
  The status to set.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::SetAutomatedGa4ConfigurationOptOutResponse)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.set_automated_ga4_configuration_opt_out.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_automated_ga4_configuration_opt_out.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_automated_ga4_configuration_opt_out.retry_policy

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

  @analytics_admin_service_stub.set_automated_ga4_configuration_opt_out request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_access_binding(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AccessBinding` #update_access_binding(access_binding: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AccessBinding`

Updates an access binding 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::Rest::Client.new

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

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

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

Overloads:

#update_access_binding(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding

Pass arguments to update_access_binding via a request object, either of type UpdateAccessBindingRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateAccessBindingRequest, ::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_access_binding(access_binding: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding

Pass arguments to update_access_binding 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:
- access_binding (::Google::Analytics::Admin::V1alpha::AccessBinding, ::Hash) (defaults to: nil) —
  Required. The access binding to update.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AccessBinding)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AccessBinding)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_access_binding.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_access_binding.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_access_binding.retry_policy

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

  @analytics_admin_service_stub.update_access_binding request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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 (for example, "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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Account)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_account.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_account.timeout,
                         metadata:     call_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.update_account request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_attribution_settings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AttributionSettings` #update_attribution_settings(attribution_settings: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AttributionSettings`

Updates attribution settings 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::Rest::Client.new

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

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

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

Overloads:

#update_attribution_settings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AttributionSettings

Pass arguments to update_attribution_settings via a request object, either of type UpdateAttributionSettingsRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateAttributionSettingsRequest, ::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_attribution_settings(attribution_settings: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AttributionSettings

Pass arguments to update_attribution_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:
- attribution_settings (::Google::Analytics::Admin::V1alpha::AttributionSettings, ::Hash) (defaults to: nil) —
  Required. The attribution 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::AttributionSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::AttributionSettings)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_attribution_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_attribution_settings.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_attribution_settings.retry_policy

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

  @analytics_admin_service_stub.update_attribution_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_audience(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Audience` #update_audience(audience: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Audience`

Updates an Audience 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::Rest::Client.new

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

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

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

Overloads:

#update_audience(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience

Pass arguments to update_audience via a request object, either of type UpdateAudienceRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateAudienceRequest, ::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_audience(audience: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience

Pass arguments to update_audience 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:
- audience (::Google::Analytics::Admin::V1alpha::Audience, ::Hash) (defaults to: nil) —
  Required. The audience to update. The audience's name field is used to identify the audience 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Audience)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::Audience)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_audience.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_audience.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_audience.retry_policy

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

  @analytics_admin_service_stub.update_audience request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_channel_group(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ChannelGroup` #update_channel_group(channel_group: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ChannelGroup`

Updates a ChannelGroup.

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::Rest::Client.new

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

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

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

Overloads:

#update_channel_group(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup

Pass arguments to update_channel_group via a request object, either of type UpdateChannelGroupRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateChannelGroupRequest, ::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_channel_group(channel_group: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup

Pass arguments to update_channel_group 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:
- channel_group (::Google::Analytics::Admin::V1alpha::ChannelGroup, ::Hash) (defaults to: nil) —
  Required. The ChannelGroup to update. The resource's name field is used to identify the ChannelGroup 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ChannelGroup)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ChannelGroup)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_channel_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_channel_group.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_channel_group.retry_policy

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

  @analytics_admin_service_stub.update_channel_group request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Updates 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::Rest::Client.new

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

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

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

Overloads:

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

Pass arguments to update_conversion_event via a request object, either of type UpdateConversionEventRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateConversionEventRequest, ::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_conversion_event(conversion_event: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ConversionEvent

Pass arguments to update_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 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ConversionEvent)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_conversion_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_conversion_event.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_conversion_event.retry_policy

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

  @analytics_admin_service_stub.update_conversion_event request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::CustomDimension)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_custom_dimension.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_custom_dimension.timeout,
                         metadata:     call_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.update_custom_dimension request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::CustomMetric)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_custom_metric.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_custom_metric.timeout,
                         metadata:     call_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.update_custom_metric request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DataRetentionSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataRetentionSettings)

Raises:

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

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

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
  call_metadata = @config.rpcs.update_data_retention_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_data_retention_settings.timeout,
                         metadata:     call_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.update_data_retention_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataStream` #update_data_stream(data_stream: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataStream`

Updates a DataStream 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::Rest::Client.new

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

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

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

Overloads:

#update_data_stream(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataStream

Pass arguments to update_data_stream via a request object, either of type UpdateDataStreamRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateDataStreamRequest, ::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_stream(data_stream: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::DataStream

Pass arguments to update_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:
- data_stream (::Google::Analytics::Admin::V1alpha::DataStream, ::Hash) (defaults to: nil) —
  The DataStream 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DataStream)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::DataStream)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_data_stream.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_data_stream.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_data_stream.retry_policy

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

  @analytics_admin_service_stub.update_data_stream request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::DisplayVideo360AdvertiserLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_display_video360_advertiser_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_display_video360_advertiser_link.timeout,
                         metadata:     call_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.update_display_video360_advertiser_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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 enhanced measurement settings for this data 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::EnhancedMeasurementSettings)

Raises:

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

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

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
  call_metadata = @config.rpcs.update_enhanced_measurement_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_enhanced_measurement_settings.timeout,
                         metadata:     call_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.update_enhanced_measurement_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_event_create_rule(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::EventCreateRule` #update_event_create_rule(event_create_rule: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::EventCreateRule`

Updates an EventCreateRule.

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::Rest::Client.new

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

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

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

Overloads:

#update_event_create_rule(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule

Pass arguments to update_event_create_rule via a request object, either of type UpdateEventCreateRuleRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateEventCreateRuleRequest, ::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_event_create_rule(event_create_rule: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::EventCreateRule

Pass arguments to update_event_create_rule 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:
- event_create_rule (::Google::Analytics::Admin::V1alpha::EventCreateRule, ::Hash) (defaults to: nil) —
  Required. The EventCreateRule to update. The resource's name field is used to identify the EventCreateRule 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::EventCreateRule)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::EventCreateRule)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_event_create_rule.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_event_create_rule.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_event_create_rule.retry_policy

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

  @analytics_admin_service_stub.update_event_create_rule request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_expanded_data_set(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ExpandedDataSet` #update_expanded_data_set(expanded_data_set: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ExpandedDataSet`

Updates a ExpandedDataSet 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::Rest::Client.new

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

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

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

Overloads:

#update_expanded_data_set(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet

Pass arguments to update_expanded_data_set via a request object, either of type UpdateExpandedDataSetRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateExpandedDataSetRequest, ::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_expanded_data_set(expanded_data_set: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ExpandedDataSet

Pass arguments to update_expanded_data_set 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:
- expanded_data_set (::Google::Analytics::Admin::V1alpha::ExpandedDataSet, ::Hash) (defaults to: nil) —
  Required. The ExpandedDataSet to update. The resource's name field is used to identify the ExpandedDataSet 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::ExpandedDataSet)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::ExpandedDataSet)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_expanded_data_set.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_expanded_data_set.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_expanded_data_set.retry_policy

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

  @analytics_admin_service_stub.update_expanded_data_set request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::GoogleAdsLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_google_ads_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_google_ads_link.timeout,
                         metadata:     call_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.update_google_ads_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::GoogleSignalsSettings)

Raises:

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

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

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
  call_metadata = @config.rpcs.update_google_signals_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_google_signals_settings.timeout,
                         metadata:     call_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.update_google_signals_settings request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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) —
  Required. The list of fields to be updated. Omitted fields will not be updated.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::MeasurementProtocolSecret)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_measurement_protocol_secret.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_measurement_protocol_secret.timeout,
                         metadata:     call_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.update_measurement_protocol_secret request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::Property)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_property.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_property.timeout,
                         metadata:     call_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.update_property request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_search_ads360_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::SearchAds360Link` #update_search_ads360_link(search_ads_360_link: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::SearchAds360Link`

Updates a SearchAds360Link 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::Rest::Client.new

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

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

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

Overloads:

#update_search_ads360_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link

Pass arguments to update_search_ads360_link via a request object, either of type UpdateSearchAds360LinkRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateSearchAds360LinkRequest, ::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_search_ads360_link(search_ads_360_link: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::SearchAds360Link

Pass arguments to update_search_ads360_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:
- search_ads_360_link (::Google::Analytics::Admin::V1alpha::SearchAds360Link, ::Hash) (defaults to: nil) —
  The SearchAds360Link 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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::SearchAds360Link)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::SearchAds360Link)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_search_ads360_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_search_ads360_link.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_search_ads360_link.retry_policy

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

  @analytics_admin_service_stub.update_search_ads360_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_sk_ad_network_conversion_value_schema(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema` #update_sk_ad_network_conversion_value_schema(skadnetwork_conversion_value_schema: nil, update_mask: nil) ⇒ `::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema`

Updates a SKAdNetworkConversionValueSchema.

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::Rest::Client.new

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

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

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

Overloads:

#update_sk_ad_network_conversion_value_schema(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema

Pass arguments to update_sk_ad_network_conversion_value_schema via a request object, either of type UpdateSKAdNetworkConversionValueSchemaRequest or an equivalent Hash.
Parameters:
- request (::Google::Analytics::Admin::V1alpha::UpdateSKAdNetworkConversionValueSchemaRequest, ::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_sk_ad_network_conversion_value_schema(skadnetwork_conversion_value_schema: nil, update_mask: nil) ⇒ ::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema

Pass arguments to update_sk_ad_network_conversion_value_schema 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:
- skadnetwork_conversion_value_schema (::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema, ::Hash) (defaults to: nil) —
  Required. SKAdNetwork conversion value schema 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.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Analytics::Admin::V1alpha::SKAdNetworkConversionValueSchema)

Raises:

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

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

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

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

  # 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
  call_metadata = @config.rpcs.update_sk_ad_network_conversion_value_schema.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_sk_ad_network_conversion_value_schema.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_sk_ad_network_conversion_value_schema.retry_policy

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

  @analytics_admin_service_stub.update_sk_ad_network_conversion_value_schema request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Analytics::Admin::V1alpha::UserLink)
operation (::Gapic::Rest::TransportOperation)

Returns:

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

Raises:

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

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

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
  call_metadata = @config.rpcs.update_user_link.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_user_link.timeout,
                         metadata:     call_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.update_user_link request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Overview

Defined Under Namespace

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

Constructor Details

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

Examples:

Class Method Details

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

Examples:

Instance Method Details

#acknowledge_user_data_collection(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse #acknowledge_user_data_collection(property: nil, acknowledgement: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse

Examples:

Basic example

Examples:

Basic example

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

Examples:

Basic example

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

Examples:

Basic example

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

Examples:

Basic example

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

Examples:

Basic example

#batch_create_access_bindings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse #batch_create_access_bindings(parent: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchCreateAccessBindingsResponse

Examples:

Basic example

#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

Examples:

Basic example

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

Examples:

Basic example

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

Examples:

Basic example

#batch_get_access_bindings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse #batch_get_access_bindings(parent: nil, names: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchGetAccessBindingsResponse

Examples:

Basic example

#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

Examples:

Basic example

#batch_update_access_bindings(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse #batch_update_access_bindings(parent: nil, requests: nil) ⇒ ::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse

Examples:

Basic example

#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

Examples:

Basic example

#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

Examples:

Basic example

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

#create_access_binding(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding #create_access_binding(parent: nil, access_binding: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AccessBinding

Examples:

Basic example

#create_ad_sense_link(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink #create_ad_sense_link(parent: nil, adsense_link: nil) ⇒ ::Google::Analytics::Admin::V1alpha::AdSenseLink

Examples:

Basic example

#create_audience(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience #create_audience(parent: nil, audience: nil) ⇒ ::Google::Analytics::Admin::V1alpha::Audience

Examples:

Basic example

#create_channel_group(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup #create_channel_group(parent: nil, channel_group: nil) ⇒ ::Google::Analytics::Admin::V1alpha::ChannelGroup

Examples:

Basic example

#create_connected_site_tag(request, options = nil) ⇒ ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse #create_connected_site_tag(property: nil, connected_site_tag: nil) ⇒ ::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse

Examples:

Basic example

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

Examples:

Basic example

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

Examples:

Basic example

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

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

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

#acknowledge_user_data_collection(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse` #acknowledge_user_data_collection(property: nil, acknowledgement: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AcknowledgeUserDataCollectionResponse`

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

#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::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>` #audit_user_links(parent: nil, page_size: nil, page_token: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Analytics::Admin::V1alpha::AuditUserLink>`

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

#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_access_bindings(request, options = nil) ⇒ `::Google::Protobuf::Empty` #batch_delete_access_bindings(parent: nil, requests: nil) ⇒ `::Google::Protobuf::Empty`

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

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

#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_access_bindings(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse` #batch_update_access_bindings(parent: nil, requests: nil) ⇒ `::Google::Analytics::Admin::V1alpha::BatchUpdateAccessBindingsResponse`

#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_access_binding(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AccessBinding` #create_access_binding(parent: nil, access_binding: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AccessBinding`

#create_ad_sense_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::AdSenseLink` #create_ad_sense_link(parent: nil, adsense_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::AdSenseLink`

#create_audience(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::Audience` #create_audience(parent: nil, audience: nil) ⇒ `::Google::Analytics::Admin::V1alpha::Audience`

#create_channel_group(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ChannelGroup` #create_channel_group(parent: nil, channel_group: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ChannelGroup`

#create_connected_site_tag(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse` #create_connected_site_tag(property: nil, connected_site_tag: nil) ⇒ `::Google::Analytics::Admin::V1alpha::CreateConnectedSiteTagResponse`

#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_data_stream(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataStream` #create_data_stream(parent: nil, data_stream: nil) ⇒ `::Google::Analytics::Admin::V1alpha::DataStream`

#create_event_create_rule(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::EventCreateRule` #create_event_create_rule(parent: nil, event_create_rule: nil) ⇒ `::Google::Analytics::Admin::V1alpha::EventCreateRule`

#create_expanded_data_set(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::ExpandedDataSet` #create_expanded_data_set(parent: nil, expanded_data_set: nil) ⇒ `::Google::Analytics::Admin::V1alpha::ExpandedDataSet`

#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_search_ads360_link(request, options = nil) ⇒ `::Google::Analytics::Admin::V1alpha::SearchAds360Link` #create_search_ads360_link(parent: nil, search_ads_360_link: nil) ⇒ `::Google::Analytics::Admin::V1alpha::SearchAds360Link`

#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`

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

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

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

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

#delete_connected_site_tag(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_connected_site_tag(property: nil, tag_id: nil) ⇒ `::Google::Protobuf::Empty`

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

#delete_data_stream(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_data_stream(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_event_create_rule(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_event_create_rule(name: nil) ⇒ `::Google::Protobuf::Empty`

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