Funktionen – Integrationsaufgaben
Wie Sie vielleicht schon wissen, spielte das Update auf die APIs der Version 2.0 eine wichtige Rolle bei der Verwendung von benutzerdefinierten Funktionen, die jetzt "Funktionen" genannt werden. Dieses Handbuch hilft Ihnen bei der Verwendung von Aufgaben der Funktionsintegration, die die neuen APIs verwenden.
Erste Schritte
Der grundlegende Unterschied zwischen Version 1.0 und 2.0 der Zoho-APIs besteht darin, dass in der ersten Version Feldnamen und in der zweiten API-Namen verwendet werden.
So rufen Sie die API-Namen von Modulen ab:
- Navigieren Sie zu Setup > Entwicklerbereich > APIs > CRM-API > API-Namen.
- Die API-Namen der Module sind auf der Registerkarte "API-Namen" aufgeführt.
So rufen Sie die API-Namen von Feldern in Modulen ab:
- Navigieren Sie zu Setup > Entwicklerbereich > APIs > CRM-API > API-Namen.
- Klicken Sie auf einen Modulnamen. Zum Beispiel: "Leads"
- Die Registerkarte API-Name enthält die API-Namen von Feldern. Diese Felder sind im Code zu verwenden und NICHT die Namen auf der Registerkarte "Feldbezeichnung".
Datensätze abrufen
Datensätze, die Informationen enthalten, können aus mehreren unterstützten CRM-Modulen abgerufen werden. Sie können die Datensätze mit der Aufgabe zoho.crm.getRecords() abrufen.
Syntax: (mit APIs der Version 2.0)
<response>=zoho.crm.getRecords(<module_name>, [<page>],[<perPage>], {<optionalDataMap>}, <connections>);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort mit der LISTE der Datensätze, die den Abrufkriterien entsprechen. |
| <module_name> | Der Name des Moduls, von dem der Datensatz abgerufen werden soll. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| <page> (optional) | Um die Liste der Datensätze basierend auf Seiten zu erhalten. Hat den Datentyp ZAHL. Standard – 1. |
| <perPage> (optional) | Wird verwendet, um die Liste der verfügbaren Datensätze pro Seite zu erhalten. Hat den Datentyp ZAHL. Standard – 200. |
| <optionalDataMap> | Wird verwendet, um die Liste der Datensätze mit anderen Parametern als "page" und "per_page" zu erhalten. |
| <connections> | Zeigt die der Funktion zugeordneten Verbindungsstellen an. Der Datentyp ist ZEICHENFOLGE. |
Beispieleingabe:
resp = zoho.crm.getRecords("Leads",1,20,{"converted":"true"});
Hinweis:
- Im obigen Beispiel ist "converted" eine optionalDataMap.
Syntax: (mit APIs der Version 1.0)
<response>=zoho.crm._getRecords(<module_name>, [<from_index>],[<to_index>]);
Datensatz nach ID abrufen
Eine Liste von Datensätzen zu erhalten ist nützlich, aber was ist, wenn Sie Details über einen bestimmten Datensatz abrufen möchten? Sie können die Aufgabe zoho.crm.getRecordById() verwenden, um die Informationen über einen bestimmten Datensatz abzurufen.
Syntax: (mit APIs der Version 2.0)
<response>=zoho.crm.getRecordById(<module_name>, <record_ID>, <connections>);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort, die als ZUWEISUNG zurückgegeben wurde. |
| <module_name> | Der Name des Moduls, von dem der Datensatz abgerufen werden soll. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| <record_ID> | Die ID des abzurufende Datensatzes. Hat den Datentyp ZAHL. |
| <connections> | Zeigt die der Funktion zugeordneten Verbindungsstellen an. Der Datentyp ist ZEICHENFOLGE. |
Beispieleingabe:
resp = zoho.crm.getRecordById("Leads", 2938383000000392001);
Syntax: (mit APIs der Version 1.0)
<response>=zoho.crm._getRecordById(<module_name>, <record_ID>);
Datensatz erstellen
Richten Sie die Funktionen so ein, dass aufgrund bestimmter Aktionen automatisch Datensätze erstellt werden. Beispiel: Sie können die Funktion auslösen, um einen Datensatz in "Aufgaben" anzulegen, wenn Sie den Status eines Lead ändern. Die Aufgabe zoho.crm.create() wird verwendet, um Datensätze zu erstellen.
Syntax: (mit APIs der Version 2.0)
<variable>=zoho.crm.create(<module_name>,{<dataMap>}, {<optionalDataMap>}, <connections>);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort, die als ZUWEISUNG zurückgegeben wird. |
| <module_name> | Der Name des Moduls, von dem der Datensatz abgerufen werden soll. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| <dataMap> | Der Name der Felder im Modul, die bei der Erstellung des Datensatzes angegeben werden sollen. Beispiel: {"Nachname":"Zoho CRM"} |
| <optionalDataMap> | Repräsentiert alle Datenzuweisungen mit Ausnahme der Eingabe "JSON". |
| <connections> | Zeigt die der Funktion zugeordneten Verbindungsstellen an. Der Datentyp ist ZEICHENFOLGE. |
Beispieleingabe:
data = Map();
data.putAll({"Last_Name":"Bruce Wills", "Company":"Zillum"});
optionalMap = Map();
optionalMap.put("trigger", ["workflow","approval", "blueprint"]); // "Auslöser" als leer [] übergeben, um Workflow nicht auszuführen
resp = zoho.crm.create("Leads", data, optionalMap);
Beispielantwort:
{"Modified_Time":"2018-03-26T14:33:01+05:30","Modified_By":{"name":"Ben","id":"2938383000000132011"},"Created_Time":"2018-03-26T14:33:01+05:30","id":"2938383000000389001","Created_By":{"name":"Ben","id":"2938383000000132011"}}
Syntax: (mit APIs der Version 1.0)
<variable>=zoho.crm._create(<module_name>,{<field_values>});
Eine große Anzahl an Datensätzen erstellen
Richten Sie die Funktionen so ein, dass aufgrund bestimmter Aktionen automatisch Datensätze erstellt werden. Beispiel: Sie können die Funktion auslösen, um mehrere Datensätze in "Contacts", "Accounts", "Tasks", "Deals" usw. zu erstellen, wenn Sie die Umwandlung eines Lead in einen Kontakt ändern. Die Aufgabe zoho.crm.bulkCreate() wird verwendet, um Datensätze zu erstellen.
Syntax: (mit APIs der Version 2.0)
<variable>=zoho.crm.bulkCreate(<module_name>,[record1, record2]);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort, die als ZUWEISUNG zurückgegeben wird. |
| <module_name> | Der Name des Moduls, von dem der Datensatz abgerufen werden soll. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| [record1, record2] | Die LISTE mit Informationen über die zu erstellenden Datensätze. |
Beispieleingabe:
resp = zoho.crm.bulkCreate("Leads", [{"Last_Name":"Deborah"},{"Last_Name":"James"}], {"trigger":["workflow","blueprint","approval"]});
Einen Datensatz aktualisieren
Es kommt immer wieder vor, dass Datensätze aktualisiert werden müssen. Das Bearbeiten der vorhandenen Informationen, das Hinzufügen zusätzlicher Informationen usw. kann automatisch erfolgen, indem Sie die Aufgabe zoho.crm.updateRecord() konfigurieren, die einen Datensatz basierend auf dem programmierten Szenario automatisch aktualisiert.
Syntax: (mit APIs der Version 2.0)
<response>=zoho.crm.updateRecord(<module_name>, <record_ID>, <dataMap>, {<optionalDataMap>}, <connections>);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort, die als ZUWEISUNG zurückgegeben wird. |
| <module_name> | Der Name des Moduls, von dem der Datensatz abgerufen werden soll. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| <record_ID> | Die ID des zu aktualisierenden Datensatzes. Hat den Datentyp ZAHL. |
| <dataMap> | Schlüssel. Wertepaare mit aktualisierten Datensatzinformationen. |
| <optionalDataMap> | Repräsentiert alle Datenzuweisungen mit Ausnahme der Eingabe "JSON". |
| <connections> | Zeigt die der Funktion zugeordneten Verbindungsstellen an. Der Datentyp ist ZEICHENFOLGE. |
Beispieleingabe:
resp = zoho.crm.update("Leads", 2938383000000392001, {"Company":"Zillum Corp"});
Beispielantwort:
{"Modified_Time":"2018-03-26T15:17:39+05:30","Modified_By":{"name":"Ben","id":"2938383000000132011"},"Created_Time":"2018-03-26T14:39:28+05:30","id":"2938383000000392001","Created_By":{"name":"Ben","id":"2938383000000132011"}}
Syntax: (mit APIs der Version 1.0)
<response>=zoho.crm._updateRecord(<module_name>, <record_ID>, <Neue Werte als Zuweisungsobjekt>);
Einen Datensatz suchen
Suchen Sie nach bestimmten Datensätzen, indem Sie die Kriterien für die Suche angeben. Die gesuchten Datensätze können verwendet werden, um Aktionen überall durchzuführen. Für die Suche nach einem Datensatz müssen der Modulname und die Suchkriterien angegeben werden.
Syntax: (mit APIs der Version 2.0)
<response>=zoho.crm.searchRecords(<module_name>, <criteria>, [<page>],[<perPage>], <connections>);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort mit der LISTE der Datensätze, die den Abrufkriterien entsprechen. |
| <module_name> | Der Name des Moduls, von dem der Datensatz abgerufen werden soll. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| <criteria> | Die bedingte Anweisung für die Suche. Sie hat folgendes Format: (
|
| <page> (optional) | Um die Liste der Datensätze basierend auf Seiten zu erhalten. Hat den Datentyp ZAHL. Standard – 1. |
| <perPage> (optional) | Wird verwendet, um die Liste der verfügbaren Datensätze pro Seite zu erhalten. Hat den Datentyp ZAHL. Standard – 200. |
| <connections> (optional) | Zeigt die der Funktion zugeordneten Verbindungsstellen an. Der Datentyp ist ZEICHENFOLGE. |
Beispieleingabe:
resp = zoho.crm.searchRecords("Leads", "(Company:equals:Zillum)");
Hinweis:
- Die Suche nach Datensätzen nach PDC ist in Version 2.0 nicht möglich.
- Wenn eine Spalte Nullwerte enthält, führt "zoho.crm.searchRecords" diese NICHT in einer <> Anweisung auf.
- Es können maximal immer nur je 200 Datensätze abgerufen werden.
Syntax: (mit APIs der Version 1.0)
<response>=zoho.crm._searchRecords(<module_name>, <criteria>, [<from_index>],[<to_index>]);
Verwandte Datensätze abrufen
Es gibt verschiedene CRM-Komponenten, die verwendet werden können, um Informationen über einen bestimmten Lead oder Kontakt zu speichern. Ein Lead kann beispielsweise eine Liste von Notizen, mehrere Geschäftsabschlüsse, zugehörige Aufrufe usw. enthalten. Die Suche nach einer Notiz zu einem bestimmten Datensatz in einem Modul kann mit der Aufgabe zoho.crm.getRelatedRecords() erfolgen.
Syntax: (mit APIs der Version 2.0)
<response>=zoho.crm.getRelatedRecords(<relation_name>, <parent_module_name>, <record_ID>, [<page>],[<perPage>], <connections>);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort mit der LISTE der Datensätze, die den Abrufkriterien entsprechen. |
| <relation_name> | Der Name des Moduls (auch Teilmodul genannt), von dem der Datensatz abgerufen werden soll. Hat den Datentyp ZEICHENFOLGE. Unterstützte Module sind: "Notes", "Quotes", "Products", "Tasks", "Campaigns", "Events", "Calls". |
| <parent_module_name> | Der Name des Moduls, zu dem das Teilmodul gehört. Beispiel: "Notizen" können zu einem übergeordneten Modul "Leads" gehören. Hat den Datentyp ZEICHENFOLGE. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| <record_ID> | Die ID des übergeordneten Moduldatensatzes, der abgerufen werden soll. Hat den Datentyp ZAHL. |
| <page> (optional) | Um die Liste der Datensätze basierend auf Seiten zu erhalten. Hat den Datentyp ZAHL. Standard – 1. |
| <perPage> (optional) | Wird verwendet, um die Liste der verfügbaren Datensätze pro Seite zu erhalten. Hat den Datentyp ZAHL. Standard – 200. |
| <connections> (optional) | Zeigt die der Funktion zugeordneten Verbindungsstellen an. Der Datentyp ist ZEICHENFOLGE. |
Hinweis:
- Es können maximal immer nur je 200 Datensätze abgerufen werden.
Beispieleingabe:
Um Kampagnen abzurufen, die sich auf einen Lead beziehen:
resp = zoho.crm.getRelatedRecords("Campaigns", "Leads", 2938383000000392001);
Um Aufgaben im Zusammenhang mit einem Lead abzurufen:
resp = zoho.crm.getRelatedRecords("Task", "Leads", 2938383000000392001);
Syntax: (mit APIs der Version 1.0)
<response>=zoho.crm._getRelatedRecords(<module_name>, <parent_module_name>, <record_ID>, [<from_index>],[<to_index>]);
Verwandte Datensätze aktualisieren
Es gibt verschiedene CRM-Komponenten, die verwendet werden können, um Informationen über einen bestimmten Lead oder Kontakt zu speichern. Sie können die Datensätze, die sich auf einen übergeordneten Datensatz beziehen, mit der Aufgabe zoho.crm.updateRelatedRecord() aktualisieren.
Syntax: (mit APIs der Version 2.0)
<response>=zoho.crm.updateRelatedRecords(<relation_name>, <record_ID_1>, <parent_module_name>, <record_ID_2>, {<Neue Werte als Zuweisungsobjekt>});
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort mit der LISTE der Datensätze, die den Abrufkriterien entsprechen. |
| <relation_name> | Der Name des Moduls (auch Teilmodul genannt), von dem der Datensatz abgerufen werden soll. Hat den Datentyp ZEICHENFOLGE. Unterstützte Module sind: "Notes", "Quotes", "Products", "Tasks", "Campaigns", "Events", "Calls", "Emails". |
| <record_ID_1> | Die ID des Datensatzes, der aktualisiert werden muss. Hat den Datentyp ZAHL. |
| <parent_module_name> | Der Name des Moduls, zu dem das Teilmodul gehört. Beispiel: "Notizen" können zu einem übergeordneten Modul "Leads" gehören. Hat den Datentyp ZEICHENFOLGE. Unterstützte Module sind: "Leads", "Deals", "Products", "Contacts", "Campaigns", "Vendors", "Accounts", "Cases", "Quotes", "Sales Orders", "Purchase Orders", "Invoices" und benutzerdefinierte Module. |
| <record_ID_2> | Die ID des übergeordneten Moduldatensatzes, der abgerufen werden soll. Hat den Datentyp ZAHL. |
| <Neue Werte als ZUWEISUNGSOBJEKT> | Schlüssel. Wertepaare mit aktualisierten Datensatzinformationen. Beispiel: {"Nachname": "Aktualisierter Name", "Fax": "555-858-3466"} |
Beispieleingabe:
Um die Produktmenge zu aktualisieren:
resp = zoho.crm._updateRelatedRecords("Products",2938383000000392001, "Leads", 2938383000000392001, {"Product_Quantity":"50"});
Syntax: (mit APIs der Version 1.0)
<response>=zoho.crm._updateRelatedRecords(<module_name>, <parent_module_name>, <record_ID>, [<from_index>],[<to_index>]);
Lead konvertieren
Der nächste Schritt nach der Lead-Akquise wären Verhandlungen, bei denen wertvolle Interessenten von Leads in Kontakte umgewandelt werden können. Sie können die Aufgabe zoho.crm.convertLead() verwenden, um die Lead-Informationen als Kontaktdatensatz zu übertragen.
Syntax: (mit APIs der Version 2.0)
<response>=zoho.crm.convertLead(<record_ID>, <overwrite>, <notify_lead_owner>, <notify_new_entity_owner>, <account_ID>);
| Parameter | Beschreibung |
|---|---|
| <response> | Die Antwort, die als ZUWEISUNG zurückgegeben wurde. |
| <record_ID> | Die ID des abzurufende Datensatzes. Hat den Datentyp ZAHL. |
| <overwrite> | Wird verwendet, um die Daten zu überschreiben, wenn der Lead bereits umgewandelt wurde. Datentyp ist BOOLESCH. Sollte entweder wahr oder falsch sein. |
| <notify_lead_owner> | Wird verwendet, um nach der Konvertierung eine Benachrichtigung an den Lead-Eigentümer zu senden. Datentyp ist BOOLESCH. Sollte entweder wahr oder falsch sein. |
| <notify_new_entity_owner> | Wird verwendet, um nach der Konvertierung eine Benachrichtigung an den Eigentümer der neuen Entität (Kontakt) zu senden. Datentyp ist BOOLESCH. Sollte entweder wahr oder falsch sein. |
| <account_ID> (optional) | Die ID des abzurufende Datensatzes. Hat den Datentyp ZAHL. |
Beispieleingabe:
resp = zoho.crm.convertLead(7000000037308, { "overwrite": true, "notify_lead_owner": false, "notify_new_entity_owner": true, "Accounts": "7000000037323", "Deals": { "Deal_Name": "Robert", "Closing_Date": "2016-03-30", "Stage": "Closed Won", "Amount": 56.6 } });