Struct googapis::google::ads::googleads::v8::services::campaign_experiment_service_client::CampaignExperimentServiceClient

pub struct CampaignExperimentServiceClient<T> { /* fields omitted */ }

CampaignExperimentService manages the life cycle of campaign experiments. It is used to create new experiments from drafts, modify experiment properties, promote changes in an experiment back to its base campaign, graduate experiments into new stand-alone campaigns, and to remove an experiment.

An experiment consists of two variants or arms - the base campaign and the experiment campaign, directing a fixed share of traffic to each arm. A campaign experiment is created from a draft of changes to the base campaign and will be a snapshot of changes in the draft at the time of creation.

Implementations

impl<T> CampaignExperimentServiceClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as Body>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor<F>(
    inner: T,
    interceptor: F
) -> CampaignExperimentServiceClient<InterceptedService<T, F>> where
    F: Interceptor,
    T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
    <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync, 

pub fn send_gzip(self) -> Self

Compress requests with gzip.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_gzip(self) -> Self

Enable decompressing responses with gzip.

pub async fn get_campaign_experiment(
    &mut self,
    request: impl IntoRequest<GetCampaignExperimentRequest>
) -> Result<Response<CampaignExperiment>, Status>

Returns the requested campaign experiment in full detail.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

pub async fn create_campaign_experiment(
    &mut self,
    request: impl IntoRequest<CreateCampaignExperimentRequest>
) -> Result<Response<Operation>, Status>

Creates a campaign experiment based on a campaign draft. The draft campaign will be forked into a real campaign (called the experiment campaign) that will begin serving ads if successfully created.

The campaign experiment is created immediately with status INITIALIZING. This method return a long running operation that tracks the forking of the draft campaign. If the forking fails, a list of errors can be retrieved using the ListCampaignExperimentAsyncErrors method. The operation’s metadata will be a StringValue containing the resource name of the created campaign experiment.

List of thrown errors: AuthenticationError AuthorizationError CampaignExperimentError DatabaseError DateError DateRangeError FieldError HeaderError InternalError QuotaError RangeError RequestError

pub async fn mutate_campaign_experiments(
    &mut self,
    request: impl IntoRequest<MutateCampaignExperimentsRequest>
) -> Result<Response<MutateCampaignExperimentsResponse>, Status>

Updates campaign experiments. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError CampaignExperimentError HeaderError InternalError QuotaError RequestError

pub async fn graduate_campaign_experiment(
    &mut self,
    request: impl IntoRequest<GraduateCampaignExperimentRequest>
) -> Result<Response<GraduateCampaignExperimentResponse>, Status>

Graduates a campaign experiment to a full campaign. The base and experiment campaigns will start running independently with their own budgets.

List of thrown errors: AuthenticationError AuthorizationError CampaignExperimentError HeaderError InternalError MutateError QuotaError RequestError

pub async fn promote_campaign_experiment(
    &mut self,
    request: impl IntoRequest<PromoteCampaignExperimentRequest>
) -> Result<Response<Operation>, Status>

Promotes the changes in a experiment campaign back to the base campaign.

The campaign experiment is updated immediately with status PROMOTING. This method return a long running operation that tracks the promoting of the experiment campaign. If the promoting fails, a list of errors can be retrieved using the ListCampaignExperimentAsyncErrors method.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

pub async fn end_campaign_experiment(
    &mut self,
    request: impl IntoRequest<EndCampaignExperimentRequest>
) -> Result<Response<()>, Status>

Immediately ends a campaign experiment, changing the experiment’s scheduled end date and without waiting for end of day. End date is updated to be the time of the request.

List of thrown errors: AuthenticationError AuthorizationError CampaignExperimentError HeaderError InternalError QuotaError RequestError

pub async fn list_campaign_experiment_async_errors(
    &mut self,
    request: impl IntoRequest<ListCampaignExperimentAsyncErrorsRequest>
) -> Result<Response<ListCampaignExperimentAsyncErrorsResponse>, Status>

Returns all errors that occurred during CampaignExperiment create or promote (whichever occurred last). Supports standard list paging.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Trait Implementations

impl<T: Clone> Clone for CampaignExperimentServiceClient<T>

fn clone(&self) -> CampaignExperimentServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for CampaignExperimentServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.