def __init__(
self,
method: Callable[
..., campaign_draft_service.ListCampaignDraftAsyncErrorsResponse
],
request: campaign_draft_service.ListCampaignDraftAsyncErrorsRequest,
response: campaign_draft_service.ListCampaignDraftAsyncErrorsResponse,
metadata: Sequence[Tuple[str, str]] = (),
):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (:class:`google.ads.googleads.v5.services.types.ListCampaignDraftAsyncErrorsRequest`):
The initial request object.
response (:class:`google.ads.googleads.v5.services.types.ListCampaignDraftAsyncErrorsResponse`):
The initial response object.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = campaign_draft_service.ListCampaignDraftAsyncErrorsRequest(
request
)
self._response = response
self._metadata = metadata
def test_list_campaign_draft_async_errors_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.ListCampaignDraftAsyncErrorsRequest()
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.list_campaign_draft_async_errors),
'__call__') as call:
call.return_value = campaign_draft_service.ListCampaignDraftAsyncErrorsResponse()
client.list_campaign_draft_async_errors(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_list_campaign_draft_async_errors(transport: str = 'grpc', request_type=campaign_draft_service.ListCampaignDraftAsyncErrorsRequest):
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.list_campaign_draft_async_errors),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = campaign_draft_service.ListCampaignDraftAsyncErrorsResponse(
next_page_token='next_page_token_value',
)
response = client.list_campaign_draft_async_errors(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.ListCampaignDraftAsyncErrorsRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, pagers.ListCampaignDraftAsyncErrorsPager)
assert response.next_page_token == 'next_page_token_value'
def test_list_campaign_draft_async_errors_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.list_campaign_draft_async_errors(
campaign_draft_service.ListCampaignDraftAsyncErrorsRequest(),
resource_name='resource_name_value',
)
def list_campaign_draft_async_errors(
self,
request: campaign_draft_service.
ListCampaignDraftAsyncErrorsRequest = None,
*,
resource_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListCampaignDraftAsyncErrorsPager:
r"""Returns all errors that occurred during CampaignDraft
promote. Throws an error if called before campaign draft
is promoted. Supports standard list paging.
Args:
request (:class:`google.ads.googleads.v5.services.types.ListCampaignDraftAsyncErrorsRequest`):
The request object. Request message for
[CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v5.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
resource_name (:class:`str`):
Required. The name of the campaign
draft from which to retrieve the async
errors.
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.services.services.campaign_draft_service.pagers.ListCampaignDraftAsyncErrorsPager:
Response message for
[CampaignDraftService.ListCampaignDraftAsyncErrors][google.ads.googleads.v5.services.CampaignDraftService.ListCampaignDraftAsyncErrors].
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# 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_draft_service.ListCampaignDraftAsyncErrorsRequest.
# 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.ListCampaignDraftAsyncErrorsRequest):
request = campaign_draft_service.ListCampaignDraftAsyncErrorsRequest(
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.list_campaign_draft_async_errors]
# 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,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListCampaignDraftAsyncErrorsPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response