def test_promote_campaign_draft_field_headers():
client = CampaignDraftServiceClient(
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_draft_service.PromoteCampaignDraftRequest()
request.campaign_draft = 'campaign_draft/value'
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.promote_campaign_draft),
'__call__') as call:
call.return_value = operations_pb2.Operation(name='operations/op')
client.promote_campaign_draft(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',
'campaign_draft=campaign_draft/value',
) in kw['metadata']
def test_promote_campaign_draft(
transport: str = 'grpc',
request_type=campaign_draft_service.PromoteCampaignDraftRequest):
client = CampaignDraftServiceClient(
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.promote_campaign_draft),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = operations_pb2.Operation(name='operations/spam')
response = client.promote_campaign_draft(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_draft_service.PromoteCampaignDraftRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, future.Future)
def test_promote_campaign_draft_flattened_error():
client = CampaignDraftServiceClient(
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.promote_campaign_draft(
campaign_draft_service.PromoteCampaignDraftRequest(),
campaign_draft='campaign_draft_value',
)
def promote_campaign_draft(
self,
request: campaign_draft_service.PromoteCampaignDraftRequest = None,
*,
campaign_draft: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Promotes the changes in a draft back to the base campaign.
This method returns a Long Running Operation (LRO) indicating if
the Promote is done. Use [Operations.GetOperation] to poll the
LRO until it is done. Only a done status is returned in the
response. See the status in the Campaign Draft resource to
determine if the promotion was successful. If the LRO failed,
use
[CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v4.services.CampaignDraftService.ListCampaignDraftAsyncErrors]
to view the list of error reasons.
Args:
request (:class:`google.ads.googleads.v4.services.types.PromoteCampaignDraftRequest`):
The request object. Request message for
[CampaignDraftService.PromoteCampaignDraft][google.ads.googleads.v4.services.CampaignDraftService.PromoteCampaignDraft].
campaign_draft (:class:`str`):
Required. The resource name of the
campaign draft to promote.
This corresponds to the ``campaign_draft`` 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.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated
empty messages in your APIs. A typical example is to
use it as the request or the response type of an API
method. For instance:
service Foo {
rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for Empty is empty JSON
object {}.
"""
# 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([campaign_draft]):
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_draft_service.PromoteCampaignDraftRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request,
campaign_draft_service.PromoteCampaignDraftRequest):
request = campaign_draft_service.PromoteCampaignDraftRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if campaign_draft is not None:
request.campaign_draft = campaign_draft
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.promote_campaign_draft]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("campaign_draft", request.campaign_draft), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
empty.Empty,
metadata_type=empty.Empty,
)
# Done; return the response.
return response