def test_upload_click_conversions_field_headers():
client = ConversionUploadServiceClient(
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 = conversion_upload_service.UploadClickConversionsRequest()
request.customer_id = 'customer_id/value'
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client.transport.upload_click_conversions),
'__call__') as call:
call.return_value = conversion_upload_service.UploadClickConversionsResponse()
client.upload_click_conversions(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',
'customer_id=customer_id/value',
) in kw['metadata']
def test_upload_click_conversions(transport: str = 'grpc', request_type=conversion_upload_service.UploadClickConversionsRequest):
client = ConversionUploadServiceClient(
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.upload_click_conversions),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = conversion_upload_service.UploadClickConversionsResponse(
)
response = client.upload_click_conversions(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == conversion_upload_service.UploadClickConversionsRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, conversion_upload_service.UploadClickConversionsResponse)
def test_upload_click_conversions_flattened_error():
client = ConversionUploadServiceClient(
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.upload_click_conversions(
conversion_upload_service.UploadClickConversionsRequest(),
customer_id='customer_id_value',
conversions=[conversion_upload_service.ClickConversion(gclid='gclid_value')],
partial_failure=True,
)
def upload_click_conversions(
self,
request: conversion_upload_service.
UploadClickConversionsRequest = None,
*,
customer_id: str = None,
conversions: Sequence[
conversion_upload_service.ClickConversion] = None,
partial_failure: bool = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> conversion_upload_service.UploadClickConversionsResponse:
r"""Processes the given click conversions.
Args:
request (:class:`google.ads.googleads.v5.services.types.UploadClickConversionsRequest`):
The request object. Request message for
[ConversionUploadService.UploadClickConversions][google.ads.googleads.v5.services.ConversionUploadService.UploadClickConversions].
customer_id (:class:`str`):
Required. The ID of the customer
performing the upload.
This corresponds to the ``customer_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
conversions (:class:`Sequence[google.ads.googleads.v5.services.types.ClickConversion]`):
Required. The conversions that are
being uploaded.
This corresponds to the ``conversions`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
partial_failure (:class:`bool`):
Required. If true, successful
operations will be carried out and
invalid operations will return errors.
If false, all operations will be carried
out in one transaction if and only if
they are all valid. This should always
be set to true.
See
https://developers.google.com/google-
ads/api/docs/best-practices/partial-
failures for more information about
partial failure.
This corresponds to the ``partial_failure`` 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.services.types.UploadClickConversionsResponse:
Response message for
[ConversionUploadService.UploadClickConversions][google.ads.googleads.v5.services.ConversionUploadService.UploadClickConversions].
"""
# 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(
[customer_id, conversions, partial_failure]):
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 conversion_upload_service.UploadClickConversionsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(
request,
conversion_upload_service.UploadClickConversionsRequest):
request = conversion_upload_service.UploadClickConversionsRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if customer_id is not None:
request.customer_id = customer_id
if conversions is not None:
request.conversions = conversions
if partial_failure is not None:
request.partial_failure = partial_failure
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.upload_click_conversions]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("customer_id", request.customer_id), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response