Kopiowanie danych z Square przy użyciu Azure Data Factory lub Synapse Analytics

DOTYCZY: Azure Data Factory Azure Synapse Analytics

Wskazówka

Data Factory w usłudze Microsoft Fabric jest następną generacją Azure Data Factory z prostszą architekturą, wbudowaną sztuczną inteligencją i nowymi funkcjami. Jeśli dopiero zaczynasz integrować dane, zacznij od Fabric Data Factory. Istniejące obciążenia ADF można zaktualizować do Fabric, aby uzyskać dostęp do nowych możliwości w zakresie nauki o danych, analiz w czasie rzeczywistym oraz raportowania.

• Rozpocznij bezpłatny okres próbny Fabric.
• Ugraduj z Azure Data Factory do usługi Data Factory w Microsoft Fabric

W tym artykule opisano, jak używać aktywności kopiowania w potoku Azure Data Factory lub Synapse Analytics, aby skopiować dane z Square. Opiera się na przeglądzie aktywności kopiowania, który przedstawia ogólny przegląd działania kopiowania.

Ważne

Łącznik Square w wersji 1.0 jest na etapie usuwania. Zaleca się uaktualnienie łącznika Square z wersji 1.0 do 2.0.

Obsługiwane możliwości

Ten Square konektor jest obsługiwany dla następujących funkcjonalności:

Obsługiwane możliwości	środowisko IR
Kopiuj działanie (źródło/-)	(1) (2)
Działanie Lookup	(1) (2)

(1) Środowisko uruchomieniowe Azure (2) Środowisko uruchomieniowe lokalnie hostowane

Aby uzyskać listę magazynów danych obsługiwanych jako źródła/ujścia, zobacz tabelę Obsługiwane magazyny danych.

Usługa udostępnia wbudowany sterownik umożliwiający łączność, dlatego nie trzeba ręcznie instalować żadnego sterownika przy użyciu tego łącznika.

Złącze obsługuje wersje Windows w tym artykule.

Wymagania wstępne

Jeśli magazyn danych znajduje się wewnątrz sieci lokalnej, sieci wirtualnej Azure lub chmury prywatnej Amazon Virtual, musisz skonfigurować self-hosted Integration Runtime aby nawiązać z nim połączenie.

Jeśli magazyn danych jest zarządzaną usługą danych w chmurze, możesz użyć Azure Integration Runtime. Jeśli dostęp jest ograniczony do adresów IP zatwierdzonych w regułach zapory, możesz dodać adresy IP Azure Integration Runtime do listy dozwolonych.

Możesz również użyć funkcji zarządzanego środowiska wykonawczego zintegrowanej sieci wirtualnej w Azure Data Factory, aby uzyskać dostęp do sieci lokalnej bez instalowania i konfigurowania lokalnego środowiska Integration Runtime.

Aby uzyskać więcej informacji na temat mechanizmów zabezpieczeń sieci i opcji obsługiwanych przez usługę Data Factory, zobacz Strategie dostępu do danych.

Uwaga

Wersja 2.0 jest obsługiwana w przypadku własnego środowiska Integration Runtime w wersji 5.56.0.0 lub nowszej.

Wprowadzenie

Aby wykonać działanie kopiowania za pomocą potoku, możesz użyć jednego z następujących narzędzi lub zestawów SDK:

• Narzędzie do kopiowania danych
• Portal Azure
• .NET SDK
• Python SDK
• Azure PowerShell
• API REST
• Szablon menedżera zasobów Azure

Tworzenie połączonej usługi z platformą Square przy użyciu interfejsu użytkownika

Wykonaj poniższe kroki, aby utworzyć połączoną usługę z platformą Square w interfejsie użytkownika portalu Azure.

1. Przejdź do karty Zarządzanie w obszarze roboczym Azure Data Factory lub Synapse i wybierz pozycję Połączone usługi, a następnie kliknij pozycję Nowy:

   Azure Data Factory

   

   Azure Synapse

   

2. Wyszukaj Square i wybierz konektor Square.

   

