def test_get_campaign_budget_field_headers():
client = CampaignBudgetServiceClient(
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 = campaign_budget_service.GetCampaignBudgetRequest()
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_campaign_budget),
'__call__') as call:
call.return_value = campaign_budget.CampaignBudget()
client.get_campaign_budget(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_campaign_budget_flattened_error():
client = CampaignBudgetServiceClient(
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_campaign_budget(
campaign_budget_service.GetCampaignBudgetRequest(),
resource_name='resource_name_value',
)
def get_campaign_budget(self,
request: campaign_budget_service.GetCampaignBudgetRequest = None,
*,
resource_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> campaign_budget.CampaignBudget:
r"""Returns the requested Campaign Budget in full detail.
Args:
request (:class:`google.ads.googleads.v6.services.types.GetCampaignBudgetRequest`):
The request object. Request message for
[CampaignBudgetService.GetCampaignBudget][google.ads.googleads.v6.services.CampaignBudgetService.GetCampaignBudget].
resource_name (:class:`str`):
Required. The resource name of the
campaign budget 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.CampaignBudget:
A campaign budget.
"""
# 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 campaign_budget_service.GetCampaignBudgetRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, campaign_budget_service.GetCampaignBudgetRequest):
request = campaign_budget_service.GetCampaignBudgetRequest(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_campaign_budget]
# 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_campaign_budget(
transport: str = 'grpc',
request_type=campaign_budget_service.GetCampaignBudgetRequest):
client = CampaignBudgetServiceClient(
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_campaign_budget),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = campaign_budget.CampaignBudget(
resource_name='resource_name_value',
id=205,
name='name_value',
amount_micros=1408,
total_amount_micros=2051,
status=budget_status.BudgetStatusEnum.BudgetStatus.UNKNOWN,
delivery_method=budget_delivery_method.BudgetDeliveryMethodEnum.
BudgetDeliveryMethod.UNKNOWN,
explicitly_shared=True,
reference_count=1591,
has_recommended_budget=True,
recommended_budget_amount_micros=3388,
period=budget_period.BudgetPeriodEnum.BudgetPeriod.UNKNOWN,
recommended_budget_estimated_change_weekly_clicks=5129,
recommended_budget_estimated_change_weekly_cost_micros=5685,
recommended_budget_estimated_change_weekly_interactions=5795,
recommended_budget_estimated_change_weekly_views=5054,
type_=budget_type.BudgetTypeEnum.BudgetType.UNKNOWN,
)
response = client.get_campaign_budget(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == campaign_budget_service.GetCampaignBudgetRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, campaign_budget.CampaignBudget)
assert response.resource_name == 'resource_name_value'
assert response.id == 205
assert response.name == 'name_value'
assert response.amount_micros == 1408
assert response.total_amount_micros == 2051
assert response.status == budget_status.BudgetStatusEnum.BudgetStatus.UNKNOWN
assert response.delivery_method == budget_delivery_method.BudgetDeliveryMethodEnum.BudgetDeliveryMethod.UNKNOWN
assert response.explicitly_shared is True
assert response.reference_count == 1591
assert response.has_recommended_budget is True
assert response.recommended_budget_amount_micros == 3388
assert response.period == budget_period.BudgetPeriodEnum.BudgetPeriod.UNKNOWN
assert response.recommended_budget_estimated_change_weekly_clicks == 5129
assert response.recommended_budget_estimated_change_weekly_cost_micros == 5685
assert response.recommended_budget_estimated_change_weekly_interactions == 5795
assert response.recommended_budget_estimated_change_weekly_views == 5054
assert response.type_ == budget_type.BudgetTypeEnum.BudgetType.UNKNOWN