def test_generate_keyword_ideas_field_headers():
client = KeywordPlanIdeaServiceClient(
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 = keyword_plan_idea_service.GenerateKeywordIdeasRequest()
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.generate_keyword_ideas),
'__call__') as call:
call.return_value = keyword_plan_idea_service.GenerateKeywordIdeaResponse()
client.generate_keyword_ideas(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_generate_keyword_ideas(transport: str = 'grpc', request_type=keyword_plan_idea_service.GenerateKeywordIdeasRequest):
client = KeywordPlanIdeaServiceClient(
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.generate_keyword_ideas),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = keyword_plan_idea_service.GenerateKeywordIdeaResponse(
next_page_token='next_page_token_value',
total_size=1086,
)
response = client.generate_keyword_ideas(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == keyword_plan_idea_service.GenerateKeywordIdeasRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, pagers.GenerateKeywordIdeasPager)
assert response.next_page_token == 'next_page_token_value'
assert response.total_size == 1086
def test_generate_keyword_ideas_pager():
client = KeywordPlanIdeaServiceClient(
credentials=ga_credentials.AnonymousCredentials,
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client.transport.generate_keyword_ideas),
'__call__') as call:
# Set the response to a series of pages.
call.side_effect = (
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='abc',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[],
next_page_token='def',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='ghi',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
),
RuntimeError,
)
metadata = ()
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata((
('customer_id', ''),
)),
)
pager = client.generate_keyword_ideas(request={})
assert pager._metadata == metadata
results = [i for i in pager]
assert len(results) == 6
assert all(isinstance(i, keyword_plan_idea_service.GenerateKeywordIdeaResult)
for i in results)
def test_generate_keyword_ideas_pages():
client = KeywordPlanIdeaServiceClient(
credentials=ga_credentials.AnonymousCredentials,
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client.transport.generate_keyword_ideas),
'__call__') as call:
# Set the response to a series of pages.
call.side_effect = (
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='abc',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[],
next_page_token='def',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
next_page_token='ghi',
),
keyword_plan_idea_service.GenerateKeywordIdeaResponse(
results=[
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
keyword_plan_idea_service.GenerateKeywordIdeaResult(),
],
),
RuntimeError,
)
pages = list(client.generate_keyword_ideas(request={}).pages)
for page_, token in zip(pages, ['abc','def','ghi', '']):
assert page_.raw_page.next_page_token == token