3. Skonfiguruj szczegóły usługi, przetestuj połączenie i utwórz nową połączoną usługę.

   

Szczegóły konfiguracji łącznika

Poniższe sekcje zawierają szczegółowe informacje o właściwościach używanych do definiowania jednostek usługi Data Factory specyficznych dla łącznika Square.

Właściwości połączonej usługi

Łącznik Square obsługuje teraz wersję 2.0. Zapoznaj się z tą sekcją , aby uaktualnić wersję łącznika Square z wersji 1.0. Aby uzyskać informacje szczegółowe dotyczące nieruchomości, zobacz odpowiednie sekcje.

• Wersja 2.0
• w wersji 1.0

Wersja 2.0

Połączona usługa Square obsługuje następujące właściwości w przypadku zastosowania wersji 2.0:

Właściwości	Opis	Wymagane
typ	Właściwość type musi być ustawiona na: Square	Tak
wersja	Wersja, którą określisz. Wartość to 2.0.	Tak
gospodarz	Adres URL wystąpienia Square. (to jest: mystore.mysquare.com)	Tak
clientId	Identyfikator klienta skojarzony z aplikacją Square.	Tak
clientSecret	Tajny klucz klienta związany z aplikacją Square. Oznacz to pole jako SecureString, aby przechowywać je bezpiecznie lub odwołaj się do sekretu przechowywanego w Azure Key Vault.	Tak
accessToken	Token dostępu uzyskany od Square. Udziela ograniczonego dostępu do konta Square, prosząc uwierzytelnionego użytkownika o jawne uprawnienia. Tokeny dostępu OAuth wygasają 30 dni po wystawieniu, ale tokeny odświeżania nie wygasają. Tokeny dostępu można odświeżać za pomocą tokenu odświeżania. Oznacz to pole jako SecureString, aby przechowywać je bezpiecznie lub odwołaj się do sekretu przechowywanego w Azure Key Vault. Aby uzyskać więcej informacji na temat typów tokenów dostępu, zobacz Access token types (Typy tokenów dostępu).	Tak
refresh-token	Token odświeżania uzyskany z Square. Służy do uzyskiwania nowych tokenów dostępu po wygaśnięciu bieżącego tokenu. Oznacz to pole jako SecureString, aby przechowywać je bezpiecznie lub odwołać się do sekretu przechowywanego w Azure Key Vault.	Nie.
connectVia	Integration Runtime używany do nawiązania połączenia z magazynem danych. Jeśli nie zostanie to określone, zostanie użyta Azure Integration Runtime domyślna. Możesz użyć własnego środowiska Integration Runtime, a jego wersja powinna mieć wartość 5.56.0.0 lub nowszą.	Nie.

