package google.aggregate.protos.shared.backend

Get desktop application:
View/edit binary Protocol Buffers messages

* The request object for the Aggregation Service Frontend API that allows ad-techs to request aggregation reports for conversion data.

Used in: metadatadb.JobMetadata

• string job_request_id = 1

  * Unique identifier provided by the ad-tech.

• string input_data_blob_prefix = 2

  * Name of the input prefix data file.

• string input_data_bucket_name = 3

  * Bucket name for the input data file.

• string output_data_blob_prefix = 4

  * Name of the output prefix data file.

• string output_data_bucket_name = 5

  * Bucket name for the output data file.

• string output_domain_blob_prefix = 6

  * URL to the output domain file. This is derived from jobParameters.

• string output_domain_bucket_name = 7

  * URL to the output domain file. This is derived from jobParameters.

• string postback_url = 8

  * URL to notify the result.

• string attribution_report_to = 9

  * Ad-tech origin where reports will be sent. This is derived from jobParameters.

• int32 debug_privacy_budget_limit = 10

  * Optional debugging privacy-budget-limit to be passed to privacy-budget-service during the origin trial period. This is derived from jobParameters.

• map<string, string> job_parameters = 11

  * Data plane application specific parameters.

• string reporting_site = 12

  * Ad-tech reporting site where reports will be sent. This is derived from jobParameters.

• repeated string input_data_blob_prefixes = 13

  * List of URLs to the input prefix data files.

* The response returned for the CreateJob API call.

(message has no fields)

* Count of errors for a given category.

Used in: ErrorSummary

• string category = 1

  * The category of the error.

• int64 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

• int64 num_reports_with_errors = 1

  * Count of reports that had errors and thus were not included in computing the NoisedAggregationResult.

• repeated ErrorCount error_counts = 2

  * Count of errors by category.

• repeated string error_messages = 3

  * List of exceptions thrown when running the job.

* Describes a category of error message, used to distinguish between various decryption or validation failures reported by the ErrorSummary message.

• JOB_ERROR_CATEGORY_UNKNOWN = 0

• DECRYPTION_ERROR = 1

• HYBRID_KEY_ID_MISSING = 2

• UNSUPPORTED_OPERATION = 3

• GENERAL_ERROR = 4

• NUM_REPORTS_WITH_ERRORS = 5

  TODO: Remove when removing numReportsWithErrors from shared ErrorSummary

* Unique identifier for the job, used for identifying entries in the database and Pub/Sub.

Used in: metadatadb.JobMetadata

• string job_request_id = 1

  * ID for request tracking.

• string jobRequestId = 1

  * User provided ID for request tracking.

• string serverJobId = 2

  * Server-side provided ID for request tracking.

* The job parameters for the job requested by the operator. <p><b>Important:</b> Add conversion logic for the new field's type in {@link AttributeConverterUtils}.

• optional string output_domain_blob_prefix = 1

  For a single domain file, it's a file path in the bucket. For multiple domain files, it's a prefix in the file path.

• optional string output_domain_bucket_name = 2

  Domain file bucket.

• optional string attribution_report_to = 3

  Reporting URL which should be same as the reporting_origin present in the reports' shared_info.

• optional string reporting_site = 4

  reporting site that is onboarded to aggregation service.

• optional double debug_privacy_epsilon = 5

  Differential privacy epsilon value to be used for this job.

• optional double report_error_threshold_percentage = 6

  The percentage of reports, if excluded from aggregation due to an error, will fail the job.

• optional int64 input_report_count = 7

  Total number of reports provided as input data for this job.

• optional string filtering_ids = 8

  A list of unsigned filtering IDs separated by comma.

• optional bool debug_run = 9

  When executing a debug run, noised and unnoised debug summary report and annotations are added to indicate which keys are present in the domain input and/or reports.

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

Used in: metadatadb.JobMetadata

• JOB_STATUS_UNKNOWN = 0

• RECEIVED = 1

  Job has been received 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

* The request info for the job requested by the operator.

Used in: metadatadb.JobMetadata

• string job_request_id = 1

  * Unique identifier provided by the operator.

• string input_data_blob_prefix = 2

  * URL of the input data file.

• string input_data_bucket_name = 3

  * Bucket name to store the input data file.

• string output_data_blob_prefix = 4

  * URL of the output data file.

• string output_data_bucket_name = 5

  * Bucket name to store the output 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.

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

Used in: metadatadb.JobMetadata

• 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