docs(liveramp-audiences): clarify that uploaded files are gzipped#3791
Open
scottlepich-lz wants to merge 1 commit into
Open
docs(liveramp-audiences): clarify that uploaded files are gzipped#3791scottlepich-lz wants to merge 1 commit into
scottlepich-lz wants to merge 1 commit into
Conversation
The action passes `gzipCompressFile: true` to the backend by default
(see audienceEnteredS3/index.ts:173, audienceEnteredSftp/index.ts:151),
so files land in the customer's S3/SFTP with `.gz` appended to the
filename. The current Filename field description and its default value
(e.g. `{{properties.audience_key}}.csv`) imply the file lands as `.csv`,
which led at least one team to chase 404s on the non-gzipped filename
before discovering the actual extension.
Update the field description for both S3 and SFTP variants to call out
the gzip + `.gz` extension behavior. Regenerated types via
`./bin/run generate:types`.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the LiveRamp Audiences destination action field documentation to clarify that uploaded audience files are gzipped and that .gz is appended to the delivered filename, and regenerates the corresponding generated types.
Changes:
- Update
filenamefield descriptions for Audience Entered (S3) and Audience Entered (SFTP) to mention gzip +.gzsuffix behavior. - Regenerate action
generated-types.tsfiles to reflect the updated field descriptions.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/destination-actions/src/destinations/liveramp-audiences/audienceEnteredSftp/index.ts | Updates the filename field description for the SFTP action to mention gzip + .gz suffix. |
| packages/destination-actions/src/destinations/liveramp-audiences/audienceEnteredSftp/generated-types.ts | Regenerates types/docs to reflect the updated SFTP filename description. |
| packages/destination-actions/src/destinations/liveramp-audiences/audienceEnteredS3/index.ts | Updates the filename field description for the S3 action to mention gzip + .gz suffix. |
| packages/destination-actions/src/destinations/liveramp-audiences/audienceEnteredS3/generated-types.ts | Regenerates types/docs to reflect the updated S3 filename description. |
| filename: { | ||
| label: 'Filename', | ||
| description: `Name of the CSV file to upload for LiveRamp ingestion. For multiple subscriptions, make sure to use a unique filename for each subscription.`, | ||
| description: `Name of the CSV file to upload for LiveRamp ingestion. Files are gzipped before upload and \`.gz\` is appended to the filename in the destination S3 bucket (e.g. \`audience.csv\` becomes \`audience.csv.gz\`). For multiple subscriptions, make sure to use a unique filename for each subscription.`, |
| filename: { | ||
| label: 'Filename', | ||
| description: `Name of the CSV file to upload for LiveRamp ingestion. For multiple subscriptions, make sure to use a unique filename for each subscription.`, | ||
| description: `Name of the CSV file to upload for LiveRamp ingestion. Files are gzipped before upload and \`.gz\` is appended to the filename in the destination SFTP folder (e.g. \`audience_PII.csv\` becomes \`audience_PII.csv.gz\`). For multiple subscriptions, make sure to use a unique filename for each subscription.`, |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies the
Filenamefield description for bothAudience Entered (S3)andAudience Entered (SFTP)actions to note that files are gzipped on upload and.gzis appended to the filename in the destination bucket/folder.Why
The action passes
gzipCompressFile: trueto the backend by default (audienceEnteredS3/index.ts:173, audienceEnteredSftp/index.ts:151), so the file delivered to the customer's S3/SFTP has.gzappended (e.g.audience.csv.gz).The current field description ("Name of the CSV file to upload for LiveRamp ingestion. For multiple subscriptions, make sure to use a unique filename for each subscription.") combined with the default value (
{{properties.audience_key}}.csv) implies the file lands as.csv. A team integrating with this destination chased 404s on the non-gzipped filename in S3 before discovering the actual extension.Changes
audienceEnteredS3/index.ts— append gzip +.gznote tofilenamefield descriptionaudienceEnteredSftp/index.ts— append gzip +.gznote tofilenamefield descriptionaudienceEnteredS3/generated-types.ts— regenerated via./bin/run generate:typesaudienceEnteredSftp/generated-types.ts— regenerated via./bin/run generate:typesNo behavior changes; docs-only.
Testing
Description-only update; no runtime behavior changes. Verified types regenerate cleanly via the existing tooling.