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():
client = CampaignServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# 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()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.mutate_campaigns(
customer_id='customer_id_value',
operations=[
campaign_service.CampaignOperation(
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 == [
campaign_service.CampaignOperation(
update_mask=field_mask_pb2.FieldMask(paths=['paths_value']))
]
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_parse_common_billing_account_path():
expected = {
"billing_account": "clam",
}
path = CampaignServiceClient.common_billing_account_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_common_billing_account_path(path)
assert expected == actual
def test_parse_common_folder_path():
expected = {
"folder": "octopus",
}
path = CampaignServiceClient.common_folder_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_common_folder_path(path)
assert expected == actual
def test_parse_common_organization_path():
expected = {
"organization": "nudibranch",
}
path = CampaignServiceClient.common_organization_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_common_organization_path(path)
assert expected == actual
def test_parse_common_project_path():
expected = {
"project": "mussel",
}
path = CampaignServiceClient.common_project_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_common_project_path(path)
assert expected == actual
def test_parse_bidding_strategy_path():
expected = {
"customer": "whelk",
"bidding_strategy": "octopus",
}
path = CampaignServiceClient.bidding_strategy_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_bidding_strategy_path(path)
assert expected == actual
def test_parse_common_location_path():
expected = {
"project": "scallop",
"location": "abalone",
}
path = CampaignServiceClient.common_location_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_common_location_path(path)
assert expected == actual
def test_parse_feed_path():
expected = {
"customer": "scallop",
"feed": "abalone",
}
path = CampaignServiceClient.feed_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_feed_path(path)
assert expected == actual
def test_parse_conversion_action_path():
expected = {
"customer": "cuttlefish",
"conversion_action": "mussel",
}
path = CampaignServiceClient.conversion_action_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_conversion_action_path(path)
assert expected == actual
def test_parse_campaign_label_path():
expected = {
"customer": "whelk",
"campaign_label": "octopus",
}
path = CampaignServiceClient.campaign_label_path(**expected)
# Check that the path construction is reversible.
actual = CampaignServiceClient.parse_campaign_label_path(path)
assert expected == actual
def test_get_campaign(transport: str = 'grpc',
request_type=campaign_service.GetCampaignRequest):
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.get_campaign),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = campaign.Campaign(
resource_name='resource_name_value',
status=campaign_status.CampaignStatusEnum.CampaignStatus.UNKNOWN,
serving_status=campaign_serving_status.CampaignServingStatusEnum.
CampaignServingStatus.UNKNOWN,
ad_serving_optimization_status=ad_serving_optimization_status.
AdServingOptimizationStatusEnum.AdServingOptimizationStatus.
UNKNOWN,
advertising_channel_type=advertising_channel_type.
AdvertisingChannelTypeEnum.AdvertisingChannelType.UNKNOWN,
advertising_channel_sub_type=advertising_channel_sub_type.
AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType.UNKNOWN,
experiment_type=campaign_experiment_type.
CampaignExperimentTypeEnum.CampaignExperimentType.UNKNOWN,
bidding_strategy_type=bidding_strategy_type.
BiddingStrategyTypeEnum.BiddingStrategyType.UNKNOWN,
video_brand_safety_suitability=brand_safety_suitability.
BrandSafetySuitabilityEnum.BrandSafetySuitability.UNKNOWN,
payment_mode=payment_mode.PaymentModeEnum.PaymentMode.UNKNOWN,
bidding_strategy=wrappers_pb2.StringValue(value='value_value'),
)
response = client.get_campaign(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.GetCampaignRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, campaign.Campaign)
assert response.resource_name == 'resource_name_value'
assert response.status == campaign_status.CampaignStatusEnum.CampaignStatus.UNKNOWN
assert response.serving_status == campaign_serving_status.CampaignServingStatusEnum.CampaignServingStatus.UNKNOWN
assert response.ad_serving_optimization_status == ad_serving_optimization_status.AdServingOptimizationStatusEnum.AdServingOptimizationStatus.UNKNOWN
assert response.advertising_channel_type == advertising_channel_type.AdvertisingChannelTypeEnum.AdvertisingChannelType.UNKNOWN
assert response.advertising_channel_sub_type == advertising_channel_sub_type.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType.UNKNOWN
assert response.experiment_type == campaign_experiment_type.CampaignExperimentTypeEnum.CampaignExperimentType.UNKNOWN
assert response.bidding_strategy_type == bidding_strategy_type.BiddingStrategyTypeEnum.BiddingStrategyType.UNKNOWN
assert response.video_brand_safety_suitability == brand_safety_suitability.BrandSafetySuitabilityEnum.BrandSafetySuitability.UNKNOWN
assert response.payment_mode == payment_mode.PaymentModeEnum.PaymentMode.UNKNOWN
def test_get_campaign_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.get_campaign(
campaign_service.GetCampaignRequest(),
resource_name='resource_name_value',
)
def test_campaign_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 = CampaignServiceClient.from_service_account_file(
"dummy/file/path.json")
assert client.transport._credentials == creds
client = CampaignServiceClient.from_service_account_json(
"dummy/file/path.json")
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_campaign_service_host_with_port():
client = CampaignServiceClient(
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_campaign_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)
CampaignServiceClient()
adc.assert_called_once_with(
scopes=('https://www.googleapis.com/auth/adwords', ))
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 test_transport_grpc_default():
# A client should use the gRPC transport by default.
client = CampaignServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
assert isinstance(
client.transport,
transports.CampaignServiceGrpcTransport,
)
def test_common_location_path():
project = "winkle"
location = "nautilus"
expected = "projects/{project}/locations/{location}".format(
project=project,
location=location,
)
actual = CampaignServiceClient.common_location_path(project, location)
assert expected == actual
def test_get_campaign_flattened():
client = CampaignServiceClient(
credentials=ga_credentials.AnonymousCredentials(), )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.get_campaign),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = campaign.Campaign()
# Call the method with a truthy value for each flattened field,
# using the keyword arguments to the method.
client.get_campaign(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 = "oyster"
campaign = "nudibranch"
expected = "customers/{customer}/campaigns/{campaign}".format(
customer=customer,
campaign=campaign,
)
actual = CampaignServiceClient.campaign_path(customer, campaign)
assert expected == actual
def test_feed_path():
customer = "winkle"
feed = "nautilus"
expected = "customers/{customer}/feeds/{feed}".format(
customer=customer,
feed=feed,
)
actual = CampaignServiceClient.feed_path(customer, feed)
assert expected == actual
def test_credentials_transport_error():
# It is an error to provide credentials and a transport instance.
transport = transports.CampaignServiceGrpcTransport(
credentials=ga_credentials.AnonymousCredentials(), )
with pytest.raises(ValueError):
client = CampaignServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
transport=transport,
)
def test_campaign_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 = CampaignServiceClient.from_service_account_info(info)
assert client.transport._credentials == creds
assert client.transport._host == 'googleads.googleapis.com:443'
def test_bidding_strategy_path():
customer = "squid"
bidding_strategy = "clam"
expected = "customers/{customer}/biddingStrategies/{bidding_strategy}".format(
customer=customer,
bidding_strategy=bidding_strategy,
)
actual = CampaignServiceClient.bidding_strategy_path(
customer, bidding_strategy)
assert expected == actual
def test_client_withDEFAULT_CLIENT_INFO():
client_info = gapic_v1.client_info.ClientInfo()
with mock.patch.object(transports.CampaignServiceTransport,
'_prep_wrapped_messages') as prep:
client = CampaignServiceClient(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
with mock.patch.object(transports.CampaignServiceTransport,
'_prep_wrapped_messages') as prep:
transport_class = CampaignServiceClient.get_transport_class()
transport = transport_class(
credentials=ga_credentials.AnonymousCredentials(),
client_info=client_info,
)
prep.assert_called_once_with(client_info)
def test_campaign_budget_path():
customer = "winkle"
campaign_budget = "nautilus"
expected = "customers/{customer}/campaignBudgets/{campaign_budget}".format(
customer=customer,
campaign_budget=campaign_budget,
)
actual = CampaignServiceClient.campaign_budget_path(
customer, campaign_budget)
assert expected == actual
def test_conversion_action_path():
customer = "oyster"
conversion_action = "nudibranch"
expected = "customers/{customer}/conversionActions/{conversion_action}".format(
customer=customer,
conversion_action=conversion_action,
)
actual = CampaignServiceClient.conversion_action_path(
customer, conversion_action)
assert expected == actual
def test_campaign_label_path():
customer = "squid"
campaign_label = "clam"
expected = "customers/{customer}/campaignLabels/{campaign_label}".format(
customer=customer,
campaign_label=campaign_label,
)
actual = CampaignServiceClient.campaign_label_path(customer,
campaign_label)
assert expected == actual
