Merge pull request #3637 from segmentio/develop

pwseg · web-flow · commit 5660cfb270b8 · 2022-10-11T12:29:35.000-05:00
Release 22.41.1
diff --git a/scripts/checklinks-internal.js b/scripts/checklinks-internal.js
@@ -67,7 +67,7 @@ const checkForDeadLocalUrls = async () => {
     // For ease of checking, replace the localhost domain with the live domain, add those to a new array.
     let broke = []
     deadUrls.forEach(url => {
-      link = url.replace('http://localhost:3000', 'https://engage-ga--segment-docs-private.netlify.app/docs')
+      link = url.replace('http://localhost:3000', 'https://segment.com/docs')
       if (!link.endsWith('/')){
         link = link+'/'
       }
@@ -79,7 +79,7 @@ const checkForDeadLocalUrls = async () => {
     // For those, we want to remove them from the list of dead links, because they aren't dead.
     
     // app-nginx redirects
-    const redirects = ['https://engage-ga--segment-docs-private.netlify.app/docs/guides/usage-and-billing/','https://engage-ga--segment-docs-private.netlify.app/docs/connections/sources/catalog/libraries/website/plugins/', 'https://engage-ga--segment-docs-private.netlify.app/docs/assets/docs.bundle.js/']
+    const redirects = ['https://segment.com/docs/guides/usage-and-billing/','https://segment.com/docs/connections/sources/catalog/libraries/website/plugins/', 'https://segment.com/docs/assets/docs.bundle.js/']
     
     // Redirects generated by Jekyll
     // Pull the redirects json file
@@ -89,7 +89,7 @@ const checkForDeadLocalUrls = async () => {
       if (!key.endsWith('/')){
         key = key+'/'
       }
-      redirects.push('https://engage-ga--segment-docs-private.netlify.app/docs'+key.replace('/docs',''))
+      redirects.push('https://segment.com/docs'+key.replace('/docs',''))
     })
     // Remove the redirect urls from the list of broken URLs
     broke = broke.filter(val => !redirects.includes(val));
diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml
@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
-# destination data last updated 2022-09-19 with Intercom Web (Actions) 
+# destination data last updated 2022-10-07 with Google Sheets 
 items:
   - id: 54521fd525e721e32a72ee8e
     name: AdRoll
@@ -4270,3 +4270,162 @@ items:
           event_metadata:
             '@path': $.properties
         trigger: type = "track"
+  - id: 627ea052118e3cd530d28963
+    display_name: Google Sheets
+    name: Google Sheets
+    slug: actions-google-sheets
+    previous_names:
+      - Google Sheets
+    website: https://www.google.com/sheets/about/
+    status: PRIVATE_BETA
+    logo:
+      url: https://cdn.filepicker.io/api/file/5YkyjmfJSzCy09E3pQVK
+    mark:
+      url: https://cdn.filepicker.io/api/file/pwnFihhWRTqlXE3zND6Q
+    methods:
+      track: true
+      pageview: true
+      identify: true
+      group: true
+      alias: true
+    platforms:
+      browser: true
+      mobile: false
+      server: true
+    components: []
+    browserUnbundlingSupported: false
+    browserUnbundlingPublic: false
+    replay: false
+    settings: []
+    actions:
+      - id: 6cgExzDArNQSaKL9TwFHTP
+        name: Post Sheet
+        slug: postSheet
+        description: Write values to a Google Sheets spreadsheet.
+        platform: CLOUD
+        hidden: false
+        defaultTrigger: event = "updated" or event = "new"
+        fields:
+          - id: 3mnKkoj69PYhnMFArQqgwj
+            sortOrder: 0
+            fieldKey: record_identifier
+            label: Record Identifier
+            type: STRING
+            description: Property which uniquely identifies each row in the spreadsheet.
+            placeholder: ''
+            defaultValue:
+              '@path': $.__segment_id
+            required: true
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: jvr5UEodxuuZGR4stauHqQ
+            sortOrder: 1
+            fieldKey: operation_type
+            label: Operation Type
+            type: HIDDEN
+            description: >-
+              Describes the nature of the operation being performed. Only
+              supported values are 'new' and 'updated'.
+            placeholder: ''
+            defaultValue:
+              '@path': $.event
+            required: true
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: 6biHVg61mv8bv3A395zK2
+            sortOrder: 2
+            fieldKey: spreadsheet_id
+            label: Spreadsheet ID
+            type: STRING
+            description: >-
+              The identifier of the spreadsheet. You can find this value in the
+              URL of the spreadsheet. e.g.
+              https://docs.google.com/spreadsheets/d/{SPREADSHEET_ID}/edit
+            placeholder: ''
+            defaultValue: ''
+            required: true
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: gpRm7bJCWWWFL2byqWa5dm
+            sortOrder: 3
+            fieldKey: spreadsheet_name
+            label: Spreadsheet Name
+            type: STRING
+            description: >-
+              The name of the spreadsheet. You can find this value on the tab at
+              the bottom of the spreadsheet. Please provide a valid name of a
+              sheet that already exists.
+            placeholder: ''
+            defaultValue: Sheet1
+            required: true
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: wgmhCUx43uAymuSeSNdQqq
+            sortOrder: 4
+            fieldKey: data_format
+            label: Data Format
+            type: STRING
+            description: >-
+              The way Google will interpret values. If you select raw, values
+              will not be parsed and will be stored as-is. If you select user
+              entered, values will be parsed as if you typed them into the UI.
+              Numbers will stay as numbers, but strings may be converted to
+              numbers, dates, etc. following the same rules that are applied
+              when entering text into a cell via the Google Sheets UI.
+            placeholder: ''
+            defaultValue: RAW
+            required: true
+            multiple: false
+            choices:
+              - label: Raw
+                value: RAW
+              - label: User Entered
+                value: USER_ENTERED
+            dynamic: false
+            allowNull: false
+          - id: eqRFLYHkkHpmLVPz8oMU2h
+            sortOrder: 5
+            fieldKey: fields
+            label: Fields
+            type: OBJECT
+            description: |2-
+
+                The fields to write to the spreadsheet. 
+
+                On the left-hand side, input the name of the field as it will appear in the Google Sheet. 
+                
+                On the right-hand side, select the field from your data model that maps to the given field in your sheet.
+                   
+                ---
+                    
+                
+            placeholder: ''
+            required: true
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+          - id: arRP9FWVYmYQ9NhKKs5tEJ
+            sortOrder: 6
+            fieldKey: enable_batching
+            label: Batch Data to Google Sheets
+            type: BOOLEAN
+            description: >-
+              Set as true to ensure Segment sends data to Google Sheets in
+              batches. Please do not set to false.
+            placeholder: ''
+            defaultValue: true
+            required: false
+            multiple: false
+            choices: null
+            dynamic: false
+            allowNull: false
+    presets: []
diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml
@@ -263,6 +263,8 @@ sections:
       title: Overview
     - path: /profiles/identity-resolution/identity-resolution-onboarding
       title: Onboarding
+    - path: /profiles/identity-resolution/space-setup
+      title: Space Setup
     - path: /profiles/identity-resolution/use-cases
       title: Use Cases
     - path: /profiles/identity-resolution/externalids
diff --git a/src/api/config-api/fql.md b/src/api/config-api/fql.md
@@ -1,5 +1,7 @@
 ---
 title: Destination Filter Query Language
+redirect_from:
+  - '/docs/config-api/fql'
 ---
 
 {% include content/papi-ga.html %}
diff --git a/src/api/config-api/index.md b/src/api/config-api/index.md
@@ -99,6 +99,6 @@ $ curl \
 
 ## Reference
 
-For an overview of the API's common design patterns and important information about versioning and compatibility, see the [API Design](/docs/config-api/api-design) document.
+For an overview of the API's common design patterns and important information about versioning and compatibility, see the [API Design](/docs/api/config-api/api-design) document.
 
-To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/).
+To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/){:target="_blank"}.
diff --git a/src/connections/destinations/catalog/actions-google-sheets/index.md b/src/connections/destinations/catalog/actions-google-sheets/index.md
@@ -0,0 +1,45 @@
+---
+title: Google Sheets Destination
+hide-boilerplate: true
+hide-dossier: false
+hidden: true
+private: true
+id: 627ea052118e3cd530d28963
+---
+
+The Google Sheets destination allows you to sync your warehouse data to a Google spreadsheet, and automate updates to that spreadsheet as your data changes. This destination allows you to automate the workflow of exporting CSVs from your warehouse.
+
+The Google Sheets destination is intended for use with **Reverse ETL sources only**. 
+
+> info ""
+> The Google Sheets destination is in beta and is in active development. Some functionality may change before it becomes generally available.
+
+## Getting started
+
+### Create a spreadsheet
+1. [Create a new Google spreadsheet](https://docs.google.com/spreadsheets/u/0/create?usp=sheets_home&ths=true){:target="_blank"} in your Google account.
+2. Copy the spreadsheet ID from the spreadsheet URL. The spreadsheet ID is the value after `d/` and before `/edit`. For example, if your URL is `https://docs.google.com/spreadsheets/d/1ejq5-UVP0SWZezRsdggzFxMqOmaJwZh7NkKPkQfi0Bb/edit#gid=0` the ID is `1ejq5-UVP0SWZezRsdggzFxMqOmaJwZh7NkKPkQfi0Bb`. You will need this ID when you configure the destination.
+
+### Connect Google Sheets
+1. Create and configure your Reverse ETL source.
+2. Create a model for the data you plan to sync to Google Sheets.
+3. Navigate to the **Reverse ETL > Destinations** tab and click **Add Destination**. 
+4. Select Google Sheets and click **Next**. Select the source you configured and name the destination.
+5. On the **Settings** tab, authenticate the Google Sheets API using OAuth. Select the email account that owns the spreadsheet you created above. Make sure you enable the `See, edit, create, and delete all your Google Sheets spreadsheets` permission. 
+6. On the **Mappings** tab, click **Add Mapping** and create a Post Sheet mapping. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings).
+7. Enable the destination and configured mappings.
+
+> info ""
+> The Google Sheets destination only supports sending new or updated rows to your spreadsheet. Deleting rows is not supported.
+
+{% include components/actions-fields.html %}
+
+## FAQ
+
+### How does Segment know if a row should be added or updated?
+
+The Record Identifier mapping is used to make a distinction between adding a new row or updating an existing row. If two rows have the same Record Identifier, they are considered to be pertaining the same object and will live in the same row. Please ensure Record Identifier is set to a unique field.
+
+### How do I define the columns in my spreadsheet?
+
+The Fields mapping controls which fields in your model will be written as columns. Input the desired column name(s) on the left, and select the data variable that will populate the value for that column on the right. Please note,at least one Field must be configured to send data to Google Sheets otherwise no columns will be created or synced.
diff --git a/src/connections/destinations/catalog/actions-intercom-cloud/index.md b/src/connections/destinations/catalog/actions-intercom-cloud/index.md
@@ -2,8 +2,6 @@
 title: Intercom Cloud Mode (Actions) Destination
 hide-boilerplate: true
 hide-dossier: false
-hidden: true
-private: true
 id: 62ded0cf5753c743883ca0f3
 versions:
   - name: 'Intercom Web (Actions)'
diff --git a/src/connections/destinations/catalog/actions-intercom-web/index.md b/src/connections/destinations/catalog/actions-intercom-web/index.md
@@ -2,8 +2,6 @@
 title: Intercom Web (Actions) Destination
 hide-boilerplate: true
 hide-dossier: false
-hidden: true
-private: true
 id: 62d9daff84a6bf190da9f592
 hide_action:
   - id: 5W984Qq59XEQnFYKXKHGeZ
diff --git a/src/connections/sources/catalog/libraries/mobile/swift-ios/index.md b/src/connections/sources/catalog/libraries/mobile/swift-ios/index.md
@@ -59,9 +59,6 @@ To get started with the Analytics-Swift mobile library:
     `trackApplicationLifecycleEvents`| The default is set to `true`. <br> This automatically tracks lifecycle events. Set to `false` to stop tracking lifecycle events.
     `trackDeepLinks` | The default is set to `true`. <br> This automatically track deep links. Set to `false` to stop tracking Deep Links.
 
-    > info ""
-    > Configuration options such as IDFA collection and automatic screen tracking are found in Segment's [Plugin Examples repo](https://github.com/segmentio/analytics-example-plugins/tree/main/plugins/swift){:target="_blank"}.
-
 ## Tracking Methods
 Once you've installed the Analytics-Swift library, you can start collecting data through Segment's tracking methods:
 - [Identify](#identify)
diff --git a/src/engage/journeys/journeys-analytics.md b/src/engage/journeys/journeys-analytics.md
@@ -37,12 +37,14 @@ The following table shows the three statistics available for a Journey:
 
 Using the date picker, you can view a Journey's analytics over a specific period of time.
 
-The following table shows descriptions of the timeframes you can select:
-
-| Timeframe       | Description (based on UTC)           | 
-| --------------- | ------------------------------------ |
-| Since yesterday | Yesterday at midnight until now      |
-| Last 7 days     | The past seven days, including today |
-| Last 30 days    | The past 30 days, including today    |
-| Last 90 days    | The past 90 days, including today    |
-| Last 180 days   | The past 180 days, including today   |
+The following table shows descriptions of the time frames you can select:
+
+| Time frame         | Description (based on UTC)                                 |
+| ----------------- | ---------------------------------------------------------- |
+| Today             | Today, beginning at midnight                               |
+| Yesterday         | The day before today                                       |
+| Last 7 days       | The past seven days, not including today                   |
+| Last 30 days      | The past 30 days, not including today                      |
+| Last 90 days      | The past 90 days, not including today                      |
+| Last 180 days     | The past 180 days, not including today                     |
+| Custom date range | The period between two dates, including the selected dates |
diff --git a/src/engage/profiles/csv-upload.md b/src/engage/profiles/csv-upload.md
@@ -10,7 +10,9 @@ You can also [set subscription states](#set-user-subscriptions) for each email a
 
 ## Upload a CSV file
 
-To upload a CSV file, navigate to **Engage > Audiences > Profile explorer** and click **Upload CSV**
+There are two ways you can navigate to the Upload CSV page:
+- Select **Engage > Audiences > Profile explorer** and click **Upload CSV**.
+- Select **Profiles > Profile explorer** and click **Upload CSV**.
 
 ### 1. Download your CSV template
 
@@ -19,7 +21,7 @@ Click **Download Template** to download a CSV template with identifier columns f
 > info ""
 > CSV files can only have a single **email** and **phone** identifier column. Include any additional email addresses or phone numbers for a user profile as a separate row.
 
-Navigate to **Profiles > Profiles Settings** and select the **Identity resolution** tab to view or add identifiers in your Segment workspace.
+Navigate to **Profiles > Profiles settings** and select the **Identity resolution** tab to view or add identifiers in your Segment workspace.
 
 ### 2. Fill out your CSV file
 
@@ -51,7 +53,7 @@ Custom traits display in the Custom Traits tab of a user profile in the Profile
 
 Use the Upload History page to view CSV file uploads in your workspace over the last 30 days.
 
-Navigate to **Engage > Audiences > Profile explorer** and click **Upload History**.
+Navigate to **Engage > Audiences > Profile explorer** or **Profiles > Profile explorer** and select the **CSV upload history** tab.
 
 Select links to view CSV files and any associated [error reports](#error-reports). View the status of the file upload and the custom trait name added to user profiles in the CSV upload.
 
diff --git a/src/engage/user-subscriptions/engage-sources.md b/src/engage/user-subscriptions/engage-sources.md
@@ -0,0 +1,22 @@
+---
+title: Engage Events Source
+plan: engage-foundations
+hidden: true
+---
+
+> info ""
+> The Engage Events Source is in beta.
+
+Use the Engage Events Source to sync Engage subscription states to your downstream warehouses.
+
+## Update downstream subscription states
+
+With Twilio Engage, you can [set and update user subscription states](/docs/engage/user-subscriptions/set-user-subscriptions/) with a [CSV file upload](/docs/engage/profiles/csv-upload/) or, programmatically, [using Segment APIs](/docs/engage/user-subscriptions/set-user-subscriptions/#manage-user-subscriptions-with-segment-apis).
+
+As part of Engage, Segment creates an Engage Events Source that lets you sync these subscription states [to warehouses Destinations](/docs/connections/storage/warehouses/). When a subscription state changes, Segment sends an update to the warehouse. As a result, the subscription states stored in your data warehouse(s) can serve as a single source of truth for managing user consent in other tools that you may have connected to your warehouse.
+
+## Working with Engage Events Sources
+
+Segment generates Engage Sources automatically. If you're using Engage, you can find the Source in your Segment space by navigating to **Connections > Sources**. Segment sets a `Generated` status to Engage Sources in the Statuses column of the **My Sources** table.
+
+From the **My Sources** table, you can select the Engage Source to add a warehouse Destination and configure the Source's settings. If you have more than one Engage space, Segment creates a separate Source for each space.
diff --git a/src/segment-app/iam/labels.md b/src/segment-app/iam/labels.md
@@ -54,7 +54,7 @@ Workspace owners can assign bulk assign labels to sources and Spaces using the "
 
 ##### Where can labels be used?
 
-Once a label has been created and has been assigned to resources within the workspace, workspace owners can use these labels to restrict permissions on user access, restrict which sources can be connected to a Sxspace through a Connection Policy, and organize sources by viewing these labels as columns in the Sources page.
+Once a label has been created and has been assigned to resources within the workspace, workspace owners can use these labels to restrict permissions on user access, restrict which sources can be connected to a space through a Connection Policy, and organize sources by viewing these labels as columns in the Sources page.
 
 ##### Can I delete a label?
 
