def test_mutate_ad_groups_field_headers():
client = AdGroupServiceClient(
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 = ad_group_service.MutateAdGroupsRequest()
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_ad_groups),
'__call__') as call:
call.return_value = ad_group_service.MutateAdGroupsResponse()
client.mutate_ad_groups(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_ad_groups_flattened():
client = AdGroupServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.mutate_ad_groups),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = ad_group_service.MutateAdGroupsResponse()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.mutate_ad_groups(
customer_id='customer_id_value',
operations=[
ad_group_service.AdGroupOperation(
update_mask=field_mask_pb2.FieldMask(
paths=['paths_value']))
],
)
# Establish that the underlying call was made with the expected
# request object values.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].customer_id == 'customer_id_value'
assert args[0].operations == [
ad_group_service.AdGroupOperation(
update_mask=field_mask_pb2.FieldMask(paths=['paths_value']))
]
def test_mutate_ad_groups(transport: str = 'grpc',
request_type=ad_group_service.MutateAdGroupsRequest):
client = AdGroupServiceClient(
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_ad_groups),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = ad_group_service.MutateAdGroupsResponse()
response = client.mutate_ad_groups(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == ad_group_service.MutateAdGroupsRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, ad_group_service.MutateAdGroupsResponse)
def test_parse_common_project_path():
expected = {
"project": "mussel",
}
path = AdGroupServiceClient.common_project_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_common_project_path(path)
assert expected == actual
def test_parse_common_organization_path():
expected = {
"organization": "nudibranch",
}
path = AdGroupServiceClient.common_organization_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_common_organization_path(path)
assert expected == actual
def test_parse_common_folder_path():
expected = {
"folder": "octopus",
}
path = AdGroupServiceClient.common_folder_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_common_folder_path(path)
assert expected == actual
def test_parse_common_billing_account_path():
expected = {
"billing_account": "clam",
}
path = AdGroupServiceClient.common_billing_account_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_common_billing_account_path(path)
assert expected == actual
def test_parse_common_location_path():
expected = {
"project": "scallop",
"location": "abalone",
}
path = AdGroupServiceClient.common_location_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_common_location_path(path)
assert expected == actual
def test_parse_campaign_path():
expected = {
"customer": "scallop",
"campaign": "abalone",
}
path = AdGroupServiceClient.campaign_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_campaign_path(path)
assert expected == actual
def test_parse_ad_group_path():
expected = {
"customer": "whelk",
"ad_group": "octopus",
}
path = AdGroupServiceClient.ad_group_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_ad_group_path(path)
assert expected == actual
def test_parse_ad_group_label_path():
expected = {
"customer": "cuttlefish",
"ad_group_label": "mussel",
}
path = AdGroupServiceClient.ad_group_label_path(**expected)
# Check that the path construction is reversible.
actual = AdGroupServiceClient.parse_ad_group_label_path(path)
assert expected == actual
def test_get_ad_group_flattened_error():
client = AdGroupServiceClient(
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_ad_group(
ad_group_service.GetAdGroupRequest(),
resource_name='resource_name_value',
)
def test_ad_group_service_client_from_service_account_file():
creds = ga_credentials.AnonymousCredentials()
with mock.patch.object(service_account.Credentials,
'from_service_account_file') as factory:
factory.return_value = creds
client = AdGroupServiceClient.from_service_account_file(
"dummy/file/path.json")
assert client.transport._credentials == creds
client = AdGroupServiceClient.from_service_account_json(
"dummy/file/path.json")
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_ad_group_service_host_with_port():
client = AdGroupServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_options=client_options.ClientOptions(
api_endpoint='googleads.googleapis.com:8000'),
)
assert client.transport._host == 'googleads.googleapis.com:8000'
def test_ad_group_service_auth_adc():
# If no credentials are provided, we should use ADC credentials.
with mock.patch.object(google.auth, 'default') as adc:
adc.return_value = (ga_credentials.AnonymousCredentials(), None)
AdGroupServiceClient()
adc.assert_called_once_with(
scopes=('https://www.googleapis.com/auth/adwords', ))
def test_mutate_ad_groups_flattened_error():
client = AdGroupServiceClient(
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_ad_groups(
ad_group_service.MutateAdGroupsRequest(),
customer_id='customer_id_value',
operations=[
ad_group_service.AdGroupOperation(
update_mask=field_mask_pb2.FieldMask(
paths=['paths_value']))
],
)
def test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = AdGroupServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
assert isinstance(
client.transport,
transports.AdGroupServiceGrpcTransport,
)
def test_get_ad_group_flattened():
client = AdGroupServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.get_ad_group),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = ad_group.AdGroup()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.get_ad_group(resource_name='resource_name_value', )
# Establish that the underlying call was made with the expected
# request object values.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].resource_name == 'resource_name_value'
def test_campaign_path():
customer = "winkle"
campaign = "nautilus"
expected = "customers/{customer}/campaigns/{campaign}".format(
customer=customer,
campaign=campaign,
)
actual = AdGroupServiceClient.campaign_path(customer, campaign)
assert expected == actual
def test_ad_group_path():
customer = "squid"
ad_group = "clam"
expected = "customers/{customer}/adGroups/{ad_group}".format(
customer=customer,
ad_group=ad_group,
)
actual = AdGroupServiceClient.ad_group_path(customer, ad_group)
assert expected == actual
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.AdGroupServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = AdGroupServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
transport=transport,
)
def test_ad_group_label_path():
customer = "oyster"
ad_group_label = "nudibranch"
expected = "customers/{customer}/adGroupLabels/{ad_group_label}".format(
customer=customer,
ad_group_label=ad_group_label,
)
actual = AdGroupServiceClient.ad_group_label_path(customer, ad_group_label)
assert expected == actual
def test_common_location_path():
project = "winkle"
location = "nautilus"
expected = "projects/{project}/locations/{location}".format(
project=project,
location=location,
)
actual = AdGroupServiceClient.common_location_path(project, location)
assert expected == actual
def test_get_ad_group(transport: str = 'grpc',
request_type=ad_group_service.GetAdGroupRequest):
client = AdGroupServiceClient(
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_ad_group),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = ad_group.AdGroup(
resource_name='resource_name_value',
status=ad_group_status.AdGroupStatusEnum.AdGroupStatus.UNKNOWN,
type_=ad_group_type.AdGroupTypeEnum.AdGroupType.UNKNOWN,
ad_rotation_mode=ad_group_ad_rotation_mode.
AdGroupAdRotationModeEnum.AdGroupAdRotationMode.UNKNOWN,
display_custom_bid_dimension=targeting_dimension.
TargetingDimensionEnum.TargetingDimension.UNKNOWN,
effective_target_cpa_source=bidding_source.BiddingSourceEnum.
BiddingSource.UNKNOWN,
effective_target_roas_source=bidding_source.BiddingSourceEnum.
BiddingSource.UNKNOWN,
)
response = client.get_ad_group(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == ad_group_service.GetAdGroupRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, ad_group.AdGroup)
assert response.resource_name == 'resource_name_value'
assert response.status == ad_group_status.AdGroupStatusEnum.AdGroupStatus.UNKNOWN
assert response.type_ == ad_group_type.AdGroupTypeEnum.AdGroupType.UNKNOWN
assert response.ad_rotation_mode == ad_group_ad_rotation_mode.AdGroupAdRotationModeEnum.AdGroupAdRotationMode.UNKNOWN
assert response.display_custom_bid_dimension == targeting_dimension.TargetingDimensionEnum.TargetingDimension.UNKNOWN
assert response.effective_target_cpa_source == bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN
assert response.effective_target_roas_source == bidding_source.BiddingSourceEnum.BiddingSource.UNKNOWN
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.AdGroupServiceTransport,
'_prep_wrapped_messages') as prep:
client = AdGroupServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.AdGroupServiceTransport,
'_prep_wrapped_messages') as prep:
transport_class = AdGroupServiceClient.get_transport_class()
transport = transport_class(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_ad_group_service_client_from_service_account_info():
creds = ga_credentials.AnonymousCredentials()
with mock.patch.object(service_account.Credentials,
'from_service_account_info') as factory:
factory.return_value = creds
info = {"valid": True}
client = AdGroupServiceClient.from_service_account_info(info)
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_ad_group_service_client_client_options_from_dict():
with mock.patch(
'google.ads.googleads.v4.services.services.ad_group_service.transports.AdGroupServiceGrpcTransport.__init__'
) as grpc_transport:
grpc_transport.return_value = None
client = AdGroupServiceClient(
client_options={'api_endpoint': 'squid.clam.whelk'})
grpc_transport.assert_called_once_with(
ssl_channel_credentials=None,
credentials=None,
host="squid.clam.whelk",
client_info=transports.base.DEFAULT_CLIENT_INFO,
)
def test__get_default_mtls_endpoint():
api_endpoint = "example.googleapis.com"
api_mtls_endpoint = "example.mtls.googleapis.com"
sandbox_endpoint = "example.sandbox.googleapis.com"
sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com"
non_googleapi = "api.example.com"
assert AdGroupServiceClient._get_default_mtls_endpoint(None) is None
assert AdGroupServiceClient._get_default_mtls_endpoint(
api_endpoint) == api_mtls_endpoint
assert AdGroupServiceClient._get_default_mtls_endpoint(
api_mtls_endpoint) == api_mtls_endpoint
assert AdGroupServiceClient._get_default_mtls_endpoint(
sandbox_endpoint) == sandbox_mtls_endpoint
assert AdGroupServiceClient._get_default_mtls_endpoint(
sandbox_mtls_endpoint) == sandbox_mtls_endpoint
assert AdGroupServiceClient._get_default_mtls_endpoint(
non_googleapi) == non_googleapi
def test_common_project_path():
project = "cuttlefish"
expected = "projects/{project}".format(project=project, )
actual = AdGroupServiceClient.common_project_path(project)
assert expected == actual
def test_common_organization_path():
organization = "oyster"
expected = "organizations/{organization}".format(
organization=organization, )
actual = AdGroupServiceClient.common_organization_path(organization)
assert expected == actual