Class: Google::Ads::GoogleAds::V16::Services::ThirdPartyAppAnalyticsLinkService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V16::Services::ThirdPartyAppAnalyticsLinkService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v16/services/third_party_app_analytics_link_service/client.rb
Overview
Client for the ThirdPartyAppAnalyticsLinkService service.
This service allows management of links between Google Ads and third party app analytics.
Defined Under Namespace
Classes: Configuration
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"googleads.$UNIVERSE_DOMAIN$"
Instance Attribute Summary collapse
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ThirdPartyAppAnalyticsLinkService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ThirdPartyAppAnalyticsLinkService Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ThirdPartyAppAnalyticsLinkService client object.
-
#regenerate_shareable_link_id(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V16::Services::RegenerateShareableLinkIdResponse
Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics.
-
#universe_domain ⇒ String
The effective universe domain.
Methods included from Paths
#third_party_app_analytics_link_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ThirdPartyAppAnalyticsLinkService client object.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/google/ads/google_ads/v16/services/third_party_app_analytics_link_service/client.rb', line 121 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/ads/google_ads/v16/services/third_party_app_analytics_link_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@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 @third_party_app_analytics_link_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V16::Services::ThirdPartyAppAnalyticsLinkService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end |
Instance Attribute Details
#third_party_app_analytics_link_service_stub ⇒ Object (readonly)
41 42 43 |
# File 'lib/google/ads/google_ads/v16/services/third_party_app_analytics_link_service/client.rb', line 41 def third_party_app_analytics_link_service_stub @third_party_app_analytics_link_service_stub end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ThirdPartyAppAnalyticsLinkService Client class.
See Configuration for a description of the configuration fields.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/google/ads/google_ads/v16/services/third_party_app_analytics_link_service/client.rb', line 61 def self.configure @configure ||= begin default_config = Client::Configuration.new default_config.timeout = 14_400.0 default_config.retry_policy = { initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the ThirdPartyAppAnalyticsLinkService 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.
91 92 93 94 |
# File 'lib/google/ads/google_ads/v16/services/third_party_app_analytics_link_service/client.rb', line 91 def configure yield @config if block_given? @config end |
#regenerate_shareable_link_id(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::RegenerateShareableLinkIdResponse #regenerate_shareable_link_id(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V16::Services::RegenerateShareableLinkIdResponse
Regenerate ThirdPartyAppAnalyticsLink.shareable_link_id that should be provided to the third party when setting up app analytics.
List of thrown errors:
[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/google/ads/google_ads/v16/services/third_party_app_analytics_link_service/client.rb', line 216 def regenerate_shareable_link_id request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V16::Services::RegenerateShareableLinkIdRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.regenerate_shareable_link_id..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Ads::GoogleAds::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource_name header_params["resource_name"] = request.resource_name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.regenerate_shareable_link_id.timeout, metadata: , retry_policy: @config.rpcs.regenerate_shareable_link_id.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @third_party_app_analytics_link_service_stub.call_rpc :regenerate_shareable_link_id, request, options: do |response, operation| yield response, operation if block_given? return response end # rescue GRPC::BadStatus => grpc_error # raise Google::Ads::GoogleAds::Error.new grpc_error.message end |
#universe_domain ⇒ String
The effective universe domain
101 102 103 |
# File 'lib/google/ads/google_ads/v16/services/third_party_app_analytics_link_service/client.rb', line 101 def universe_domain @third_party_app_analytics_link_service_stub.universe_domain end |