def test_get_ad_group_field_headers():
client = AdGroupServiceClient(
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_group_service.GetAdGroupRequest()
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_group),
'__call__') as call:
call.return_value = ad_group.AdGroup()
client.get_ad_group(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_group_flattened_error():
client = AdGroupServiceClient(
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_group(
ad_group_service.GetAdGroupRequest(),
resource_name='resource_name_value',
)
def get_ad_group(
self,
request: ad_group_service.GetAdGroupRequest = None,
*,
resource_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> ad_group.AdGroup:
r"""Returns the requested ad group in full detail.
Args:
request (:class:`google.ads.googleads.v5.services.types.GetAdGroupRequest`):
The request object. Request message for
[AdGroupService.GetAdGroup][google.ads.googleads.v5.services.AdGroupService.GetAdGroup].
resource_name (:class:`str`):
Required. The resource name of the ad
group 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.AdGroup:
An ad group.
"""
# 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_group_service.GetAdGroupRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, ad_group_service.GetAdGroupRequest):
request = ad_group_service.GetAdGroupRequest(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_group]
# 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
def test_get_ad_group(transport: str = 'grpc', request_type=ad_group_service.GetAdGroupRequest):
client = AdGroupServiceClient(
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_group),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = ad_group.AdGroup(
resource_name='resource_name_value',
id=205,
name='name_value',
status=ad_group_status.AdGroupStatusEnum.AdGroupStatus.UNKNOWN,
type_=ad_group_type.AdGroupTypeEnum.AdGroupType.UNKNOWN,
ad_rotation_mode=ad_group_ad_rotation_mode.AdGroupAdRotationModeEnum.AdGroupAdRotationMode.UNKNOWN,
base_ad_group='base_ad_group_value',
tracking_url_template='tracking_url_template_value',
campaign='campaign_value',
cpc_bid_micros=1456,
cpm_bid_micros=1466,
target_cpa_micros=1798,
cpv_bid_micros=1475,
target_cpm_micros=1810,
target_roas=0.1179,
percent_cpc_bid_micros=2304,
display_custom_bid_dimension=targeting_dimension.TargetingDimensionEnum.TargetingDimension.UNKNOWN,
final_url_suffix='final_url_suffix_value',
effective_target_cpa_micros=2838,
effective_target_cpa_source=bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN,
effective_target_roas=0.2219,
effective_target_roas_source=bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN,
labels=['labels_value'],
)
response = client.get_ad_group(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_group_service.GetAdGroupRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, ad_group.AdGroup)
assert response.resource_name == 'resource_name_value'
assert response.id == 205
assert response.name == 'name_value'
assert response.status == ad_group_status.AdGroupStatusEnum.AdGroupStatus.UNKNOWN
assert response.type_ == ad_group_type.AdGroupTypeEnum.AdGroupType.UNKNOWN
assert response.ad_rotation_mode == ad_group_ad_rotation_mode.AdGroupAdRotationModeEnum.AdGroupAdRotationMode.UNKNOWN
assert response.base_ad_group == 'base_ad_group_value'
assert response.tracking_url_template == 'tracking_url_template_value'
assert response.campaign == 'campaign_value'
assert response.cpc_bid_micros == 1456
assert response.cpm_bid_micros == 1466
assert response.target_cpa_micros == 1798
assert response.cpv_bid_micros == 1475
assert response.target_cpm_micros == 1810
assert math.isclose(response.target_roas, 0.1179, rel_tol=1e-6)
assert response.percent_cpc_bid_micros == 2304
assert response.display_custom_bid_dimension == targeting_dimension.TargetingDimensionEnum.TargetingDimension.UNKNOWN
assert response.final_url_suffix == 'final_url_suffix_value'
assert response.effective_target_cpa_micros == 2838
assert response.effective_target_cpa_source == bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN
assert math.isclose(response.effective_target_roas, 0.2219, rel_tol=1e-6)
assert response.effective_target_roas_source == bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN
assert response.labels == ['labels_value']