Skip to content

Commit c8f2b42

Browse files
stayseesongstayseesong
authored
Merge pull request #3755 from segmentio/kiara/add-linkedin-docs
Scaffold docs for LinkedIn Audiences
2 parents e1b0b9e + 56f3fc9 commit c8f2b42

File tree

4 files changed

+235
-2
lines changed

4 files changed

+235
-2
lines changed

‎src/_data/catalog/destinations_private.yml

Lines changed: 169 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 2022-10-27 with HubSpot Web (Actions)
2+
# destination data last updated 2022-11-03 with LinkedIn Audiences
33
items:
44
- id: 54521fd525e721e32a72ee8e
55
name: AdRoll
@@ -5377,3 +5377,171 @@ items:
53775377
else:
53785378
'@path': $.traits.address.postal_code
53795379
trigger: type = "identify"
5380+
- id: 62f435d1d311567bd5bf0e8d
5381+
display_name: LinkedIn Audiences
5382+
name: LinkedIn Audiences
5383+
slug: actions-linkedin-audiences
5384+
previous_names:
5385+
- Linkedin Audiences
5386+
- LinkedIn Audiences
5387+
website: https://business.linkedin.com/marketing-solutions/ads
5388+
status: PRIVATE_BETA
5389+
logo:
5390+
url: https://cdn.filepicker.io/api/file/ELNG7CyCSu2zCJFs0mzg
5391+
mark:
5392+
url: https://cdn.filepicker.io/api/file/gF6gY5PKTMSIrGjH0bCi
5393+
methods:
5394+
track: true
5395+
pageview: false
5396+
identify: false
5397+
group: false
5398+
alias: false
5399+
platforms:
5400+
browser: true
5401+
mobile: false
5402+
server: true
5403+
components: []
5404+
browserUnbundlingSupported: false
5405+
browserUnbundlingPublic: false
5406+
replay: false
5407+
settings:
5408+
- name: ad_account_id
5409+
type: string
5410+
defaultValue: ''
5411+
description: >-
5412+
The id of the LinkedIn Ad Account where batches should be synced. You
5413+
can find your Ad Account id in your [LinkedIn Campaign
5414+
Manager](https://www.linkedin.com/campaignmanager/login).
5415+
required: true
5416+
label: LinkedIn Ad Account Id
5417+
- name: send_email
5418+
type: boolean
5419+
defaultValue: true
5420+
description: >-
5421+
Whether to send `email` to LinkedIn. This setting applies to all
5422+
mappings you create in this destination instance.
5423+
required: true
5424+
label: Send Email
5425+
- name: send_google_advertising_id
5426+
type: boolean
5427+
defaultValue: true
5428+
description: >-
5429+
Whether to send Google Advertising ID to LinkedIn. This setting
5430+
applies to all mappings you create in this destination instance.
5431+
required: true
5432+
label: Send Google Advertising ID
5433+
actions:
5434+
- id: i9V1H1emvbxxNuwB5bdALx
5435+
name: Sync To LinkedIn DMP Segment
5436+
slug: updateAudience
5437+
description: Syncs contacts from a Personas Audience to a LinkedIn DMP Segment.
5438+
platform: CLOUD
5439+
hidden: false
5440+
defaultTrigger: event = "Audience Entered" or event = "Audience Exited"
5441+
fields:
5442+
- id: jcVeFsehCiYtsfdp8nfGCS
5443+
sortOrder: 0
5444+
fieldKey: dmp_segment_name
5445+
label: DMP Segment Display Name
5446+
type: STRING
5447+
description: >-
5448+
The display name of the LinkedIn DMP Segment. This field is set
5449+
only when Segment creates a new audience. Updating this field
5450+
after Segment has created an audience will not update the audience
5451+
name in LinkedIn.
5452+
placeholder: ''
5453+
defaultValue:
5454+
'@path': $.properties.audience_key
5455+
required: false
5456+
multiple: false
5457+
choices: null
5458+
dynamic: false
5459+
allowNull: false
5460+
- id: 4zPS53458R7dERvi4XVKzb
5461+
sortOrder: 1
5462+
fieldKey: enable_batching
5463+
label: Enable Batching
5464+
type: BOOLEAN
5465+
description: Enable batching of requests to the LinkedIn DMP Segment.
5466+
placeholder: ''
5467+
defaultValue: true
5468+
required: false
5469+
multiple: false
5470+
choices: null
5471+
dynamic: false
5472+
allowNull: false
5473+
- id: 9hFKbbzuGFXd265RKTb3bU
5474+
sortOrder: 2
5475+
fieldKey: email
5476+
label: User Email
5477+
type: HIDDEN
5478+
description: The user's email address to send to LinkedIn.
5479+
placeholder: ''
5480+
defaultValue:
5481+
'@path': $.context.traits.email
5482+
required: false
5483+
multiple: false
5484+
choices: null
5485+
dynamic: false
5486+
allowNull: false
5487+
- id: be2ANvsfsg2yYPybSUMbEA
5488+
sortOrder: 3
5489+
fieldKey: google_advertising_id
5490+
label: User Google Advertising ID
5491+
type: HIDDEN
5492+
description: The user's Google Advertising ID to send to LinkedIn.
5493+
placeholder: ''
5494+
defaultValue:
5495+
'@path': $.context.device.advertisingId
5496+
required: false
5497+
multiple: false
5498+
choices: null
5499+
dynamic: false
5500+
allowNull: false
5501+
- id: 9xFTPFKJWPAnP3J3LP6ARi
5502+
sortOrder: 4
5503+
fieldKey: source_segment_id
5504+
label: LinkedIn Source Segment ID
5505+
type: HIDDEN
5506+
description: >-
5507+
A Segment-specific key associated with the LinkedIn DMP Segment.
5508+
This is the lookup key Segment uses to fetch the DMP Segment from
5509+
LinkedIn's API.
5510+
placeholder: ''
5511+
defaultValue:
5512+
'@path': $.properties.audience_key
5513+
required: false
5514+
multiple: false
5515+
choices: null
5516+
dynamic: false
5517+
allowNull: false
5518+
- id: sSgTrU1TZDc8EeKVJpW9Gq
5519+
sortOrder: 5
5520+
fieldKey: personas_audience_key
5521+
label: Segment Engage Audience Key
5522+
type: STRING
5523+
description: >-
5524+
The `audience_key` of the Engage audience you want to sync to
5525+
LinkedIn. This value must be a hard-coded string variable, e.g.
5526+
`personas_test_audience`, in order for batching to work properly.
5527+
placeholder: ''
5528+
required: true
5529+
multiple: false
5530+
choices: null
5531+
dynamic: false
5532+
allowNull: false
5533+
- id: gx9rqynZ3C2fLt6FndV2RT
5534+
sortOrder: 6
5535+
fieldKey: event_name
5536+
label: Event Name
5537+
type: HIDDEN
5538+
description: The name of the current Segment event.
5539+
placeholder: ''
5540+
defaultValue:
5541+
'@path': $.event
5542+
required: false
5543+
multiple: false
5544+
choices: null
5545+
dynamic: false
5546+
allowNull: false
5547+
presets: []

‎src/_includes/components/actions-fields.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
<div class="fa fa-info-circle"></div>
8989
<div class="content">
9090
<p class="header">Mapping limits per destination</p>
91-
<p>Individual destination instances have support a maximum of 50 mappings.</p>
91+
<p>Individual destination instances support a maximum of 50 mappings.</p>
9292
</div>
9393
</div>
9494

‎src/connections/destinations/catalog/actions-linkedin-audiences/images/image1.png

98.5 KB
Loading

‎src/connections/destinations/catalog/actions-linkedin-audiences/index.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: LinkedIn Audiences Destination
3+
hide-personas-partial: true
4+
hide-boilerplate: true
5+
hide-dossier: false
6+
hidden: true
7+
private: true
8+
id: 62f435d1d311567bd5bf0e8d
9+
---
10+
11+
LinkedIn Audiences enables advertisers to send Segment Engage Audiences to LinkedIn as Matched Audiences using [LinkedIn's API](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/matched-audiences/matched-audiences){:target="_blank"}.
12+
13+
By using Segment's Engage Audiences with LinkedIn, you can increase traffic and drive conversions with hyper-relevant ads that promote product discovery.
14+
15+
> info ""
16+
> The LinkedIn Audiences destination is in beta and is in active development. Some functionality may change before it becomes generally available.
17+
18+
## Getting Started
19+
20+
Before connecting to the LinkedIn Audiences destination, you must have a [LinkedIn Campaign Manager](https://www.linkedin.com/campaignmanager){:target="_blank"} account and an Ad Account ID. In addition, the user authenticating with LinkedIn must have one of the following LinkedIn ad account roles: `ACCOUNT_BILLING_ADMIN`, `ACCOUNT_MANAGER`, `CAMPAIGN_MANAGER`, or `CREATIVE_MANAGER`.
21+
22+
To add the LinkedIn Audiences destination:
23+
24+
1. From the Segment web app, navigate to **Engage > Audiences**. Ensure you are in the Engage space you plan to use with LinkedIn Audiences. Either choose an existing Engage Audience or create a new one. This is the Audience you plan to send to LinkedIn.
25+
26+
2. Within the Audience, click **Settings** and copy the Audience Key. You'll need this key later.
27+
28+
3. Navigate to **Engage > Engage Settings** and click **Destinations**. Please ensure you are still in the correct Engage space.
29+
30+
4. Search for “LinkedIn Audiences” and select the destination.
31+
32+
5. Click **Configure LinkedIn Audiences**.
33+
34+
6. On the Select Source screen, your Engage space should already be selected as the source. Click **Confirm Source**.
35+
36+
7. On the Destination **Settings** tab, name your destination and authenticate with LinkedIn using OAuth.
37+
38+
8. Once authenticated, input your LinkedIn Ad Account ID from your [LinkedIn Campaign Manager](https://www.linkedin.com/campaignmanager){:target="_blank"} account. Toggle “Enable Destination” on and click **Save Changes**.
39+
40+
9. Navigate to the **Mappings** tab, click **New Mapping**, and select **Sync To LinkedIn DMP Segment**.
41+
42+
10. Under Select mappings, input the Audience Key you copied in Step 2 as the “Segment Engage Audience Key.” Do not change any other defaults. Click **Save** and toggle to enable the mapping.
43+
* **Note:** The Audience Key must be manually entered to ensure users in the Engage Audience are sent to the correct DMP Segment in LinkedIn. For every Engage Audience you want to send to your LinkedIn Ads Account, a separate **Sync To LinkedIn DMP Segment** mapping must be created. You can create up to 50 mappings within an instance of the LinkedIn Audiences destination.
44+
45+
11. Navigate back to **Engage > Audiences** and click on the Audience from Step 1.
46+
12. Click **Add Destinations** and select the LinkedIn Audiences destination you just created. In the settings that appear in the side panel, toggle the **Send Track** option on and disable **Send Identify**. Click **Save Settings**.
47+
48+
![engage audience destination settings](images/image1.png)
49+
50+
The setup is complete and the Audience will start syncing to LinkedIn. Segment automatically creates a new DMP Segment in LinkedIn and will add or remove users accordingly. The Audience appears in your [LinkedIn Campaign Manager](https://www.linkedin.com/campaignmanager){:target="_blank"}, account under **Plan > Audiences > Matched**.
51+
52+
To sync additional Audiences from your Engage space, create a separate mapping in the LinkedIn Audiences destination. Navigate to **Connections > Destinations**, search and select the LinkedIn Audiences destination, and follow Steps 9-11 above.
53+
54+
{% include components/actions-fields.html settings="true"%}
55+
56+
## Troubleshooting
57+
58+
### Access & Refresh Tokens
59+
LinkedIn's OAuth access tokens have a time to live (TTL) of 60 days; refresh tokens have a TTL of one year. Segment automatically updates your access token as long as your refresh token is valid. You won't see any errors or interruptions in data delivery if your access token expires while your refresh token is valid.
60+
61+
Upon expiry or revocation of a refresh token, you'll see `Refresh Token Expired` errors in the Delivery Issues section of your LinkedIn Audiences destination **Event Delivery** tab.
62+
63+
Unknown errors from LinkedIn related to OAuth appear as `Oauth Refresh Failed`.
64+
65+
To remedy either error, please navigate to the **Settings** tab of your LinkedIn Audiences destination and select **Reauthorize** under the Connection heading and complete the OAuth flow.

0 commit comments

Comments
 (0)