def test_get_campaign_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.GetCampaignRequest() 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.get_campaign), '__call__') as call: call.return_value = campaign.Campaign() 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] == 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_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_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', id=205, name='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, tracking_url_template='tracking_url_template_value', labels=['labels_value'], experiment_type=campaign_experiment_type.CampaignExperimentTypeEnum.CampaignExperimentType.UNKNOWN, base_campaign='base_campaign_value', campaign_budget='campaign_budget_value', bidding_strategy_type=bidding_strategy_type.BiddingStrategyTypeEnum.BiddingStrategyType.UNKNOWN, start_date='start_date_value', end_date='end_date_value', final_url_suffix='final_url_suffix_value', video_brand_safety_suitability=brand_safety_suitability.BrandSafetySuitabilityEnum.BrandSafetySuitability.UNKNOWN, payment_mode=payment_mode.PaymentModeEnum.PaymentMode.UNKNOWN, optimization_score=0.1954, bidding_strategy='bidding_strategy_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.id == 205 assert response.name == '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.tracking_url_template == 'tracking_url_template_value' assert response.labels == ['labels_value'] assert response.experiment_type == campaign_experiment_type.CampaignExperimentTypeEnum.CampaignExperimentType.UNKNOWN assert response.base_campaign == 'base_campaign_value' assert response.campaign_budget == 'campaign_budget_value' assert response.bidding_strategy_type == bidding_strategy_type.BiddingStrategyTypeEnum.BiddingStrategyType.UNKNOWN assert response.start_date == 'start_date_value' assert response.end_date == 'end_date_value' assert response.final_url_suffix == 'final_url_suffix_value' assert response.video_brand_safety_suitability == brand_safety_suitability.BrandSafetySuitabilityEnum.BrandSafetySuitability.UNKNOWN assert response.payment_mode == payment_mode.PaymentModeEnum.PaymentMode.UNKNOWN assert math.isclose(response.optimization_score, 0.1954, rel_tol=1e-6)
def get_campaign( self, request: campaign_service.GetCampaignRequest = None, *, resource_name: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> campaign.Campaign: r"""Returns the requested campaign in full detail. Args: request (:class:`google.ads.googleads.v5.services.types.GetCampaignRequest`): The request object. Request message for [CampaignService.GetCampaign][google.ads.googleads.v5.services.CampaignService.GetCampaign]. resource_name (:class:`str`): Required. The resource name of the campaign to fetch. 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.resources.types.Campaign: A campaign. """ # 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_service.GetCampaignRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, campaign_service.GetCampaignRequest): request = campaign_service.GetCampaignRequest(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.get_campaign] # 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, ) # Done; return the response. return response