Merge branch 'master' into userlist-updates

Author: sanscontext

devguide.md

@@ -33,6 +33,20 @@ Occasionally, a destination will change names. This shouldn't be too difficult t
   2. The programmatic content appears (cmodes, settings, previous names)
   3. The redirect from the old page URL works.
 
+## All about the Catalog script
+
+You run the Catalog update script by running `make catalog` from the docs repo. You, a person who is going to run the script, must first save a Segment token to an `.env` file locally, which is `gitignored` so we don’t check it in to gihub accidentally.
+
+Note: Old ConfigAPI tokens are not compatible with Public API. You'll need a new one if you want to use Public API.
+
+The script takes your token, inserts it into a request header, then contacts the API, downloads all the available metadata for destinations and sources. It then writes them into a series of yml files that the docs build can consume. (You can find these in `/src/_data/catalog/`)
+
+Note: We don’t currently (Feb '21) do this for warehouses (storage dests) because they were originally lumped in with destinations, and didn’t change often enough to be worth writing a script for. We just have a static `warehouses.yml` file instead. With the switch to Public API from ConfigAPI, we should change this.
+
+The script also “calculates” the values for the `connection-modes` table for destinations, but that’s a huge other headache.
+
+It also does some slugification and destination-name normalization, since our handling of dots and dashes hasn't been consistent over time. Finally, it checks to see if there’s a folder for each destination. If it finds a new one, the script makes a folder with a “stub” markdown file for that destination, and then adds a line for it to an "incompleteDocs.txt" file. (It doesn't check to see if it's already listed, just appends to the file.)
+
 
 ## Developer information
 

src/_data/catalog/destination_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# destination categories last updated 2021-02-05 
+# destination categories last updated 2021-02-12 
 items:
 - display_name: Email Marketing
   slug: email-marketing

src/_data/catalog/destinations.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# destination data last updated 2021-02-05 
+# destination data last updated 2021-02-16 
 items:
 - display_name: ActiveCampaign
   slug: activecampaign
@@ -3073,7 +3073,7 @@ items:
     deprecated: false
     required: true
     string_validators:
-      regexp: ''
+      regexp: '^https://'
     description: >-
       The URL to call the Function. It must follow the ` https://{function app
       name}.azurewebsites.net/api/{function name}?code={function key}` pattern.
@@ -4041,6 +4041,64 @@ items:
       server: false
   previous_names:
   - Bugsnag
+- display_name: Button
+  slug: button
+  name: catalog/destinations/button
+  description: >-
+    Button is the mobile commerce technology company that is powering a
+    commerce-driven internet. Our platform powers mobile business growth for the
+    world’s largest brands and publishers, while offering consumers more
+    seamless, enjoyable experiences.
+  hidden: false
+  url: connections/destinations/catalog/button
+  status: PUBLIC_BETA
+  logo:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/a1228b66-79ad-4946-916d-06ca9a4b69c6.svg
+  mark:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/6e23247c-eaa6-4538-a9c1-355b52851d64.svg
+  categories:
+  - Deep Linking
+  - Attribution
+  - Performance Monitoring
+  - Personalization
+  components: []
+  platforms:
+    browser: true
+    server: true
+    mobile: true
+  browserUnbundlingSupported: false
+  browserUnbundlingPublic: false
+  methods:
+    alias: false
+    group: false
+    identify: false
+    page_view: false
+    track: true
+  settings:
+  - name: apiKey
+    display_name: API Key
+    type: STRING
+    deprecated: false
+    required: true
+    string_validators:
+      regexp: '^.{8,}$'
+    description: >-
+      Please contact your Button representative for instructions on finding your
+      Segment-specific API key.
+    settings: []
+  connection_modes:
+    device:
+      web: false
+      mobile: false
+      server: false
+    cloud:
+      web: false
+      mobile: false
+      server: false
+  previous_names:
+  - Button
 - display_name: ByteGain
   slug: bytegain
   name: catalog/destinations/bytegain
@@ -4104,7 +4162,7 @@ items:
 - display_name: Calixa
   slug: calixa
   name: catalog/destinations/calixa
-  description: Manage all of your customers in one place
+  description: The Customer Platform for Startups. Manage all your customers in one place.
   hidden: false
   url: connections/destinations/catalog/calixa
   status: PUBLIC
@@ -4115,9 +4173,10 @@ items:
     url: >-
       https://public-segment-devcenter-production.s3.amazonaws.com/67ec1978-b686-4ce1-b395-ee00a3f6d271.svg
   categories:
+  - Analytics
   - CRM
   - Raw Data
-  - Analytics
+  - Customer Success
   components:
   - type: CLOUD
   platforms:
@@ -4842,7 +4901,8 @@ items:
       select_options:
       - ' '
       - in.
-      - sg.
+      - sg1.
+      - us1.
     description: '**Server Only**: Your dedicated Clevertap region.'
     settings: []
   connection_modes:
@@ -10087,7 +10147,7 @@ items:
     deprecated: false
     required: true
     string_validators:
-      regexp: ''
+      regexp: '^https://'
     description: The URL to call the Google Cloud Function.
     settings: []
   connection_modes:
@@ -13173,7 +13233,7 @@ items:
   url: connections/destinations/catalog/mailjet
   status: PUBLIC
   logo:
-    url: 'https://cdn.filepicker.io/api/file/rfFhI7d4T16tGWkVNgvK'
+    url: 'https://cdn.filepicker.io/api/file/bAJdmpGTKeodtKeKaysD'
   mark:
     url: 'https://cdn.filepicker.io/api/file/uMFWhqRT0aEYRRTenXRp'
   categories:
@@ -13440,6 +13500,17 @@ items:
       required: false
       description: Map your Segment properties to the Marketo Activity Fields
       settings:
+      - name: segmentProperty
+        display_name: Segment Property Name
+        type: STRING
+        deprecated: false
+        required: true
+        string_validators:
+          regexp: ''
+        description: >-
+          Enter the Segment Property Name. This is case sensitive so make sure
+          the name matches exactly how you are passing it in your .track() call.
+        settings: []
       - name: marketoAttributeName
         display_name: Marketo Field Name
         type: STRING
@@ -13471,17 +13542,6 @@ items:
         required: false
         description: Mark this property as the Primary field in Marketo.
         settings: []
-      - name: segmentProperty
-        display_name: Segment Property Name
-        type: STRING
-        deprecated: false
-        required: true
-        string_validators:
-          regexp: ''
-        description: >-
-          Enter the Segment Property Name. This is case sensitive so make sure
-          the name matches exactly how you are passing it in your .track() call.
-        settings: []
     - name: event
       display_name: Segment Event Name
       type: STRING

src/_data/catalog/source_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# source cateogries last updated 2021-02-05 
+# source cateogries last updated 2021-02-12 
 items:
 - display_name: Server
   slug: server

src/_data/catalog/sources.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# sources last updated 2021-02-05 
+# sources last updated 2021-02-12 
 items:
 - display_name: .NET
   slug: net

src/_includes/content/functions/runtime.md

@@ -16,7 +16,6 @@ The following dependencies are installed in the function environment by default.
 - [`@google-cloud/pubsub v2.6.0`](https://www.npmjs.com/package/@google-cloud/pubsub) exposed as `google.cloud.pubsub`
 - [`@google-cloud/storage v5.3.0`](https://www.npmjs.com/package/@google-cloud/storage) exposed as `google.cloud.storage`
 - [`jsonwebtoken v8.5.1`](https://www.npmjs.com/package/jsonwebtoken) exposed as `jsonwebtoken`
-- [`kafka-node v5.0.0`](https://www.npmjs.com/package/kafka-node) exposed as `kafka-node`
 - [`lodash v4.17.15`](https://www.npmjs.com/package/lodash) exposed as `_`
 - [`node-fetch v2.6.0`](https://www.npmjs.com/package/node-fetch) exposed as `fetch`
 - [`oauth v0.9.15`](https://www.npmjs.com/package/oauth) exposed as `OAuth`

src/connections/destinations/catalog/button/index.md

@@ -0,0 +1,117 @@
+---
+title: Button Destination
+rewrite: true
+---
+[Button](https://usebutton.com?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is the mobile commerce technology company that is powering a commerce-driven internet. The Button platform powers mobile business growth for the world’s largest brands and publishers, while offering consumers more seamless, enjoyable experiences.
+
+This destination is maintained by Button. For any issues with the destination, [contact the Button Support team](mailto:[email protected]).
+
+## Getting Started
+
+{% include content/connection-modes.md %}
+
+> info ""
+> Contact your Button representative for your Button API Key.
+
+1. From the Destinations catalog page in the Segment App, click **Add Destination**.
+2. Search for "Button" in the Destinations Catalog, and select the Button destination.
+3. Choose which Source should send data to the Button destination.
+4. Enter the "API Key" in the Button destination settings in Segment.
+
+## Track
+If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
+
+```js
+analytics.track('Deep Link Opened')
+```
+
+Segment sends Track calls to Button as a `track` event.
+
+### Deep links
+To track deep links from your app or website, use Segment's [Deep Link Opened](https://segment.com/docs/connections/spec/mobile/#deep-link-opened) and [Application Opened](https://segment.com/docs/connections/spec/mobile/#application-opened) events.
+
+Make sure you pass the referring URL. An example would look like:
+
+```js
+analytics.track('Application Opened' { someProperty: true }, {
+  userId: '1234567890',
+  properties: {
+    url: 'brand-app://?btn_ref=srctok-XXX'
+  }
+  ...
+})
+```
+
+> success ""
+> **Tip!** Make sure you record any different names for `Deep Link Opened` Track events across your sources so you know which are sent where.
+
+### Installs
+To track mobile app installs, use Segment's [Application Installed](https://segment.com/docs/connections/spec/mobile/#application-installed) event.
+
+Capture the referring URL when possible. An example would look like:
+
+```js
+analytics.track('Application Installed' { someProperty: true }, {
+  userId: '1234567890',
+  properties: {
+    url: 'https://brand-homepage.com?btn_ref=srctok-XXX'
+  },
+  context {
+    app: { version: '4.15.0' },
+    device: {
+      adTrackingEnabled: false,
+      advertisingId: 'XXXXXXXX-YYYY-ZZZZ-1111-222222222222'
+    },
+    ip: '127.0.0.1',
+    locale: 'en-US',
+    os: {
+      name: 'iOS',
+      version: '14.2'
+    }
+  }
+  ...
+})
+```
+> success ""
+> **Tip!** Make sure you record any different names for `Application Installed` Track events across your sources so you know which are sent where.
+
+### Orders
+To track `order` events from your app or website, use Segment's [Order Completed](https://segment.com/docs/connections/spec/ecommerce/v2/#order-completed) event.
+
+An example call would look like:
+
+```js
+analytics.track('Order Completed' { someProperty: true }, {
+  userId: '1234567890',
+  properties: {
+    subtotal: 7500,
+    products: [
+      {
+         sku: 'sku-123',
+         description: 'T-Shirt',
+         size: 'L',
+         price: 2500,
+         quantity: 1,
+         category: 'Clothing',
+      },
+      {
+         sku: 'sku-456',
+         description: 'Joggers',
+         size: 'M',
+         price: 5000,
+         quantity: 1,
+         category: 'Clothing',
+      }
+    ]
+  }
+})
+```
+> success ""
+> **Tip!** Make sure you record any different names for `Order Completed` Track events across your sources so you know which are sent where.
+
+## Setting up a Destination Filter
+
+If you are a Business Tier customer, you can set up a [Destination Filter](https://segment.com/docs/connections/destinations/destination-filters/) to only send your `Deep link` and `Order` events to Button.
+
+
+Read [Button's Destination Filter documentation](https://developer.usebutton.com/docs/segment-integration-guide) to learn more.

src/connections/destinations/catalog/facebook-conversions-api/index.md

@@ -2,4 +2,7 @@
 title: 'Facebook Conversions API Destination'
 hidden: true
 beta: true
----
+---
+
+<!-- LR: 2/16/2021: Redirects to /docs/connections/destinations/catalog/facebook-pixel-server-side
+because while this destination's display name has changed, the slug is still the old name and the docs build needs to match on slug to find it in `destinations.yml` -->