package google.aggregate.protos.frontend.api.v1

Get desktop application:
View/edit binary Protocol Buffers messages

* The request object for the AggregationService Frontend API that allows ad-techs to request aggregation reports for conversion data. NOTE: Classes exist that mirror this, please update those classes if you are adding fields to this class.

• string job_request_id = 1

  * Unique identifier provided by the ad-tech.

• string input_data_blob_prefix = 2

  * URL to the input prefix data file.

• string input_data_bucket_name = 3

  * URL to the input bucket data file.

• string output_data_blob_prefix = 4

  * URL to the output prefix data file.

• string output_data_bucket_name = 5

  * URL to the output bucket data file.

• string postback_url = 6

  * URL to notify the result.

• map<string, string> job_parameters = 7

  * Data plane application specific parameters.

• string account_identity = 8

  * The caller identity (email or service account in GCP).

• repeated string input_data_blob_prefixes = 9

  * List of URLs to the input prefix data files.

* The response returned for the CreateJob API call.

(message has no fields)

* Count of errors per a given category

Used in: ErrorSummary

• string category = 1

  * The category of the error.

• int32 count = 2

  * The count of errors in the specified category.

• string description = 3

  * Description of the error.

* Summary of errors to be provided to the requester as debugging information.

Used in: ResultInfo

• repeated ErrorCount error_counts = 1

  * Count of errors by category.

• repeated string error_messages = 2

  * List of exceptions thrown when running the job.

* GET request for returning Job details.

• string job_request_id = 1

* The response returned from the GetJob API call.

• JobStatus job_status = 1

  * Enum value representing the current status of the job.

• optional protobuf.Timestamp request_received_at = 2

  * The time the request was received.

• optional protobuf.Timestamp request_updated_at = 3

  * The time the request was updated.

• string job_request_id = 4

  * Unique identifier provided by the ad-tech.

• string input_data_blob_prefix = 5

  * Name of the input data file.

• string input_data_bucket_name = 6

  * Bucket name for the input data file.

• string output_data_blob_prefix = 7

  * Name of the output data file.

• string output_data_bucket_name = 8

  * Bucket name for the output data file.

• string postback_url = 9

  * URL to notify the result.

• optional ResultInfo result_info = 10

  * Data generated by the worker during processing.

• map<string, string> job_parameters = 11

  * Data plane application specific parameters.

• optional protobuf.Timestamp request_processing_started_at = 12

  * The time the worker starts to process the request.

• repeated string input_data_blob_prefixes = 13

  * List of URLs to the input prefix data files.

* Unique identifier for the job, used for identifying entries in the DB and PubSub. Both the jobRequestId and the attributionReportTo are needed to identify a job as multiple ad-tech's might be using the same aggregation service instance.

• string job_request_id = 1

  * ID for request tracking.

• string attribution_report_to = 2

  * Domain of the ad-tech, used to identify the ad-tech.

* Indicates the current state of the job as it is processed.

Used in: GetJobResponse

• JOB_STATUS_UNKNOWN = 0

• RECEIVED = 1

  * Job has been recieved by aggregation service but aggregation hasn't started

• IN_PROGRESS = 2

  * Aggregation has started (or it started, failed, and will be retried)

• FINISHED = 3

  * Job is finished and no further updates will be made

* Object for result data generated by the worker during processing.

Used in: GetJobResponse

• string return_code = 1

  * Return code for the aggregation job.

• string return_message = 2

  * Return message for the aggregation job.

• optional ErrorSummary error_summary = 3

  * Summary of partial failures in aggregation.

• optional protobuf.Timestamp finished_at = 4

  * Timestamp of the aggregation request completion.

* Return codes for aggregation worker.

• RETURN_CODE_UNKNOWN = 0

• SUCCESS = 1

  Job was successful.

• UNSPECIFIED_ERROR = 2

  An unspecified fatal error occurred.

• TIMEOUT = 3

  The aggregation request failed because it took too long.

• RETRIES_EXHAUSTED = 4

  The aggregation job retried too many times by different workers.

• INPUT_DATA_READ_FAILED = 5

  The aggregation service could not download the input data from cloud storage or the data was malformed and could not be read

• INPUT_DATA_TOO_SMALL = 6

  The input contained too few reports to be aggregated.

• OUTPUT_DATAWRITE_FAILED = 7

  The aggregation service could not write the aggregated result to cloud storage.

• INTERNAL_ERROR = 8

  Job failed due to an internal issue in aggregation service and can be retried