Przykład:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "version": "2.0",
        "typeProperties": {
            "host": "<e.g. mystore.mysquare.com>", 
            "clientId": "<client ID>", 
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            }, 
            "accessToken": {
                "type": "SecureString",
                "value": "<access token>"
            }, 
            "refreshToken": {
                "type": "SecureString",
                "value": "<refresh token>"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Wersja 1.0

Połączona usługa Square obsługuje następujące właściwości w przypadku zastosowania wersji 1.0:

Właściwości	Opis	Wymagane
typ	Właściwość type musi być ustawiona na: Square	Tak
właściwości połączenia	Grupa właściwości definiujących sposób nawiązywania połączenia z kwadratem.	Tak
W obszarze connectionProperties:
gospodarz	Adres URL wystąpienia Square. (to jest: mystore.mysquare.com)	Tak
clientId	Identyfikator klienta skojarzony z aplikacją Square.	Tak
clientSecret	Tajny klucz klienta związany z aplikacją Square. Oznacz to pole jako SecureString, aby przechowywać je bezpiecznie lub odwołaj się do sekretu przechowywanego w Azure Key Vault.	Tak
accessToken	Token dostępu uzyskany od Square. Udziela ograniczonego dostępu do konta Square, prosząc uwierzytelnionego użytkownika o jawne uprawnienia. Tokeny dostępu OAuth wygasają 30 dni po wystawieniu, ale tokeny odświeżania nie wygasają. Tokeny dostępu można odświeżać za pomocą tokenu odświeżania. Oznacz to pole jako SecureString, aby przechowywać je bezpiecznie lub odwołaj się do sekretu przechowywanego w Azure Key Vault. Aby uzyskać więcej informacji na temat typów tokenów dostępu, zobacz Access token types (Typy tokenów dostępu).	Tak
refresh-token	Token odświeżania uzyskany z Square. Służy do uzyskiwania nowych tokenów dostępu po wygaśnięciu bieżącego tokenu. Oznacz to pole jako SecureString, aby przechowywać je bezpiecznie lub odwołać się do sekretu przechowywanego w Azure Key Vault.	Nie.
useEncryptedEndpoints	Określa, czy punkty końcowe źródła danych są szyfrowane przy użyciu protokołu HTTPS. Wartość domyślna to true.	Nie.
używajWeryfikacjiHosta	Określa, czy nazwa hosta w certyfikacie serwera ma być zgodna z nazwą hosta serwera podczas nawiązywania połączenia za pośrednictwem protokołu TLS. Wartość domyślna to true.	Nie.
usePeerVerification	Określa, czy należy zweryfikować tożsamość serwera podczas nawiązywania połączenia za pośrednictwem protokołu TLS. Wartość domyślna to true.	Nie.
connectVia	Integration Runtime używany do nawiązania połączenia z magazynem danych. Jeśli nie zostanie to określone, zostanie użyta Azure Integration Runtime domyślna.	Nie.

Przykład:

{
    "name": "SquareLinkedService",
    "properties": {
        "type": "Square",
        "typeProperties": {
            "connectionProperties": {
                "host": "<e.g. mystore.mysquare.com>", 
                "clientId": "<client ID>", 
                "clientSecret": {
                    "type": "SecureString",
                    "value": "<clientSecret>"
                }, 
                "accessToken": {
                    "type": "SecureString",
                    "value": "<access token>"
                }, 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true 
            }
        }
    }
}

Typy tokenów dostępu

Square obsługuje dwa typy tokenu dostępu: osobisty i OAuth.

• Osobiste tokeny dostępu są używane do uzyskiwania nieograniczonego dostępu interfejsu API Connect do zasobów na własnym koncie Square.

• Tokeny dostępu OAuth są używane do uzyskiwania uwierzytelnionego dostępu o ograniczonym zakresie do interfejsu Connect API dowolnego konta Square. Użyj ich, gdy aplikacja uzyskuje dostęp do zasobów na innych kontach Square w imieniu właścicieli kont. Tokeny dostępu OAuth mogą być również używane do uzyskiwania dostępu do zasobów na własnym koncie Square.

  Ważne

  Aby wykonać testowe połączenie w połączonej usłudze, MERCHANT_PROFILE_READ konieczne jest uzyskanie tokenu dostępu w zakresie OAuth. Aby uzyskać uprawnienia do dostępu do innych tabel, zobacz Square OAuth Permissions Reference.

Uwierzytelnianie za pośrednictwem osobistego tokenu dostępu wymaga tylko accessToken, podczas gdy uwierzytelnianie za pomocą OAuth wymaga accessToken i refreshToken. Dowiedz się, jak pobrać token dostępu z tego miejsca.

Właściwości zestawu danych

Pełna lista sekcji i właściwości dostępnych do definiowania zestawów danych znajduje się w artykule dotyczącym zestawów danych. Ta sekcja zawiera listę właściwości obsługiwanych przez zestaw danych Square.

Aby skopiować dane z kwadratu, ustaw właściwość type zestawu danych na SquareObject. Obsługiwane są następujące właściwości:

Właściwości	Opis	Wymagane
typ	Właściwość type zestawu danych musi być ustawiona na: SquareObject	Tak
tableName	Nazwa tabeli.	Tak dla wersji 2.0. Nie dla wersji 1.0 (jeśli określono "zapytanie" w źródle działania)

Przykład

{
    "name": "SquareDataset",
    "properties": {
        "type": "SquareObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Square linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Właściwości aktywności kopiowania

Aby uzyskać pełną listę sekcji i właściwości dostępnych do definiowania działań, zobacz artykuł Pipelines (Potoki ). Ta sekcja zawiera listę właściwości obsługiwanych przez źródło Square.

Kwadrat jako źródło

Aby skopiować dane z kwadratu, ustaw typ źródła w działaniu kopiowania na SquareSource. Następujące właściwości są obsługiwane w sekcji źródło działania kopiowania:

Właściwości	Opis	Wymagane
typ	Właściwość type źródła działania kopiowania musi być ustawiona na: SquareSource	Tak
kwerenda	Użyj niestandardowego zapytania SQL, aby odczytać dane. Na przykład: "SELECT * FROM Business".	Nie (jeśli określono "tableName" w zestawie danych)

Uwaga

query nie jest obsługiwany w wersji 2.0.

Przykład:

"activities":[
    {
        "name": "CopyFromSquare",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Square input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SquareSource",
                "query": "SELECT * FROM Business"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Mapowanie typu danych dla kwadratu

Podczas kopiowania danych z Square stosowane są następujące odwzorowania z typów danych Square na wewnętrzne typy danych używane przez usługę. Aby dowiedzieć się, jak działanie kopiowania mapuje schemat źródłowy i typ danych na docelowy, zobacz Mapowanie schematu i typu danych.

Typ danych kwadratowych	Typ danych usługi tymczasowej (wersja 2.0)	Typ danych usługi tymczasowej (wersja 1.0)
Sznurek	Sznurek	Sznurek
Integer	Int32	Int32
Long	Int64	Int64
logiczny	logiczny	logiczny
Date	Sznurek	Niewspierane.
Sygnatura czasowa	Sznurek	Niewspierane.
Znacznik czasu z przesunięciem	Sznurek	Niewspierane.
Czas trwania (pełny)	Sznurek	Sznurek
Czas trwania (tylko godziny)	Sznurek	Sznurek
Pieniądze	Int64	Int64

Właściwości czynności wyszukiwania

Aby dowiedzieć się więcej o właściwościach, sprawdź działanie wyszukiwania.

Złącze kwadratowe: cykl życia i aktualizacja

W poniższej tabeli przedstawiono etap wydania i dzienniki zmian dla różnych wersji łącznika Square:

wersja	Etap wydania	Dziennik zmian
Wersja 1.0	Removed	Nie dotyczy.
Wersja 2.0	Ogólna dostępność	• Wersja własnego środowiska Integration Runtime powinna mieć wartość 5.56.0.0 lub nowszą. • Data, znacznik czasu i znacznik czasu z przesunięciem są odczytywane jako typ danych łańcuch. • useEncryptedEndpoints, useHostVerification, usePeerVerification nie są obsługiwane w połączonej usłudze. • query nie jest obsługiwana.

Uaktualnianie łącznika Square z wersji 1.0 do wersji 2.0

1. Na stronie Edytowanie połączonej usługi wybierz wersję 2.0. Aby uzyskać więcej informacji, zobacz właściwości połączonej usługi w wersji 2.0.

2. Mapowanie typu danych dla połączonej usługi Square w wersji 2.0 różni się od tego dla wersji 1.0. Aby dowiedzieć się więcej na temat najnowszego mapowania typów danych, zobacz Mapowanie typów danych dla kwadratu.

3. Zastosuj samodzielnie hostowane środowisko Integration Runtime w wersji 5.56.0.0 lub nowszej.

4. query program jest obsługiwany tylko w wersji 1.0. Należy użyć elementu tableName zamiast query w wersji 2.0.

Powiązana zawartość

Aby uzyskać listę magazynów danych obsługiwanych jako źródła i ujścia działania kopiowania, zobacz obsługiwane magazyny danych.