def test_get_ad_parameter_field_headers():
client = AdParameterServiceClient(
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 = ad_parameter_service.GetAdParameterRequest()
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_ad_parameter),
'__call__') as call:
call.return_value = ad_parameter.AdParameter()
client.get_ad_parameter(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_ad_parameter(
transport: str = 'grpc',
request_type=ad_parameter_service.GetAdParameterRequest):
client = AdParameterServiceClient(
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_ad_parameter),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = ad_parameter.AdParameter(
resource_name='resource_name_value',
ad_group_criterion='ad_group_criterion_value',
parameter_index=1592,
insertion_text='insertion_text_value',
)
response = client.get_ad_parameter(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == ad_parameter_service.GetAdParameterRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, ad_parameter.AdParameter)
assert response.resource_name == 'resource_name_value'
assert response.ad_group_criterion == 'ad_group_criterion_value'
assert response.parameter_index == 1592
assert response.insertion_text == 'insertion_text_value'
def test_get_ad_parameter_flattened_error():
client = AdParameterServiceClient(
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_ad_parameter(
ad_parameter_service.GetAdParameterRequest(),
resource_name='resource_name_value',
)
def get_ad_parameter(self,
request: ad_parameter_service.GetAdParameterRequest = None,
*,
resource_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> ad_parameter.AdParameter:
r"""Returns the requested ad parameter in full detail.
List of thrown errors: `AuthenticationError <>`__
`AuthorizationError <>`__ `HeaderError <>`__
`InternalError <>`__ `QuotaError <>`__ `RequestError <>`__
Args:
request (:class:`google.ads.googleads.v8.services.types.GetAdParameterRequest`):
The request object. Request message for
[AdParameterService.GetAdParameter][google.ads.googleads.v8.services.AdParameterService.GetAdParameter]
resource_name (:class:`str`):
Required. The resource name of the ad
parameter 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.v8.resources.types.AdParameter:
An ad parameter that is used to update numeric values (such as prices or
inventory levels) in any text line of an ad
(including URLs). There can be a maximum of two
AdParameters per ad group criterion. (One with
parameter_index = 1 and one with parameter_index =
2.) In the ad the parameters are referenced by a
placeholder of the form "{param#:value}". E.g.
"{param1:$17}"
"""
# 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 ad_parameter_service.GetAdParameterRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, ad_parameter_service.GetAdParameterRequest):
request = ad_parameter_service.GetAdParameterRequest(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_ad_parameter]
# 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