def test_get_geographic_view(
transport: str = 'grpc',
request_type=geographic_view_service.GetGeographicViewRequest):
client = GeographicViewServiceClient(
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_geographic_view),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = geographic_view.GeographicView(
resource_name='resource_name_value',
location_type=geo_targeting_type.GeoTargetingTypeEnum.
GeoTargetingType.UNKNOWN,
country_criterion_id=2158,
)
response = client.get_geographic_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] == geographic_view_service.GetGeographicViewRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, geographic_view.GeographicView)
assert response.resource_name == 'resource_name_value'
assert response.location_type == geo_targeting_type.GeoTargetingTypeEnum.GeoTargetingType.UNKNOWN
assert response.country_criterion_id == 2158
def test_get_geographic_view_field_headers():
client = GeographicViewServiceClient(
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 = geographic_view_service.GetGeographicViewRequest()
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_geographic_view),
'__call__') as call:
call.return_value = geographic_view.GeographicView()
client.get_geographic_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_geographic_view_flattened_error():
client = GeographicViewServiceClient(
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_geographic_view(
geographic_view_service.GetGeographicViewRequest(),
resource_name='resource_name_value',
)
def get_geographic_view(
self,
request: geographic_view_service.GetGeographicViewRequest = None,
*,
resource_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> geographic_view.GeographicView:
r"""Returns the requested geographic view in full detail.
Args:
request (:class:`google.ads.googleads.v6.services.types.GetGeographicViewRequest`):
The request object. Request message for
[GeographicViewService.GetGeographicView][google.ads.googleads.v6.services.GeographicViewService.GetGeographicView].
resource_name (:class:`str`):
Required. The resource name of the
geographic 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.v6.resources.types.GeographicView:
A geographic view.
Geographic View includes all metrics
aggregated at the country level, one row
per country. It reports metrics at
either actual physical location of the
user or an area of interest. If other
segment fields are used, you may get
more than one row per country.
"""
# 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 geographic_view_service.GetGeographicViewRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request,
geographic_view_service.GetGeographicViewRequest):
request = geographic_view_service.GetGeographicViewRequest(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_geographic_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