Leads
Marketo の組織のリードを作成、更新、削除、クエリします。
テーブル固有の情報
Select
すべてのカラムは '=' 演算子を使って指定される必要があります。すべてのフィルタリング可能なカラムでは、IN 演算子またはOR 論理演算子を使って複数の値を指定できます。
取得したい行とカラムだけを指定することで、サーバーからの応答時間を向上できます。
SELECT Id, FirstName, LastName FROM Leads WHERE Id IN (1, 2, 5, 10)
フィルターが指定されていない場合は、Activities_NewLead テーブルがクエリされ、Lead Id のリストが取得されます。Lead Id がコンパイルされたら、コンパイルされたLead Id のリストを使ってLeads テーブルがクエリされます。 CreatedAt カラムは、取得するリードが作成された日時の範囲を指定するフィルターとして使用できます。'>' または'>=' 演算子を指定すると、 Activities_NewLead テーブルリクエストにdatetime 値が送られます。これは追加のAPI 呼び出しを必要とし、少なくとも倍のAPI 呼び出しが発生します。これは、それぞれのLeads リクエストに対して、1つのActivities_NewLead が発生するためです。 REST API のリクエストごとの最大バッチサイズは300です。必要なAPI 呼び出しの概算を出すには、次の式が使えます: (リードの総数 / 300) * 2
UpdatedAt カラムは、取得するリードが更新された日時の範囲を指定するフィルターとしても使用できます。フィルターを指定した場合は、Activities_LeadChanges テーブルがクエリされ、Lead Id のリストが取得されます。 Lead Id がコンパイルされたら、コンパイルされたLead Id のリストを使ってLeads テーブルがクエリされます。'>' または'>=' 演算子を指定すると、 Activities_LeadChanges テーブルリクエストにdatetime 値が送られます。これは追加のAPI 呼び出しを必要とし、少なくとも倍のAPI 呼び出しが発生します。これは、それぞれのLeads リクエストに対して、1つのActivities_LEADChanges が発生するためです。 大抵の場合、API 呼び出しの総数は、リードの個々の値がレコードとして返されるため、倍以上になります。 したがって、Lead Id の完全なリストを入手するには、複数のActivities_LeadChanges リクエストが必要になることがあります。REST API のリクエストごとの最大バッチサイズは300です。必要なAPI 呼び出しの最小見積もりを出すには、次の式が使えます: (リードの総数 / 300) * 2
代わりに、SOAP API を使ってLead Id のリストを取得する方法として、Other プロパティでUseSOAPForLeadIds=True に設定する方法があります。 この場合、SOAP API は、Lead Id のリストをコンパイルするために使用され(SOAP 接続の詳細が設定されているという条件で)、それがREST API のフィルターとして使用されます。 SOAP API はREST API と比べるとかなり遅いですが、このハイブリッドアプローチはSOAP API をそれだけで使用するよりも処理が早くなります。 SOAP API のリクエストごとの最大バッチサイズは1000です。必要なAPI 呼び出しの最小見積もりを出すには、次の式が使えます: (リードの総数 / 1000) + (リードの総数 / 300)
複数のAPI 呼び出し利用を回避しベストパフォーマンスを得るには、Marketo 内でリードのスタティックリストを作成し、ListId を指定してそれらを取得します。
Insert
新しいLead レコードを作成するには、Lead に関するデータベースに入力する情報を指定します。
次の例では、新しいLead を挿入する方法を説明します。
INSERT INTO Leads (Email, FirstName, LastName) VALUES ('[email protected]', 'John', 'Mark')
Update
読み取り専用以外のフィールドは、すべて更新可能です。Email などのFilterable カラムである外部キーを使って更新を行います。
次の例では、Id カラムをルックアップフィールドとして使って更新する方法を説明します。
UPDATE Leads SET MobilePhone='111-222-3333' WHERE Id = 1
次の例では、Email カラムをルックアップフィールドとして使って更新する方法を説明します。
UPDATE Leads SET MobilePhone='111-222-3333' WHERE Email = '[email protected]'
さらに、カスタムフィールドをルックアップフィールドとして使用できます。その場合、使用するカスタムフィールドの名前に加え、LookupField カラムを設定する必要があります。
次の例では、MyCustomField という名前のカスタムフィールドをルックアップフィールドとして使って更新する方法を説明します。
UPDATE Leads SET MobilePhone='111-222-3333' WHERE LookupField = 'MyCustomField' AND MyCustomField = 'my_value'
Delete
Marketo からリードを削除するために使用します。削除を実行するにはリードのId フィールドが必須です。
DELETE FROM Leads WHERE Id = 1
GetDeleted
Marketo から削除されたリードを取得するために使用します。削除されたリードを取得するには、UpdatedAt フィルターを指定する必要があります。指定しない場合、過去14日間のデータを取得します。
GetDeleted FROM Leads
Columns
| Name | Type | ReadOnly | Filterable | Description |
| Id [KEY] | Integer | True | True |
Marketo が割り当てた、アカウントの一意の識別子。 |
| String | False | True |
リードのメールアドレス。 | |
| Salutation | String | False |
リードの敬称。 | |
| FirstName | String | False |
リードのファーストネーム。 | |
| MiddleName | String | False |
リードのミドルネーム。 | |
| LastName | String | False |
リードのラストネーム。 | |
| DateOfBirth | Date | False |
リードの生年月日。 | |
| Title | String | False |
リードの職位。 | |
| Address | String | False |
リードの住所。 | |
| City | String | False |
リードの住所(都市)。 | |
| State | String | False |
リードの住所(都道府県)。 | |
| PostalCode | String | False |
リードの住所(郵便番号)。 | |
| Country | String | False |
リードの住所(国)。 | |
| Website | String | False |
リードのウェブサイト。 | |
| Phone | String | False |
リードの電話番号。 | |
| MobilePhone | String | False |
リードの携帯電話。 | |
| Fax | String | False |
リードのファックス番号。 | |
| Company | String | False |
リードの企業名。 | |
| MainPhone | String | False |
リードの企業の電話番号。 | |
| SICCode | String | False |
リードの企業のSIC コード。 | |
| Site | String | False |
リードの企業のサイト。 | |
| BillingStreet | String | False |
リードの企業の請求先住所。 | |
| BillingCity | String | False |
リードの企業の請求先住所(都市)。 | |
| BillingState | String | False |
リードの企業の請求先住所(都道府県)。 | |
| BillingPostalCode | String | False |
リードの企業の請求先住所(郵便番号)。 | |
| BillingCountry | String | False |
リードの企業の請求先住所(国)。 | |
| NumberOfEmployees | Integer | False |
リードの企業の従業員数。 | |
| Industry | String | False |
リードの企業の業界。 | |
| Department | String | False |
リードの部門。 | |
| AnnualRevenue | Double | False |
リードの企業の年間収益。 | |
| AnonymousIP | String | False |
リードの匿名IP。 | |
| Unsubscribed | Boolean | False |
リードが配信停止完了かどうかを決定します。 | |
| UnsubscribedReason | String | False |
リードの配信停止の理由。 | |
| EmailInvalid | Boolean | False |
リードのメールアドレスが無効かどうかを識別します。 | |
| EmailInvalidCause | String | False |
リードのメールアドレス無効の理由。 | |
| DoNotCall | Boolean | False |
リードが連絡拒否リストに載っているかどうかを識別します。 | |
| DoNotCallReason | String | False |
リードが電話連絡拒否の理由。 | |
| PersonType | String | False |
現在のレコードのパーソンタイプ。例:取引先責任者。 | |
| IsAnonymous | Boolean | True |
リードが匿名かどうかを識別します。 | |
| IsLead | Boolean | False |
そのパーソンがリードかどうかを識別します。 | |
| LeadRole | String | False |
リードのロール。 | |
| LeadSource | String | False |
リードのソース。 | |
| LeadStatus | String | False |
リードの現在のステータス。 | |
| LeadScore | Integer | False |
リードのスコア。 | |
| Rating | String | False |
リードの評価。 | |
| Urgency | Double | True |
リードの緊急度。 | |
| Priority | Integer | True |
リードの優先順位。 | |
| RelativeScore | Integer | True |
リードの相対スコア。 | |
| OriginalSourceType | String | True |
リードの参照元のソースのタイプ。 | |
| OriginalSourceInfo | String | True |
リードの参照元のソース情報。 | |
| RegistrationSourceType | String | False |
リードの登録ソースのタイプ。 | |
| RegistrationSourceInfo | String | False |
リードの登録ソース情報。 | |
| CreatedAt | Datetime | True | True |
リードの作成日。 |
| UpdatedAt | Datetime | True | True |
リードの最終更新日。 |
| Cookies | String | False | True |
リードと関連のあるクッキー。 |
| AcquisitionProgramId | String | False |
リードが獲得されたプログラムのId。 | |
| Gender | String | False |
リードのソーシャルジェンダ。 | |
| TotalReferredVisits | Integer | True |
リードのソーシャルを参照元とする総訪問数。 | |
| TotalReferredEnrollments | Integer | True |
リードのソーシャルを参照元とする総登録数。 | |
| LastReferredEnrollment | Datetime | False |
リードのソーシャルを最後の参照元とする登録。 | |
| LastReferredVisit | Datetime | False |
リードのソーシャルを最後の参照元とする訪問。 | |
| SyndicationId | String | False |
リードのソーシャルシンジケーションId。 | |
| FacebookDisplayName | String | False |
リードのFacebook の表示名。 | |
| FacebookId | String | False | True |
リードのFacebook Id。 |
| FacebookPhotoURL | String | False |
リードのFacebook の画像URL。 | |
| FacebookProfileURL | String | False |
リードのFacebook のプロファイルURL。 | |
| FacebookReach | Integer | False |
リードのFacebook のリーチ。 | |
| FacebookReferredEnrollments | Integer | False |
リードのFacebook を参照元とする登録数。 | |
| FacebookReferredVisits | Integer | False |
リードのFacebook を参照元とする訪問数。 | |
| LinkedInDisplayName | String | False | True |
リードのLinkedIn の表示名。 |
| LinkedInId | String | False |
リードのLinkedIn Id。 | |
| LinkedInPhotoURL | String | False |
リードのLinkedIn の画像URL。 | |
| LinkedInProfileURL | String | False |
リードのLinkedIn のプロファイルURL。 | |
| LinkedInReach | Integer | False |
リードのLinkedIn のリーチ。 | |
| LinkedInReferredEnrollments | Integer | False |
リードのLinkedIn を参照元とする登録数。 | |
| LinkedInReferredVisits | Integer | False |
リードのLinkedIn を参照元とする訪問数。 | |
| TwitterDisplayName | String | False |
リードのTwitter の表示名。 | |
| TwitterId | String | False |
リードのTwitter Id。 | |
| TwitterPhotoURL | String | False |
リードのTwitter の画像URL。 | |
| TwitterProfileURL | String | False |
リードのTwitter のプロファイルURL。 | |
| TwitterReach | Integer | False |
リードのTwitter のリーチ。 | |
| TwitterReferredEnrollments | Integer | False |
リードのTwitter を参照元とする登録数。 | |
| TwitterReferredVisits | Integer | False |
リードのTwitter を参照元とする訪問数。 | |
| ListId | Integer | True | True |
特定のリストに含まれるすべてのリードを取得するために使われるList Id。これはフィルタリング機能を強化するために使用できるフィルタ専用フィールドです。 |
| ProgramId | Integer | True | True |
特定のプログラムに関連するすべてのリードを取得するために使われるProgram Id。これはフィルタリング機能を強化するために使用できるフィルタ専用フィールドです。 |
| LookupField | String | True | True |
重複するリードを探すためのフィールド指定に使用します。INSERT またはUPDATE を行う場合にのみ使用します。利用可能な値は、id(デフォルト)、cookie、email、twitterId、facebookId、linkedInId、sfdcAccountId、sfdcContactId、sfdcLeadId、sfdcLeadOwnerId、およびカスタムフィールドです。これはフィルタリング機能を強化するために使用できるフィルタ専用フィールドです。 |