Interface ExperimentServiceGrpc.AsyncService

All Known Implementing Classes:
ExperimentServiceGrpc.ExperimentServiceImplBase
Enclosing class:
ExperimentServiceGrpc

public static interface ExperimentServiceGrpc.AsyncService
 Service to manage experiments.
 
  • Method Details

    • mutateExperiments

      default void mutateExperiments(MutateExperimentsRequest request, io.grpc.stub.StreamObserver<MutateExperimentsResponse> responseObserver)
       Creates, updates, or removes experiments. Operation statuses are returned.
       List of thrown errors:
         [AuthenticationError]()
         [AuthorizationError]()
         [ExperimentError]()
         [HeaderError]()
         [InternalError]()
         [QuotaError]()
         [RequestError]()
       
    • endExperiment

      default void endExperiment(EndExperimentRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Immediately ends an 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]()
         [ExperimentError]()
         [HeaderError]()
         [InternalError]()
         [QuotaError]()
         [RequestError]()
       
    • listExperimentAsyncErrors

      default void listExperimentAsyncErrors(ListExperimentAsyncErrorsRequest request, io.grpc.stub.StreamObserver<ListExperimentAsyncErrorsResponse> responseObserver)
       Returns all errors that occurred during the last Experiment update (either
       scheduling or promotion).
       Supports standard list paging.
       List of thrown errors:
         [AuthenticationError]()
         [AuthorizationError]()
         [HeaderError]()
         [InternalError]()
         [QuotaError]()
         [RequestError]()
       
    • graduateExperiment

      default void graduateExperiment(GraduateExperimentRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Graduates an experiment to a full campaign.
       List of thrown errors:
         [AuthenticationError]()
         [AuthorizationError]()
         [ExperimentError]()
         [HeaderError]()
         [InternalError]()
         [MutateError]()
         [QuotaError]()
         [RequestError]()
       
    • scheduleExperiment

      default void scheduleExperiment(ScheduleExperimentRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       Schedule an experiment. The in design campaign
       will be converted into a real campaign (called the experiment campaign)
       that will begin serving ads if successfully created.
       The experiment is scheduled immediately with status INITIALIZING.
       This method returns a long running operation that tracks the forking of the
       in design campaign. If the forking fails, a list of errors can be retrieved
       using the ListExperimentAsyncErrors method. The operation's
       metadata will be a string containing the resource name of the created
       experiment.
       List of thrown errors:
         [AuthenticationError]()
         [AuthorizationError]()
         [ExperimentError]()
         [DatabaseError]()
         [DateError]()
         [DateRangeError]()
         [FieldError]()
         [HeaderError]()
         [InternalError]()
         [QuotaError]()
         [RangeError]()
         [RequestError]()
       
    • promoteExperiment

      default void promoteExperiment(PromoteExperimentRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       Promotes the trial campaign thus applying changes in the trial campaign
       to the base campaign.
       This method returns a long running operation that tracks the promotion of
       the experiment campaign. If it fails, a list of errors can be retrieved
       using the ListExperimentAsyncErrors method. The operation's
       metadata will be a string containing the resource name of the created
       experiment.
       List of thrown errors:
         [AuthenticationError]()
         [AuthorizationError]()
         [ExperimentError]()
         [HeaderError]()
         [InternalError]()
         [QuotaError]()
         [RequestError]()