Class CampaignExperimentServiceGrpc.CampaignExperimentServiceImplBase

  • All Implemented Interfaces:
    io.grpc.BindableService
    Enclosing class:
    CampaignExperimentServiceGrpc

    public abstract static class CampaignExperimentServiceGrpc.CampaignExperimentServiceImplBase
    extends java.lang.Object
    implements io.grpc.BindableService
     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.
     
    • Constructor Detail

      • CampaignExperimentServiceImplBase

        public CampaignExperimentServiceImplBase()
    • Method Detail

      • createCampaignExperiment

        public void createCampaignExperiment​(CreateCampaignExperimentRequest request,
                                             io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         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]()
         
      • mutateCampaignExperiments

        public void mutateCampaignExperiments​(MutateCampaignExperimentsRequest request,
                                              io.grpc.stub.StreamObserver<MutateCampaignExperimentsResponse> responseObserver)
         Updates campaign experiments. Operation statuses are returned.
         List of thrown errors:
           [AuthenticationError]()
           [AuthorizationError]()
           [CampaignExperimentError]()
           [HeaderError]()
           [InternalError]()
           [QuotaError]()
           [RequestError]()
         
      • graduateCampaignExperiment

        public void graduateCampaignExperiment​(GraduateCampaignExperimentRequest request,
                                               io.grpc.stub.StreamObserver<GraduateCampaignExperimentResponse> responseObserver)
         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]()
         
      • promoteCampaignExperiment

        public void promoteCampaignExperiment​(PromoteCampaignExperimentRequest request,
                                              io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         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]()
         
      • endCampaignExperiment

        public void endCampaignExperiment​(EndCampaignExperimentRequest request,
                                          io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         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]()
         
      • listCampaignExperimentAsyncErrors

        public void listCampaignExperimentAsyncErrors​(ListCampaignExperimentAsyncErrorsRequest request,
                                                      io.grpc.stub.StreamObserver<ListCampaignExperimentAsyncErrorsResponse> responseObserver)
         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]()
         
      • bindService

        public final io.grpc.ServerServiceDefinition bindService()
        Specified by:
        bindService in interface io.grpc.BindableService