Skip to content

Commit 939f32e

Browse files
pwsegpwseg
authored
Merge pull request #5186 from segmentio/STRATCONN-2936
initial documentation for LiveRamp
2 parents d883c53 + 9bd70c5 commit 939f32e

File tree

2 files changed

+386
-1
lines changed

2 files changed

+386
-1
lines changed

‎src/_data/catalog/destinations_private.yml

Lines changed: 339 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2023-08-10
2+
# destination data last updated 2023-08-14
33
items:
44
- id: 54521fd725e721e32a72eec6
55
display_name: Intercom
@@ -2454,6 +2454,344 @@ items:
24542454
source_ip:
24552455
'@path': $.context.ip
24562456
trigger: type = "track"
2457+
- id: 644ad6c6c4a87a3290450602
2458+
display_name: LiveRamp Audiences
2459+
name: LiveRamp Audiences
2460+
slug: liveramp-audiences
2461+
previous_names:
2462+
- Liveramp Audiences
2463+
- LiveRamp Audiences
2464+
url: connections/destinations/catalog/liveramp-audiences
2465+
website: http://www.segment.com
2466+
status: PRIVATE_BETA
2467+
logo:
2468+
url: https://cdn.filepicker.io/api/file/BE6oXQG4QzK346NMQMGN
2469+
mark:
2470+
url: https://cdn.filepicker.io/api/file/8SFtDBrtSrS5E14mAgsY
2471+
methods:
2472+
track: true
2473+
identify: true
2474+
group: true
2475+
alias: true
2476+
screen: false
2477+
page: true
2478+
platforms:
2479+
browser: true
2480+
mobile: false
2481+
server: true
2482+
warehouse: false
2483+
components: []
2484+
browserUnbundlingSupported: false
2485+
browserUnbundlingPublic: false
2486+
replay: false
2487+
settings: []
2488+
actions:
2489+
- id: 2Xg7PHV6kQDWdS8j2da66P
2490+
name: Audience Entered (SFTP)
2491+
slug: audienceEnteredSFTP
2492+
description: >-
2493+
Uploads audience membership data to a file through SFTP for LiveRamp
2494+
ingestion.
2495+
platform: CLOUD
2496+
hidden: false
2497+
defaultTrigger: event = "Audience Entered"
2498+
fields:
2499+
- id: tGxfi1U39HutwzzgLWiQKA
2500+
sortOrder: 0
2501+
fieldKey: sftp_username
2502+
label: Username
2503+
type: STRING
2504+
description: >-
2505+
User credentials for establishing an SFTP connection with
2506+
LiveRamp.
2507+
placeholder: ''
2508+
required: false
2509+
multiple: false
2510+
choices: null
2511+
dynamic: false
2512+
allowNull: false
2513+
- id: eMYDeCTLMjxvohvm4MV2CC
2514+
sortOrder: 1
2515+
fieldKey: sftp_password
2516+
label: Password
2517+
type: PASSWORD
2518+
description: >-
2519+
User credentials for establishing an SFTP connection with
2520+
LiveRamp.
2521+
placeholder: ''
2522+
required: false
2523+
multiple: false
2524+
choices: null
2525+
dynamic: false
2526+
allowNull: false
2527+
- id: uZaYkieggVYaDmhMmMZLhp
2528+
sortOrder: 2
2529+
fieldKey: sftp_folder_path
2530+
label: Folder Path
2531+
type: STRING
2532+
description: >-
2533+
Path within the LiveRamp SFTP server to upload the files to. This
2534+
path must exist and all subfolders must be pre-created.
2535+
placeholder: ''
2536+
defaultValue: /uploads/audience_name/
2537+
required: false
2538+
multiple: false
2539+
choices: null
2540+
dynamic: false
2541+
allowNull: false
2542+
- id: qPm2WwVKjpouBs9SWciPXA
2543+
sortOrder: 3
2544+
fieldKey: audience_key
2545+
label: Audience Key
2546+
type: STRING
2547+
description: Identifies the user within the entered audience.
2548+
placeholder: ''
2549+
defaultValue:
2550+
'@path': $.userId
2551+
required: true
2552+
multiple: false
2553+
choices: null
2554+
dynamic: false
2555+
allowNull: false
2556+
- id: oXgeC5u6aTFBzgv6SngdWc
2557+
sortOrder: 4
2558+
fieldKey: identifier_data
2559+
label: Identifier Data
2560+
type: OBJECT
2561+
description: Additional data pertaining to the user to be written to the file.
2562+
placeholder: ''
2563+
required: false
2564+
multiple: false
2565+
choices: null
2566+
dynamic: false
2567+
allowNull: false
2568+
- id: pKbpd2krbKopa9gPG5dKS5
2569+
sortOrder: 5
2570+
fieldKey: unhashed_identifier_data
2571+
label: Hashable Identifier Data
2572+
type: OBJECT
2573+
description: >-
2574+
Additional data pertaining to the user to be hashed before written
2575+
to the file
2576+
placeholder: ''
2577+
required: false
2578+
multiple: false
2579+
choices: null
2580+
dynamic: false
2581+
allowNull: false
2582+
- id: wRRj34tRjGFUzM9joAJc2x
2583+
sortOrder: 6
2584+
fieldKey: delimiter
2585+
label: Delimeter
2586+
type: STRING
2587+
description: Character used to separate tokens in the resulting file.
2588+
placeholder: ''
2589+
defaultValue: ','
2590+
required: true
2591+
multiple: false
2592+
choices: null
2593+
dynamic: false
2594+
allowNull: false
2595+
- id: x3oYSiXFYfM3GcQFPo9Aru
2596+
sortOrder: 7
2597+
fieldKey: filename
2598+
label: Filename
2599+
type: STRING
2600+
description: Name of the CSV file to upload for LiveRamp ingestion.
2601+
placeholder: ''
2602+
defaultValue:
2603+
'@template': '{{properties.audience_key}}_PII_{{timestamp}}.csv'
2604+
required: true
2605+
multiple: false
2606+
choices: null
2607+
dynamic: false
2608+
allowNull: false
2609+
- id: kJV4DPq61b2S43XDbRTQrU
2610+
sortOrder: 8
2611+
fieldKey: enable_batching
2612+
label: Batch data
2613+
type: BOOLEAN
2614+
description: >-
2615+
Receive events in a batch payload. This is required for LiveRamp
2616+
audiences ingestion.
2617+
placeholder: ''
2618+
defaultValue: true
2619+
required: true
2620+
multiple: false
2621+
choices: null
2622+
dynamic: false
2623+
allowNull: false
2624+
- id: 6viYF4pX1crxTNpmh2x15z
2625+
sortOrder: 9
2626+
fieldKey: batch_size
2627+
label: Batch Size
2628+
type: NUMBER
2629+
description: >-
2630+
Maximum number of events to include in each batch. Actual batch
2631+
sizes may be lower.
2632+
placeholder: ''
2633+
defaultValue: 50000
2634+
required: false
2635+
multiple: false
2636+
choices: null
2637+
dynamic: false
2638+
allowNull: false
2639+
- id: jkMRBs4cqeNgEZ7uc6z78Z
2640+
name: Audience Entered (S3)
2641+
slug: audienceEnteredS3
2642+
description: >-
2643+
Uploads audience membership data to a file in S3 for LiveRamp
2644+
ingestion.
2645+
platform: CLOUD
2646+
hidden: false
2647+
defaultTrigger: event = "Audience Entered"
2648+
fields:
2649+
- id: 2kt8mogynp539JSjw9wrx5
2650+
sortOrder: 0
2651+
fieldKey: s3_aws_access_key
2652+
label: AWS Access Key ID
2653+
type: STRING
2654+
description: IAM user credentials with write permissions to the S3 bucket.
2655+
placeholder: ''
2656+
required: false
2657+
multiple: false
2658+
choices: null
2659+
dynamic: false
2660+
allowNull: false
2661+
- id: 6PSXsNKiw6zCHgCTnFVraw
2662+
sortOrder: 1
2663+
fieldKey: s3_aws_secret_key
2664+
label: AWS Secret Access Key
2665+
type: PASSWORD
2666+
description: IAM user credentials with write permissions to the S3 bucket.
2667+
placeholder: ''
2668+
required: false
2669+
multiple: false
2670+
choices: null
2671+
dynamic: false
2672+
allowNull: false
2673+
- id: wt3JL914eu5Qpg51A582jC
2674+
sortOrder: 2
2675+
fieldKey: s3_aws_bucket_name
2676+
label: AWS Bucket Name
2677+
type: STRING
2678+
description: Name of the S3 bucket where the files will be uploaded to.
2679+
placeholder: ''
2680+
required: false
2681+
multiple: false
2682+
choices: null
2683+
dynamic: false
2684+
allowNull: false
2685+
- id: w8nCZZmGJaDRcFR6RG4A5P
2686+
sortOrder: 3
2687+
fieldKey: s3_aws_region
2688+
label: AWS Region (S3 only)
2689+
type: STRING
2690+
description: Region where the S3 bucket is hosted.
2691+
placeholder: ''
2692+
required: false
2693+
multiple: false
2694+
choices: null
2695+
dynamic: false
2696+
allowNull: false
2697+
- id: 7zg8jgNHxppkc8P556tdRB
2698+
sortOrder: 4
2699+
fieldKey: audience_key
2700+
label: Audience Key
2701+
type: STRING
2702+
description: Identifies the user within the entered audience.
2703+
placeholder: ''
2704+
defaultValue:
2705+
'@path': $.userId
2706+
required: true
2707+
multiple: false
2708+
choices: null
2709+
dynamic: false
2710+
allowNull: false
2711+
- id: 72xRszDiWD8Aj9Bf5JZykk
2712+
sortOrder: 5
2713+
fieldKey: identifier_data
2714+
label: Identifier Data
2715+
type: OBJECT
2716+
description: Additional data pertaining to the user to be written to the file.
2717+
placeholder: ''
2718+
required: false
2719+
multiple: false
2720+
choices: null
2721+
dynamic: false
2722+
allowNull: false
2723+
- id: 5ijq1RNbCQdad2vBvbN9K4
2724+
sortOrder: 6
2725+
fieldKey: unhashed_identifier_data
2726+
label: Hashable Identifier Data
2727+
type: OBJECT
2728+
description: >-
2729+
Additional data pertaining to the user to be hashed before written
2730+
to the file
2731+
placeholder: ''
2732+
required: false
2733+
multiple: false
2734+
choices: null
2735+
dynamic: false
2736+
allowNull: false
2737+
- id: oyeWNUiGfS1d62S3wPLwSH
2738+
sortOrder: 7
2739+
fieldKey: delimiter
2740+
label: Delimeter
2741+
type: STRING
2742+
description: Character used to separate tokens in the resulting file.
2743+
placeholder: ''
2744+
defaultValue: ','
2745+
required: true
2746+
multiple: false
2747+
choices: null
2748+
dynamic: false
2749+
allowNull: false
2750+
- id: cFhufU2DU3XBR6c5fQCqDz
2751+
sortOrder: 8
2752+
fieldKey: filename
2753+
label: Filename
2754+
type: STRING
2755+
description: Name of the CSV file to upload for LiveRamp ingestion.
2756+
placeholder: ''
2757+
defaultValue:
2758+
'@template': '{{properties.audience_key}}_PII_{{timestamp}}.csv'
2759+
required: true
2760+
multiple: false
2761+
choices: null
2762+
dynamic: false
2763+
allowNull: false
2764+
- id: RXgWTDQUjNZutoiofhJN2
2765+
sortOrder: 9
2766+
fieldKey: enable_batching
2767+
label: Batch data
2768+
type: BOOLEAN
2769+
description: >-
2770+
Receive events in a batch payload. This is required for LiveRamp
2771+
audiences ingestion.
2772+
placeholder: ''
2773+
defaultValue: true
2774+
required: true
2775+
multiple: false
2776+
choices: null
2777+
dynamic: false
2778+
allowNull: false
2779+
- id: eNDisSddFBYqgds9YZMhAw
2780+
sortOrder: 10
2781+
fieldKey: batch_size
2782+
label: Batch Size
2783+
type: NUMBER
2784+
description: >-
2785+
Maximum number of events to include in each batch. Actual batch
2786+
sizes may be lower.
2787+
placeholder: ''
2788+
defaultValue: 170000
2789+
required: false
2790+
multiple: false
2791+
choices: null
2792+
dynamic: false
2793+
allowNull: false
2794+
presets: []
24572795
- id: 64b67be0d0dd66094c162ca7
24582796
display_name: App Fit
24592797
name: App Fit

0 commit comments

Comments
 (0)