def test_get_distance_view_field_headers():
client = DistanceViewServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = distance_view_service.GetDistanceViewRequest()
request.resource_name = 'resource_name/value'
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.get_distance_view),
'__call__') as call:
call.return_value = distance_view.DistanceView()
client.get_distance_view(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the field header was sent.
_, _, kw = call.mock_calls[0]
assert (
'x-goog-request-params',
'resource_name=resource_name/value',
) in kw['metadata']
def test_get_distance_view(
transport: str = 'grpc',
request_type=distance_view_service.GetDistanceViewRequest):
client = DistanceViewServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = request_type()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.get_distance_view),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = distance_view.DistanceView(
resource_name='resource_name_value',
distance_bucket=distance_bucket.DistanceBucketEnum.DistanceBucket.
UNKNOWN,
metric_system=True,
)
response = client.get_distance_view(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == distance_view_service.GetDistanceViewRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, distance_view.DistanceView)
assert response.resource_name == 'resource_name_value'
assert response.distance_bucket == distance_bucket.DistanceBucketEnum.DistanceBucket.UNKNOWN
assert response.metric_system is True
def test_get_distance_view_flattened_error():
client = DistanceViewServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.get_distance_view(
distance_view_service.GetDistanceViewRequest(),
resource_name='resource_name_value',
)
def get_distance_view(
self,
request: distance_view_service.GetDistanceViewRequest = None,
*,
resource_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> distance_view.DistanceView:
r"""Returns the attributes of the requested distance
view.
Args:
request (:class:`google.ads.googleads.v5.services.types.GetDistanceViewRequest`):
The request object. Request message for
[DistanceViewService.GetDistanceView][google.ads.googleads.v5.services.DistanceViewService.GetDistanceView].
resource_name (:class:`str`):
Required. The resource name of the
distance view to fetch.
This corresponds to the ``resource_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.ads.googleads.v5.resources.types.DistanceView:
A distance view with metrics
aggregated by the user's distance from
an advertiser's location extensions.
Each DistanceBucket includes all
impressions that fall within its
distance and a single impression will
contribute to the metrics for all
DistanceBuckets that include the user's
distance.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
if request is not None and any([resource_name]):
raise ValueError('If the `request` argument is set, then none of '
'the individual field arguments should be set.')
# Minor optimization to avoid making a copy if the user passes
# in a distance_view_service.GetDistanceViewRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request,
distance_view_service.GetDistanceViewRequest):
request = distance_view_service.GetDistanceViewRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if resource_name is not None:
request.resource_name = resource_name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.get_distance_view]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(('resource_name', request.resource_name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response