def test_mutate_campaigns(transport: str = 'grpc', request_type=campaign_service.MutateCampaignsRequest):
client = CampaignServiceClient(
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.mutate_campaigns),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = campaign_service.MutateCampaignsResponse(
)
response = client.mutate_campaigns(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_service.MutateCampaignsRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, campaign_service.MutateCampaignsResponse)
def test_mutate_campaigns_field_headers():
client = CampaignServiceClient(
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_service.MutateCampaignsRequest()
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.mutate_campaigns),
'__call__') as call:
call.return_value = campaign_service.MutateCampaignsResponse()
client.mutate_campaigns(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_mutate_campaigns_flattened_error():
client = CampaignServiceClient(
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.mutate_campaigns(
campaign_service.MutateCampaignsRequest(),
customer_id='customer_id_value',
operations=[campaign_service.CampaignOperation(update_mask=field_mask_pb2.FieldMask(paths=['paths_value']))],
)
def mutate_campaigns(
self,
request: campaign_service.MutateCampaignsRequest = None,
*,
customer_id: str = None,
operations: Sequence[campaign_service.CampaignOperation] = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> campaign_service.MutateCampaignsResponse:
r"""Creates, updates, or removes campaigns. Operation statuses are
returned.
List of thrown errors: `AdxError <>`__
`AuthenticationError <>`__ `AuthorizationError <>`__
`BiddingError <>`__ `BiddingStrategyError <>`__
`CampaignBudgetError <>`__ `CampaignError <>`__
`ContextError <>`__ `DatabaseError <>`__ `DateError <>`__
`DateRangeError <>`__ `DistinctError <>`__ `FieldError <>`__
`FieldMaskError <>`__ `HeaderError <>`__ `IdError <>`__
`InternalError <>`__ `ListOperationError <>`__
`MutateError <>`__ `NewResourceCreationError <>`__
`NotAllowlistedError <>`__ `NotEmptyError <>`__ `NullError <>`__
`OperationAccessDeniedError <>`__ `OperatorError <>`__
`QuotaError <>`__ `RangeError <>`__ `RegionCodeError <>`__
`RequestError <>`__ `ResourceCountLimitExceededError <>`__
`SettingError <>`__ `SizeLimitError <>`__
`StringFormatError <>`__ `StringLengthError <>`__
`UrlFieldError <>`__
Args:
request (:class:`google.ads.googleads.v8.services.types.MutateCampaignsRequest`):
The request object. Request message for
[CampaignService.MutateCampaigns][google.ads.googleads.v8.services.CampaignService.MutateCampaigns].
customer_id (:class:`str`):
Required. The ID of the customer
whose campaigns are being modified.
This corresponds to the ``customer_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
operations (:class:`Sequence[google.ads.googleads.v8.services.types.CampaignOperation]`):
Required. The list of operations to
perform on individual campaigns.
This corresponds to the ``operations`` 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.services.types.MutateCampaignsResponse:
Response message for campaign mutate.
"""
# 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, operations]):
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_service.MutateCampaignsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, campaign_service.MutateCampaignsRequest):
request = campaign_service.MutateCampaignsRequest(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 operations is not None:
request.operations = operations
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.mutate_campaigns]
# 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