def test_get_account_budget_field_headers():
client = AccountBudgetServiceClient(
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 = account_budget_service.GetAccountBudgetRequest()
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_account_budget),
'__call__') as call:
call.return_value = account_budget.AccountBudget()
client.get_account_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_account_budget(
transport: str = 'grpc',
request_type=account_budget_service.GetAccountBudgetRequest):
client = AccountBudgetServiceClient(
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_account_budget),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = account_budget.AccountBudget(
resource_name='resource_name_value',
id=205,
billing_setup='billing_setup_value',
status=account_budget_status.AccountBudgetStatusEnum.
AccountBudgetStatus.UNKNOWN,
name='name_value',
proposed_start_date_time='proposed_start_date_time_value',
approved_start_date_time='approved_start_date_time_value',
total_adjustments_micros=2593,
amount_served_micros=2152,
purchase_order_number='purchase_order_number_value',
notes='notes_value',
proposed_end_date_time='proposed_end_date_time_value',
approved_end_date_time='approved_end_date_time_value',
proposed_spending_limit_micros=3213,
approved_spending_limit_micros=3202,
adjusted_spending_limit_micros=3189,
)
response = client.get_account_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] == account_budget_service.GetAccountBudgetRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, account_budget.AccountBudget)
assert response.resource_name == 'resource_name_value'
assert response.id == 205
assert response.billing_setup == 'billing_setup_value'
assert response.status == account_budget_status.AccountBudgetStatusEnum.AccountBudgetStatus.UNKNOWN
assert response.name == 'name_value'
assert response.proposed_start_date_time == 'proposed_start_date_time_value'
assert response.approved_start_date_time == 'approved_start_date_time_value'
assert response.total_adjustments_micros == 2593
assert response.amount_served_micros == 2152
assert response.purchase_order_number == 'purchase_order_number_value'
assert response.notes == 'notes_value'
def test_get_account_budget_flattened_error():
client = AccountBudgetServiceClient(
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_account_budget(
account_budget_service.GetAccountBudgetRequest(),
resource_name='resource_name_value',
)
def get_account_budget(
self,
request: account_budget_service.GetAccountBudgetRequest = None,
*,
resource_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> account_budget.AccountBudget:
r"""Returns an account-level budget in full detail.
Args:
request (:class:`google.ads.googleads.v5.services.types.GetAccountBudgetRequest`):
The request object. Request message for
[AccountBudgetService.GetAccountBudget][google.ads.googleads.v5.services.AccountBudgetService.GetAccountBudget].
resource_name (:class:`str`):
Required. The resource name of the
account-level 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.v5.resources.types.AccountBudget:
An account-level budget. It contains information about the budget itself,
as well as the most recently approved changes to the
budget and proposed changes that are pending
approval. The proposed changes that are pending
approval, if any, are found in 'pending_proposal'.
Effective details about the budget are found in
fields prefixed '`approved <>`__', '`adjusted <>`__'
and those without a prefix. Since some effective
details may differ from what the user had originally
requested (e.g. spending limit), these differences
are juxtaposed via '`proposed <>`__',
'`approved <>`__', and possibly '`adjusted <>`__'
fields.
This resource is mutated using AccountBudgetProposal
and cannot be mutated directly. A budget may have at
most one pending proposal at any given time. It is
read through pending_proposal.
Once approved, a budget may be subject to
adjustments, such as credit adjustments. Adjustments
create differences between the 'approved' and
'adjusted' fields, which would otherwise be
identical.
"""
# 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 account_budget_service.GetAccountBudgetRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request,
account_budget_service.GetAccountBudgetRequest):
request = account_budget_service.GetAccountBudgetRequest(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_account_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