Membuat agen untuk mengelola merek

Pilih apakah akan mengelola agen dengan Konsol Developer atau API Komunikasi Bisnis.

Developer Console API

Setelah mendaftar sebagai partner, Anda dapat mengaktifkan percakapan untuk merek yang Anda kelola dengan membuat agen Business Messages untuk merek tersebut.

Agen: Representasi percakapan dari suatu merek, yang dikelola oleh partner. Mencakup antarmuka yang berinteraksi dengan pengguna dan kode atau infrastruktur apa pun yang diperlukan untuk mendukung interaksi.

Agen adalah entitas percakapan yang berinteraksi dengan pengguna. Anda membuat satu agen untuk setiap merek yang Anda kelola. Anda membuat dan mengelola agen dengan Business Communications API, dan mengontrol pesan untuk agen dengan Business Messages API.

Agen mencakup fungsi bisnis merek, seperti dukungan online, dan lokasi fisik (jika ada). Setiap pesan berisi konteks tempat pengguna memulai percakapan. Infrastruktur pemilihan rute pesan Anda dapat mendeteksi apakah pengguna melihat lokasi bisnis tertentu atau mencari dukungan umum, dan dapat merutekan pesan ke tujuan yang benar.

Misalnya, jika Anda mengelola merek Growing Tree Bank, yang memiliki situs dan dua lokasi, Anda membuat satu agen "Growing Tree Bank". Pengguna dapat menemukan agen melalui penelusuran umum atau berbasis lokasi, dan konteks tempat pengguna menemukan agen akan diteruskan bersama setiap pesan ke webhook Anda. Anda menggunakan konteks tersebut untuk merutekan pesan ke staf di lokasi atau ke tim dukungan situs, yang membuat respons dan melanjutkan percakapan dengan pengguna.

Ekspektasi

Sebelum membuat agen, pahami ekspektasi agen di Business Messages.

• Agen harus mengikuti panduan desain yang diuraikan dalam Desain percakapan untuk Business Messages.

• Agen harus memiliki perwakilan manusia yang tersedia untuk menjawab pertanyaan saat otomatisasi tidak dapat memenuhi permintaan atau saat diminta oleh pengguna.

  Catatan: Jika tidak mendukung perwakilan manusia, agen Anda tidak dapat diluncurkan dari titik entri berbasis lokasi atau titik entri non-lokal. Tentukan jenis interaksi manusia untuk agen Anda, sehingga dapat muncul di titik entri yang dikelola Google.

• Agen harus mempertahankan rating kepuasan pelanggan (CSAT) minimal 80% dan rasio respons penjual (MRR) minimal 95% seperti yang diuraikan dalam Metrik.

Membuat agen

Untuk membuat agen, Anda perlu mengumpulkan dan mengirimkan informasi tentang merek dan tampilan agen yang Anda inginkan kepada pengguna.

Catatan: Anda memerlukan akun Google Business Messages untuk membuat agen. Untuk mendaftar ke akun, lihat Mendaftar dengan Business Messages dan tinjau ekspektasi untuk agen operasi.

Jika Anda mengelola beberapa merek, ulangi langkah-langkah untuk membuat agen untuk setiap merek.

Prasyarat

Sebelum membuat agen untuk merek yang Anda kelola, Anda perlu mengumpulkan beberapa informasi:

Lingkungan pengembangan

Informasi tentang lingkungan pengembangan Anda.

• Project GCP dengan Business Communications API yang diaktifkan

  Untuk mengaktifkan API, lihat Mendaftar dengan Messaging Bisnis.

• Jalur ke kunci akun layanan project GCP Anda di komputer pengembangan

Detail merek

Informasi tentang merek yang diwakili oleh agen.

• Nama merek
• Situs brand
• Opsi kontak di situs (sebagaimana ditentukan dalam OPTION)
• Nomor telepon yang ditampilkan kepada konsumen
• Nomor telepon yang diaktifkan untuk pengalihan panggilan

Tampilan dan kebijakan agen

Informasi tentang tampilan agen kepada pengguna dan cara kerjanya.

• Nama agen, seperti yang Anda inginkan agar muncul dalam percakapan dengan pengguna
• Kebijakan privasi, sebagai URL yang tersedia secara publik yang diawali dengan "https://"

• (Direkomendasikan) Logo agen (1024x1024 piksel), sebagai URL yang tersedia secara publik

  Dalam percakapan, logo ditampilkan sebagai lingkaran berdiameter 1024 piksel. Pastikan logo Anda ditampilkan dengan baik dalam bentuk lingkaran.

  Menguji logo

  Masukkan URL untuk logo Anda guna melihat tampilannya bagi pengguna.

  Catatan: Server web yang menghosting gambar harus mengizinkan gambar disematkan di situs lain.

• (Opsional) ID Agen Kustom, yang mengidentifikasi merek dalam pesan yang diterima webhook

Interaksi agen

Informasi tentang cara agen Anda berinteraksi dengan pengguna.

• Lokal tempat agen Anda biasanya beroperasi, yang ditentukan oleh kode bahasa ISO 639-1 dua karakter

• Pesan selamat datang agen

  Apa yang dikatakan agen untuk menyapa pengguna?

• Pembuka percakapan agen

  Daftar saran, dalam bentuk chip percakapan (seperti yang ditentukan dalam SuggestedReply), agar pengguna dapat berinteraksi dengan agen

  • Teks yang ditampilkan kepada pengguna di chip
  • Data postback, string yang dikirim kembali ke webhook Anda dalam payload pesan jika pengguna mengetuk chip

• Waktu chat otomatis dan live chat

  • Waktu mulai harian, sebagai objek TimeOfDay

    Misalnya, pukul 08.15 adalah

    {
      "hours": 8,
      "minutes": 15,
    }
    

  • Waktu akhir harian, sebagai objek TimeOfDay

    Misalnya, pukul 19.30 adalah

    {
      "hours": 19,
      "minutes": 30,
    }
    

  • Hari mulai, hari pertama dalam seminggu saat agen tersedia untuk chat (seperti yang ditentukan dalam DayOfWeek)

  • Hari akhir, hari terakhir dalam seminggu saat agen tersedia untuk chat (seperti yang ditentukan dalam DayOfWeek)

  • Zona waktu tempat agen beroperasi (seperti yang ditentukan dalam Database Zona Waktu IANA, misalnya "America/Los_Angeles")

Titik entri agen

Informasi tentang tempat pengguna dapat memulai percakapan dengan agen.

• Titik entri agen yang diizinkan, tempat pengguna dapat memulai percakapan dengan agen (NON_LOCAL dan/atau LOCATION)

  Catatan: Titik entri LOCATION diperlukan untuk mengaktifkan percakapan khusus lokasi.

Informasi tentang titik entri NON_LOCAL (tidak berlaku untuk titik entri Google Ads).

• Wilayah yang diizinkan (sebagai kode wilayah CLDR), untuk membatasi akses regional ke titik entri NON_LOCAL.

  Terlepas dari wilayahnya, agen hanya dapat memiliki satu nomor telepon yang terkait dengannya. Jika Anda memerlukan nomor telepon yang berbeda berdasarkan wilayah, agen yang berbeda harus dibuat untuk setiap wilayah.

  Untuk mengaktifkan titik entri NON_LOCAL di semua region yang tersedia, gunakan 001 untuk kode region Dunia.

Menginstal dan menguji oauth2l

Semua permintaan curl dalam dokumentasi situs ini menggunakan oauth2l untuk autentikasi. Jika Anda ingin menggunakan command line untuk terhubung dengan Business Communications dan Business Messages API, instal oauth2l.

Untuk menginstal oauth2l dengan Python 3,

1. Download oauth2l.

2. Ubah direktori ke "./oauth2l/python".

3. Instal oauth2l dengan perintah berikut.

   sudo python setup.sh build && sudo python setup.py install
   

4. Uji apakah oauth2l dapat membuat token otorisasi.

   oauth2l header --json resources/bm-agent-service-account-credentials.json businesscommunications

5. Pastikan output membuat token otorisasi dalam bentuk:

   Authorization: Bearer AUTHORIZATION_BEARER_TOKEN
   

Ada cara lain untuk menginstal oauth2l untuk berbagai sistem operasi. Apa pun metode penginstalan Anda, pastikan Anda dapat membuat token otorisasi berdasarkan kredensial JSON akun layanan sebelum melanjutkan.

Membuat agen

Setelah mengumpulkan informasi, saatnya membuat agen.

1. Buat merek yang diwakili oleh agen. Jika merek sudah ada, dapatkan name merek dan lanjutkan ke langkah berikutnya.

   Di terminal, jalankan perintah berikut:

   cURL

   # This code creates a brand.
   # Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create
   
   # Make sure a service account key file exists at ./service_account_key.json
   
   curl -X POST "https://businesscommunications.googleapis.com/v1/brands" \
   -H "Content-Type: application/json" \
   -H "User-Agent: curl/business-communications" \
   -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
   -d '{
     "displayName": "My first brand curl"
   }'
   create-brand.sh

   Node.js

   /**
    * This code snippet creates a brand.
    * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create
    *
    * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
    * Business Communications client library.
    */
   
   /**
    * Edit the values below:
    */
   const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';
   
   const businesscommunications = require('businesscommunications');
   const {google} = require('googleapis');
   
   // Initialize the Business Communications API
   const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});
   
   // Set the scope that we need for the Business Communications API
   const scopes = [
     'https://www.googleapis.com/auth/businesscommunications',
   ];
   
   // Set the private key to the service account file
   const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);
   
   async function main() {
     const authClient = await initCredentials();
   
     if (authClient) {
       // Setup the parameters for the API call
       const apiParams = {
         auth: authClient,
         resource: {
           displayName: 'My first brand',
         },
       };
   
       bcApi.brands.create(apiParams, {}, (err, response) => {
         if (err !== undefined && err !== null) {
           console.dir(err);
         } else {
           // Brand created
           console.log(response.data);
         }
       });
     }
     else {
       console.log('Authentication failure.');
     }
   }
   
   /**
    * Initializes the Google credentials for calling the
    * Business Communcations API.
    */
    async function initCredentials() {
     // configure a JWT auth client
     const authClient = new google.auth.JWT(
       privatekey.client_email,
       null,
       privatekey.private_key,
       scopes,
     );
   
     return new Promise(function(resolve, reject) {
       // authenticate request
       authClient.authorize(function(err, tokens) {
         if (err) {
           reject('Failed to connect');
         } else {
           resolve(authClient);
         }
       });
     })
   }
   
   main();
   create-brand.js

   Java

   import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.HttpTransport;
   import com.google.api.client.json.jackson2.JacksonFactory;
   import com.google.api.services.businesscommunications.v1.BusinessCommunications;
   import com.google.api.services.businesscommunications.v1.model.Brand;
   import java.io.FileInputStream;
   import java.util.Arrays;
   import java.util.UUID;
   
   class Main {
     /**
      * Initializes credentials used by the Business Communications API.
      */
     private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
       BusinessCommunications.Builder builder = null;
       try {
         GoogleCredential credential = GoogleCredential
               .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));
   
         credential = credential.createScoped(Arrays.asList(
             "https://www.googleapis.com/auth/businesscommunications"));
   
         credential.refreshToken();
   
         HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
         JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();
   
         // Create instance of the Business Communications API
         builder = new BusinessCommunications
             .Builder(httpTransport, jsonFactory, null)
             .setApplicationName(credential.getServiceAccountProjectId());
   
         // Set the API credentials and endpoint
         builder.setHttpRequestInitializer(credential);
       } catch (Exception e) {
         e.printStackTrace();
       }
   
       return builder;
     }
   
     public static void main(String args[]) {
       try {
         // Create client library reference
         BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();
   
         // Create a request to create a new brand
         BusinessCommunications.Brands.Create request = builder
             .build().brands().create(new Brand().setDisplayName("BRAND_NAME"));
   
         Brand brand = request.execute();
   
         // Print newly created brand object
         System.out.println(brand.toPrettyString());
       } catch (Exception e) {
         e.printStackTrace();
       }
     }
   }

   Kode ini didasarkan pada library klien Java Business Communications.

   Python

   """This code creates a brand.
   
   Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/create
   
   This code is based on the https://github.com/google-business-communications/python-businessmessages
   Python Business Messages client library.
   """
   
   from oauth2client.service_account import ServiceAccountCredentials
   from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
   from businesscommunications.businesscommunications_v1_messages import (
       Brand)
   
   # Edit the values below:
   SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
   SERVICE_ACCOUNT_FILE = './service_account_key.json'
   
   credentials = ServiceAccountCredentials.from_json_keyfile_name(
       SERVICE_ACCOUNT_FILE, scopes=SCOPES)
   
   client = BusinesscommunicationsV1(credentials=credentials)
   
   brands_service = BusinesscommunicationsV1.BrandsService(client)
   
   brand = brands_service.Create(Brand(displayName='My first brand'))
   
   print(brand)
   create-brand.py

   Simpan nilai name yang ditampilkan API. Anda memerlukannya untuk melakukan update atau membuat agen.

   Untuk memperbarui atau mencari merek, lihat brands.

2. Buat agen. Ganti BRAND_ID dengan bagian dari nilai name merek yang mengikuti "brands/". Misalnya, jika name adalah "brands/12345", ID mereknya adalah "12345".

   Catatan: Ganti variabel yang ditandai dengan nilai yang Anda identifikasi di Prasyarat.

   Di terminal, jalankan perintah berikut:

   cURL

   # This code creates a Business Messages agent.
   # Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_agent
   
   # Replace the __BRAND_ID__ with a brand id that you can create agents for
   # Make sure a service account key file exists at ./service_account_key.json
   
   curl -X POST "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents" \
   -H "Content-Type: application/json" \
   -H "User-Agent: curl/business-communications" \
   -H "$(oauth2l header --json ./service_account_key.json businesscommunications)" \
   -d '{
     "displayName": "My first agent",
     "businessMessagesAgent": {
       "logoUrl": "https://developers.google.com/identity/images/g-logo.png",
       "entryPointConfigs": [
         {
           "allowedEntryPoint": "NON_LOCAL"
         }
       ],
       "customAgentId": "'$(uuidgen)'",
       "nonLocalConfig": {
         "regionCodes": [
           "US",
           "CA"
         ],
         "contactOption": {
           "url": "https://www.your-company-website.com",
           "options": [
             "EMAIL",
             "PHONE"
           ]
         },
         "enabledDomains": [
           "your-company-website.com"
         ],
         "phoneNumber": {
           "number": "[phone]"
         },
         "callDeflectionPhoneNumbers": [
           {
             "number": "[phone]"
           },
           {
             "number": "[phone]"
           }
         ]
       },
       "conversationalSettings": {
         "en": {
           "welcomeMessage": {
             "text": "This is a sample welcome message"
           },
           "privacyPolicy": {
             "url": "https://www.your-company-website.com/privacy"
           },
           "conversationStarters": [
             {
               "suggestion": {
                 "reply": {
                   "text": "Option 1",
                   "postbackData": "postback_option_1"
                 }
               }
             }
           ]
         }
       },
       "defaultLocale": "en",
       "primaryAgentInteraction": {
         "interactionType": "HUMAN",
         "humanRepresentative": {
           "humanMessagingAvailability": {
             "hours": [
               {
                 "startTime": {
                   "hours": 8,
                   "minutes": 30
                 },
                 "endTime": {
                   "hours": 20,
                   "minutes": 0
                 },
                 "timeZone": "America/Los_Angeles",
                 "startDay": "MONDAY",
                 "endDay": "SATURDAY"
               }
             ]
           }
         }
       }
     }
   }'
   create-agent-bm.sh

   Node.js

   /**
    * This code snippet creates a Business Messages agent.
    * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_agent
    *
    * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
    * Business Communications client library.
    */
   
   /**
    * Edit the values below:
    */
   const BRAND_ID = 'EDIT_HERE';
   const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';
   
   const businesscommunications = require('businesscommunications');
   const {google} = require('googleapis');
   const uuidv4 = require('uuid').v4;
   
   // Initialize the Business Communications API
   const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});
   
   // Set the scope that we need for the Business Communications API
   const scopes = [
     'https://www.googleapis.com/auth/businesscommunications',
   ];
   
   // Set the private key to the service account file
   const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);
   
   async function main() {
     const authClient = await initCredentials();
     const brandName = 'brands/' + BRAND_ID;
   
     if (authClient) {
       const agentObject = {
         displayName: 'My first agent',
         businessMessagesAgent: {
           customAgentId: uuidv4(), // Optional
           logoUrl: 'https://developers.google.com/identity/images/g-logo.png',
           entryPointConfigs: [
             {
               allowedEntryPoint: 'NON_LOCAL',
             }
           ],
           nonLocalConfig: { // Configuration options for launching on non-local entry points
             // List of phone numbers for call deflection, values must be globally unique
             callDeflectionPhoneNumbers: [
               { number: '[phone]' },
               { number: '[phone]' },
             ],
             // Contact information for the agent that displays with the messaging button
             contactOption: {
               options: [
                 'EMAIL',
                 'PHONE'
               ],
               url: 'https://www.your-company-website.com',
             },
             // Domains enabled for messaging within Search, values must be globally unique
             enabledDomains: [ 'your-company-website.com' ],
             // Agent's phone number. Overrides the `phone` field
             // for conversations started from non-local entry points
             phoneNumber: { number: '[phone]' },
             // List of CLDR region codes for countries where the agent is allowed to launch `NON_LOCAL` entry points
             regionCodes: [ 'US', 'CA' ]
           },
           // Must match a conversational setting locale
           defaultLocale: 'en',
           conversationalSettings: {
             en: {
               privacyPolicy: { url: 'https://www.your-company-website.com/privacy' },
               welcomeMessage: { text: 'This is a sample welcome message' },
               conversationStarters: [
                 {
                   suggestion: {
                     reply: {
                       text: 'Option 1',
                       postbackData: 'postback_option_1',
                     },
                   },
                 },
               ],
             },
           },
           primaryAgentInteraction: {
             interactionType: 'HUMAN',
             humanRepresentative: {
               humanMessagingAvailability: {
                 hours: [
                   {
                     startTime: {
                       hours: 8,
                       minutes: 30
                     },
                     startDay: 'MONDAY',
                     endDay: 'SATURDAY',
                     endTime: {
                       hours: 20,
                       minutes: 0
                     },
                     timeZone: 'America/Los_Angeles',
                   },
                 ],
               },
             },
           },
         },
       };
   
       // Setup the parameters for the API call
       const apiParams = {
         auth: authClient,
         parent: brandName,
         resource: agentObject
       };
   
       bcApi.brands.agents.create(apiParams, {}, (err, response) => {
         if (err !== undefined && err !== null) {
           console.dir(err);
         } else {
           // Agent created
           console.log(response.data);
         }
       });
     }
     else {
       console.log('Authentication failure.');
     }
   }
   
   /**
    * Initializes the Google credentials for calling the
    * Business Messages API.
    */
    async function initCredentials() {
     // Configure a JWT auth client
     const authClient = new google.auth.JWT(
       privatekey.client_email,
       null,
       privatekey.private_key,
       scopes,
     );
   
     return new Promise(function(resolve, reject) {
       // Authenticate request
       authClient.authorize(function(err, tokens) {
         if (err) {
           reject(false);
         } else {
           resolve(authClient);
         }
       });
     });
   }
   
   main();
   create-agent-bm.js

   Java

   import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.HttpTransport;
   import com.google.api.client.json.jackson2.JacksonFactory;
   import com.google.api.services.businesscommunications.v1.BusinessCommunications;
   import com.google.api.services.businesscommunications.v1.model.Brand;
   import com.google.common.collect.ImmutableMap;
   import java.io.FileInputStream;
   import java.util.Arrays;
   import java.util.UUID;
   
   class Main {
     /**
      * Initializes credentials used by the Business Communications API.
      */
     private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
       BusinessCommunications.Builder builder = null;
       try {
         GoogleCredential credential = GoogleCredential
               .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));
   
         credential = credential.createScoped(Arrays.asList(
             "https://www.googleapis.com/auth/businesscommunications"));
   
         credential.refreshToken();
   
         HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
         JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();
   
         // Create instance of the Business Communications API
         builder = new BusinessCommunications
             .Builder(httpTransport, jsonFactory, null)
             .setApplicationName(credential.getServiceAccountProjectId());
   
         // Set the API credentials and endpoint
         builder.setHttpRequestInitializer(credential);
       } catch (Exception e) {
         e.printStackTrace();
       }
   
       return builder;
     }
   
     public static void main(String args[]) {
       try {
         // Create client library reference
         BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();
   
         String brandName = "BRAND_ID";
   
         BusinessCommunications.Brands.Agents.Create request = builder
             .build().brands().agents().create(brandName,
                 new Agent()
                     .setDisplayName("AGENT_NAME")
                     .setBusinessMessagesAgent(new BusinessMessagesAgent()
                         .setCustomAgentId("CUSTOM_ID") // Optional
                         .setLogoUrl("LOGO_URL")
                         .setEntryPointConfigs(Arrays.asList(
                           new BusinessMessagesEntryPointConfig()
                               .setAllowedEntryPoint(
                                   "ENTRY_POINT_1"),
                           new BusinessMessagesEntryPointConfig()
                               .setAllowedEntryPoint(
                                   "ENTRY_POINT_2")
                         ))
                         // Configuration options for launching on non-local entry points
                         .setNonLocalConfig(new NonLocalConfig()
                           // List of phone numbers for call deflection, values must be globally unique
                           .setCallDeflectionPhoneNumbers(Arrays.asList(new Phone().setNumber("DEFLECTION_PHONE_NUMBER_1"),
                               new Phone().setNumber("DEFLECTION_PHONE_NUMBER_2")))
                           // Contact information for the agent that displays with the messaging button
                           .setContactOption(new ContactOption().setOptions(Arrays.asList(
                               "CONTACT_OPTION_1",
                               "CONTACT_OPTION_2")
                           ).setUrl("WEBSITE_URL"))
                           // Domains enabled for messaging within Search, values must be globally unique
                           .setEnabledDomains(Arrays.asList("ENABLED_DOMAIN_1", "ENABLED_DOMAIN_2"))
                           // Agent's phone number. Overrides the `phone` field for
                           // conversations started from non-local entry points
                           .setPhoneNumber(new Phone().setNumber("CONTACT_PHONE_NUMBER"))
                           // List of regions where this agent will be available
                           .setRegionCodes(Arrays.asList("REGION_CODE")))
                         .setDefaultLocale("LOCALE")
                         // Create a map between the language code and the initial conversation settings
                         .setConversationalSettings(ImmutableMap.of("LOCALE",
                           new ConversationalSetting()
                               .setPrivacyPolicy(new PrivacyPolicy().setUrl("PRIVACY_POLICY_URL"))
                               .setWelcomeMessage(new WelcomeMessage().setText("WELCOME_MESSAGE"))
                               .setConversationStarters(Arrays.asList(
                                   new ConversationStarters().setSuggestion(new Suggestion()
                                       .setReply(new SuggestedReply().setText("SUGGESTION_TEXT").setPostbackData("SUGGESTION_POSTBACK_DATA")))
                               ))))
                         .setPrimaryAgentInteraction(new SupportedAgentInteraction()
                             .setInteractionType(InteractionType.HUMAN.toString())
                             .setHumanRepresentative(new HumanRepresentative()
                                 .setHumanMessagingAvailability(new MessagingAvailability()
                                     // Create a list of available hours
                                     .setHours(Arrays.asList(new Hours()
                                       .setStartTime(new TimeOfDay().setHours(START_TIME_HOURS).setMinutes(START_TIME_MINUTES))
                                       .setStartDay("BEGINNING_DAY_OF_WEEK")
                                       .setEndDay("END_DAY_OF_WEEK")
                                       .setEndTime(new TimeOfDay().setHours(END_TIME_HOURS).setMinutes(END_TIME_MINUTES))
                                       .setTimeZone("TIME_ZONE"))))))
   
                     ));
   
         Agent agent = request.execute();
   
         System.out.println(agent.toPrettyString());
       } catch (Exception e) {
         e.printStackTrace();
       }
     }
   }

   Kode ini didasarkan pada library klien Java Business Communications.

   Python

   """This code creates a Business Messages agent.
   
   Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/agents?method=api#create_the_agent
   
   This code is based on the https://github.com/google-business-communications/python-businessmessages
   Python Business Messages client library.
   """
   
   from oauth2client.service_account import ServiceAccountCredentials
   from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
   from businesscommunications.businesscommunications_v1_messages import (
       Agent, BusinesscommunicationsBrandsAgentsCreateRequest,
       BusinessMessagesAgent, BusinessMessagesEntryPointConfig,
       ContactOption, ConversationalSetting, ConversationStarters,
       Hours, HumanRepresentative, MessagingAvailability,
       NonLocalConfig, Phone, PrivacyPolicy, Suggestion,
       SuggestedReply, SupportedAgentInteraction,
       TimeOfDay, WelcomeMessage
   )
   
   # Edit the values below:
   BRAND_ID = 'EDIT_HERE'
   SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
   SERVICE_ACCOUNT_FILE = './service_account_key.json'
   
   credentials = ServiceAccountCredentials.from_json_keyfile_name(
       SERVICE_ACCOUNT_FILE, scopes=SCOPES)
   
   client = BusinesscommunicationsV1(credentials=credentials)
   
   agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)
   
   brand_name = 'brands/ '+ BRAND_ID
   
   agent = Agent(
       displayName='My first agent',
       businessMessagesAgent=BusinessMessagesAgent(
           customAgentId='CUSTOM_ID', # Optional
           logoUrl='https://developers.google.com/identity/images/g-logo.png',
           entryPointConfigs=[BusinessMessagesEntryPointConfig(
               allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.LOCATION
           ), BusinessMessagesEntryPointConfig(
               allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.NON_LOCAL
           )],
           nonLocalConfig=NonLocalConfig(
               # List of phone numbers for call deflection, values must be globally unique
               # Generating a random phone number for demonstration purposes
               # This should be replaced with a real brand phone number
               callDeflectionPhoneNumbers=[Phone(number='[phone]'),
                 Phone(number='[phone]')],
               # Contact information for the agent that displays with the messaging button
               contactOption=ContactOption(
                       options=[ContactOption.OptionsValueListEntryValuesEnum.EMAIL,
                           ContactOption.OptionsValueListEntryValuesEnum.PHONE],
                       url='https://www.your-company-website.com'
                   ),
               # Domains enabled for messaging within Search, values must be globally unique
               # Generating a random URL for demonstration purposes
               # This should be replaced with a real brand URL
               enabledDomains=['your-company-website.com'],
               # Agent's phone number. Overrides the `phone` field for conversations started from non-local entry points
               phoneNumber=Phone(number='[phone]'),
               # List of CLDR region codes for countries where the agent is allowed to launch `NON_LOCAL` entry points.
               # Example is for launching in Canada and the USA
               regionCodes=['US', 'CA']
           ),
           defaultLocale='en',
           conversationalSettings=BusinessMessagesAgent.ConversationalSettingsValue(
               additionalProperties=[BusinessMessagesAgent.ConversationalSettingsValue.AdditionalProperty(
                   key='en',
                   value=ConversationalSetting(
                       privacyPolicy=PrivacyPolicy(url='https://www.your-company-website.com/privacy'),
                       welcomeMessage=WelcomeMessage(text='This is a sample welcome message'),
                       conversationStarters=[
                           ConversationStarters(
                               suggestion=Suggestion(
                                   reply=SuggestedReply(text='Option 1',
                                                        postbackData='postback_option_1')
                               )
                           )
                       ]
                   )
               )]
           ),
           primaryAgentInteraction=SupportedAgentInteraction(
               interactionType=SupportedAgentInteraction.InteractionTypeValueValuesEnum.HUMAN,
               humanRepresentative=HumanRepresentative(
                   humanMessagingAvailability=MessagingAvailability(hours=[
                           Hours(
                               startTime=TimeOfDay(hours=8, minutes=30),
                               startDay=Hours.StartDayValueValuesEnum.MONDAY,
                               endDay=Hours.EndDayValueValuesEnum.SATURDAY,
                               endTime=TimeOfDay(hours=20, minutes=0),
                               timeZone='America/Los_Angeles'
                           )
                       ])
               )
           ),
       )
   )
   
   new_agent = agents_service.Create(
       BusinesscommunicationsBrandsAgentsCreateRequest(
           agent=agent,
           parent=brand_name
       )
   )
   
   print(new_agent)
   create-agent-bm.py

   Untuk opsi format dan nilai, lihat brands.agents.

3. Jika merek memiliki lokasi yang ingin Anda kaitkan dengan agen, lihat Menambahkan lokasi.

Contoh: Membuat agen untuk Bank Sumber Makmur

curl -X POST "https://businesscommunications.googleapis.com/v1/brands" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key.json businesscommunications)" \
-d "{
    'displayName': 'Growing Tree Bank'
}"

# Fetch returned brand name value of "brands/12345"

curl -X POST "https://businesscommunications.googleapis.com/v1/brands/12345/agents" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json /path/to/service/account/key.json businesscommunications)" \
-d "{
    'displayName': 'Growing Tree Bank',
    'businessMessagesAgent': {
        'logoUrl': 'https://www.growingtreebank.com/images/logo.png',
        'entryPointConfigs': [
          {
            'allowedEntryPoint': 'NON_LOCAL',
          },
          {
            'allowedEntryPoint': 'LOCATION',
          },
        ],
        'customAgentId': 'growing-tree-bank',
        'nonLocalConfig': {
            'regionCodes': ['001'],
            'contactOption': {
                'url': 'https://www.growingtreebank.com',
                'options': [
                    'EMAIL',
                    'PHONE',
                ],
            },
            'enabledDomains': [
                'https://www.growingtreebank.com',
            ],
            'phoneNumber': {
                'number': '[phone]',
            },
            'callDeflectionPhoneNumbers': [
                {
                    'number': '[phone]',
                },
                {
                    'number': '[phone]',
                },
            ],
        },
        'conversationalSettings': {
            'en': {
                'welcomeMessage': {
                    'text': 'Thanks for contacting Growing Tree Bank. What can I help with today?',
                },
                'privacyPolicy': {
                    'url': 'https://www.growingtreebank.com/privacy',
                },
                'conversationStarters': [
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Set up an account',
                                'postbackData': 'new-account',
                            },
                        },
                    },
                ],
            },
        },
        'defaultLocale': 'en',
        'primaryAgentInteraction': {
            'interactionType': 'BOT',
            'botRepresentative': {
                'botMessagingAvailability': {
                    'hours': [
                        {
                            'startTime': {
                                'hours': '8',
                                'minutes': '00',
                            },
                            'endTime': {
                                'hours': '17',
                                'minutes': '30',
                            },
                            'timeZone': 'America/Los_Angeles',
                            'startDay': 'MONDAY',
                            'endDay': 'FRIDAY',
                        },
                    ],
                },
            },
        },
    },
}"

Menyimpan informasi penting

Saat Anda membuat agen, Business Communications API akan menampilkan nilai agen, termasuk name dan testUrls.

Catatan: Simpan name di tempat yang dapat Anda akses. Anda memerlukan name untuk mengupdate, memverifikasi, atau meluncurkan agen.

Menetapkan webhook tingkat agen

Anda menerima pesan yang dikirim ke agen di webhook. Jika Anda ingin pesan untuk agen tertentu tiba di webhook yang berbeda, Anda dapat menetapkan webhook tingkat agen.

Untuk menetapkan webhook tingkat agen, gunakan Konsol Developer.

Menguji agen

Setiap agen memiliki URL pengujian yang memungkinkan Anda melihat tampilan percakapan dengan agen tersebut kepada pengguna dan memberi Anda kesempatan untuk memverifikasi infrastruktur pesan Anda.

TestUrl memiliki atribut url dan surface. Untuk menguji dengan perangkat iOS, gunakan URL pengujian dengan nilai platform SURFACE_IOS_MAPS. Membuka URL di perangkat iOS yang telah menginstal aplikasi Google Maps akan membuka percakapan yang berfungsi penuh dengan agen.

Perangkat Android memiliki dua URL pengujian. URL dengan nilai surface SURFACE_ANDROID_MAPS akan membuka percakapan di Google Maps dan mewakili titik entri percakapan yang muncul di Google Maps. URL dengan nilai surface SURFACE_ANDROID_WEB akan membuka percakapan dalam tampilan percakapan overlay dan mewakili semua titik entri lainnya.

Setelah platform percakapan terbuka, percakapan akan menyertakan semua informasi branding yang akan dilihat pengguna, dan saat Anda mengirim pesan ke agen, webhook Anda akan menerima pesan, termasuk payload JSON lengkap yang dapat Anda harapkan saat berkomunikasi dengan pengguna.

Catatan: Payload JSON dari URL pengujian agen tidak menyertakan informasi lokasi (context). Untuk menerima informasi lokasi, gunakan URL pengujian lokasi. Lihat Menguji lokasi.

Untuk membuka URL pengujian agen, ketuk link atau gunakan Peluncur Agen Business Messages di perangkat seluler.

Catatan: Jika Anda memperbarui informasi agen setelah memulai percakapan, hapus percakapan dari perangkat dan mulai percakapan baru untuk melihat informasi yang diperbarui.

Mendapatkan informasi agen

Untuk mendapatkan informasi tentang agen, seperti agentTestUrl, Anda bisa mendapatkan informasi dari Business Communications API, selama Anda memiliki nilai name agen.

Mendapatkan info untuk satu agen

Untuk mendapatkan informasi agen, jalankan perintah berikut. Ganti BRAND_ID dan AGENT_ID dengan nilai unik dari name agen.

Catatan: Nama dan ID agen harus dienkode URL. Misalnya, jika nama atau ID agen menyertakan "/", ubah "/" menjadi "%2F".

cURL

# This code gets the agent.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/get

# Replace the __BRAND_ID__ and __AGENT_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X GET \
"https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
get-agent.sh

Node.js

/**
 * This code snippet gets an agent.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/get
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const AGENT_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const agentName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
    };

    bcApi.brands.agents.get(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();
get-agent.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Agent;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      BusinessCommunications.Brands.Agents.Get request = builder
        .build().brands().agents().get(agentName);

      Agent agent = request.execute();

      System.out.println(agent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Kode ini didasarkan pada library klien Java Business Communications.

Python

"""This code gets the agent.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/get

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsGetRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
AGENT_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID

agent = agents_service.Get(BusinesscommunicationsBrandsAgentsGetRequest(
        name=agent_name
    ))

print(agent)
get-agent.py

Mencantumkan semua agen untuk merek

Jika tidak mengetahui name agen, Anda bisa mendapatkan informasi untuk semua agen yang terkait dengan merek dengan menghapus nilai AGENT_ID dari URL permintaan GET.

Catatan: Nama dan ID agen harus dienkode URL. Misalnya, jika nama atau ID agen menyertakan "/", ubah "/" menjadi "%2F".

cURL

# This code lists all agents from a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list

# Replace the __BRAND_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X GET \
"https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
list-agents.sh

Node.js

/**
 * This code snippet lists the agents of a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      parent: brandName,
    };

    bcApi.brands.agents.list(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();
list-agents.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Agent;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String brandName = "brands/BRAND_ID";

      BusinessCommunications.Brands.Agents.List request = builder
          .build().brands().agents().list(brandName);

      List agents = request.execute().getAgents();
      agents.stream().forEach(agent -> {
        try {
          System.out.println(agent.toPrettyString());
        } catch (IOException e) {
          e.printStackTrace();
        }
      });
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Kode ini didasarkan pada library klien Java Business Communications.

Python

"""This code lists all agents from a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/list

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsGetRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

brand_name = 'brands/' + BRAND_ID

agents = agents_service.List(BusinesscommunicationsBrandsAgentsListRequest(
        parent=brand_name
    ))

print(agents)
list-agents.py

Memperbarui informasi agen

Untuk memperbarui agen, Anda harus melakukan permintaan PATCH dengan Business Communications API. Saat melakukan panggilan API, Anda menyertakan nama kolom yang sedang diedit sebagai nilai untuk parameter URL "updateMask".

Misalnya, jika Anda memperbarui kolom displayName dan customAgentId, parameter URL "updateMask" adalah "updateMask=displayName,businessMessagesAgent.customAgentId".

Untuk opsi format dan nilai, lihat brands.agents.patch.

Jika Anda tidak mengetahui name agen, lihat Mencantumkan semua agen untuk merek.

Perhatian: Saat Anda memperbarui kolom, tindakan ini akan mengganti semua konten sebelumnya dari kolom tersebut. Saat memperbarui kolom berulang, Anda harus menyertakan semua pengulangan kolom dalam pembaruan. Jika tidak, Anda dapat kehilangan data. Misalnya, untuk menambahkan instance hours tambahan, Anda harus menyertakan semua pengulangan hours.

Setelah memverifikasi agen, Anda hanya dapat memperbarui kolom berikut:

• conversationalSetting

  Perhatian: Jika memperbarui kolom apa pun dalam conversationalSettings, Anda harus memperbarui semua kolom dalam objek, dan Anda harus menentukan lokalitas setelan (sebagai kode bahasa ISO 639-1 dua karakter).

• customAgentId

• defaultLocale

• primaryAgentInteraction

• additionalAgentInteractions

• phone

Jika Anda perlu memperbarui kolom lain setelah memverifikasi agen, hubungi kami. (Anda harus login terlebih dahulu dengan akun Google Business Messages. Untuk mendaftar ke akun, lihat Mendaftar dengan Message Bisnis.)

Contoh: Memperbarui nama tampilan

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=displayName" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
    'displayName': 'Growing Tree Bank',
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'displayName',
      resource: {
        displayName: 'Growing Tree Bank',
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

Kode ini didasarkan pada library klien Business Communications Node.js.

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.Agent;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      Agent agent = new Agent().setDisplayName("Growing Tree Bank");

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("displayName");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Kode ini didasarkan pada library klien Java Business Communications.

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
          displayName='Growing Tree Bank'
      )

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='displayName'
        )
    )

print(updated_agent)

Kode ini didasarkan pada library klien Business Communications Python.

Contoh: Menentukan grup titik entri NON_LOCAL dan LOCATION

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.entryPointConfigs" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
  'businessMessagesAgent': {
    'entryPointConfigs': [
      {
        'allowedEntryPoint': 'NON_LOCAL',
      },
      {
        'allowedEntryPoint': 'LOCATION',
      },
    ],
  },
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'businessMessagesAgent.entryPointConfigs',
      resource: {
        businessMessagesAgent: {
          entryPointConfigs: [
            {
              allowedEntryPoint: 'LOCATION',
            },
            {
              allowedEntryPoint: 'NON_LOCAL',
            },
          ],
        }
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

Kode ini didasarkan pada library klien Business Communications Node.js.

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      Agent agent = new Agent().setBusinessMessagesAgent(
          new BusinessMessagesAgent().setEntryPointConfigs(Arrays.asList(
              new BusinessMessagesEntryPointConfig()
                  .setAllowedEntryPoint(
                      "NON_LOCAL"),
              new BusinessMessagesEntryPointConfig()
                  .setAllowedEntryPoint(
                      "LOCATION"))));

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("businessMessagesAgent.entryPointConfigs");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Kode ini didasarkan pada library klien Java Business Communications.

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinessMessagesAgent,
    BusinessMessagesEntryPointConfig,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
    businessMessagesAgent=BusinessMessagesAgent(
        entryPointConfigs=[BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.NON_LOCAL
        ), BusinessMessagesEntryPointConfig(
            allowedEntryPoint=BusinessMessagesEntryPointConfig.AllowedEntryPointValueValuesEnum.LOCATION
        )]
    )
)

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='businessMessagesAgent.entryPointConfigs'
        )
    )

print(updated_agent)

Kode ini didasarkan pada library klien Business Communications Python.

Contoh: Memperbarui pesan selamat datang

Jika memperbarui kolom apa pun dalam conversationalSettings—seperti welcomeMessage—Anda harus memperbarui semua kolom dalam objek, dan Anda harus menentukan lokalitas setelan (sebagai kode bahasa ISO 639-1 dua karakter).

Catatan: Mungkin perlu waktu hingga dua jam agar setelan percakapan baru muncul dalam percakapan dengan agen Anda.

cURL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.conversationalSettings.en" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
    'businessMessagesAgent': {
        'conversationalSettings': {
            'en': {
                'welcomeMessage': {
                    'text': 'Thanks for contacting Growing Tree Bank. What can I help with today?',
                },
                'offlineMessage': {
                    'text': 'We\'re closed for the night. Please reach out to us again tomorrow.',
                },
                'privacyPolicy': {
                    'url': 'https://www.growingtreebank.com/privacy',
                },
                'conversationStarters': [
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Set up an account',
                                'postbackData': 'new-account',
                            },
                        },
                    },
                    {
                        'suggestion': {
                            'reply': {
                                'text': 'Look up account information',
                                'postbackData': 'account-lookup',
                            },
                        },
                    },
                ],
            },
        },
    },
}"

Node.js

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
let bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require('PATH_TO_SERVICE_ACCOUNT_KEY');

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
async function initCredentials() {
  // Configure a JWT auth client
  let authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

async function main() {
  let authClient = await initCredentials();

  let agentName = 'brands/BRAND_ID/agents/AGENT_ID';

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
      updateMask: 'businessMessagesAgent.conversationalSettings.en',
      resource: {
        businessMessagesAgent: {
          conversationalSettings: {
            en: {
              privacyPolicy: { url: 'https://www.growingtreebank.com/privacy' },
              welcomeMessage: { text: 'Thanks for contacting Growing Tree Bank. What can I help with today?' },
              offlineMessage: { text: 'We\'re closed for the night. Please reach out to us again tomorrow.' },
              conversationStarters: [
                {
                  suggestion: {
                    reply: {
                      text: 'Set up an account',
                      postbackData: 'new-account',
                    },
                  },
                },
                {
                  suggestion: {
                    reply: {
                      text: 'Look up account information',
                      postbackData: 'account-lookup',
                    },
                  },
                },
              ],
            },
          }
        }
      }
    };

    bcApi.brands.agents.patch(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent found
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

main();

Kode ini didasarkan pada library klien Business Communications Node.js.

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import com.google.common.collect.ImmutableMap;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      Agent agent = new Agent().setBusinessMessagesAgent(
          new BusinessMessagesAgent().setConversationalSettings(ImmutableMap.of("en",
              new ConversationalSetting()
                  .setPrivacyPolicy(new PrivacyPolicy().setUrl("https://www.growingtreebank.com/privacy"))
                  .setWelcomeMessage(new WelcomeMessage().setText("Thanks for contacting Growing Tree Bank. What can I help with today?"))
                  .setOfflineMessage(new OfflineMessage().setText("We're closed for the night. Please reach out to us again tomorrow."))
                  .setConversationStarters(Arrays.asList(
                      new ConversationStarters().setSuggestion(new Suggestion()
                          .setReply(new SuggestedReply()
                              .setText("Set up an account")
                              .setPostbackData("new-account"))),
                      new ConversationStarters().setSuggestion(new Suggestion()
                          .setReply(new SuggestedReply()
                              .setText("Look up account information")
                              .setPostbackData("account-lookup")))
                      )))));

      BusinessCommunications.Brands.Agents.Patch request = builder
          .build().brands().agents().patch(agentName, agent);

      request.setUpdateMask("businessMessagesAgent.conversationalSettings.en");

      Agent updatedAgent = request.execute();
      System.out.println(updatedAgent.toPrettyString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Kode ini didasarkan pada library klien Java Business Communications.

Python

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import (
    BusinesscommunicationsV1
)
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinessMessagesAgent,
    ConversationStarters,
    ConversationalSetting,
    OfflineMessage,
    PrivacyPolicy,
    WelcomeMessage,
    BusinesscommunicationsBrandsAgentsPatchRequest,
)

SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = 'PATH_TO_SERVICE_ACCOUNT_KEY'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/BRAND_ID/agents/AGENT_ID'

agent=Agent(
		businessMessagesAgent=BusinessMessagesAgent(
		  	conversationalSettings=BusinessMessagesAgent.ConversationalSettingsValue(
		        additionalProperties=[BusinessMessagesAgent.ConversationalSettingsValue.AdditionalProperty(
		            key='en',
		            value=ConversationalSetting(
		                privacyPolicy=PrivacyPolicy(url='https://www.growingtreebank.com/privacy'),
		                welcomeMessage=WelcomeMessage(text='Thanks for contacting Growing Tree Bank. What can I help with today?'),
		                offlineMessage=OfflineMessage(text='We\'re closed for the night. Please reach out to us again tomorrow.'),
		                conversationStarters=[
		                    ConversationStarters(
		                        suggestion=Suggestion(
		                            reply=SuggestedReply(text='Set up an account',
		                                postbackData='new-account')
		                        )
		                    ),
		                    ConversationStarters(
		                        suggestion=Suggestion(
		                            reply=SuggestedReply(text='Look up account information',
		                                postbackData='account-lookup')
		                        )
		                    )]
		                )
		            )
		        ]
		    )
		)
)

updated_agent = agents_service.Patch(
        BusinesscommunicationsBrandsAgentsPatchRequest(
            agent=agent,
            name=agent_name,
            updateMask='businessMessagesAgent.conversationalSettings.en'
        )
    )

print(updated_agent)

Kode ini didasarkan pada library klien Business Communications Python.

Menghapus agen

Saat Anda menghapus agen, Business Messages akan menghapus semua data agen. Message Bisnis tidak menghapus pesan yang dikirim oleh agen Anda yang sedang dalam pengiriman ke atau disimpan di perangkat pengguna. Pesan kepada pengguna bukan data agen.

Permintaan penghapusan gagal jika agen memiliki lokasi terkait atau jika Anda telah mencoba memverifikasi agen satu atau beberapa kali. Untuk memperbarui lokasi, lihat Menambahkan lokasi.

Anda tidak dapat menghapus agen yang terverifikasi. Untuk menghapus agen yang telah Anda verifikasi atau coba verifikasi, hubungi kami. (Anda harus login terlebih dahulu dengan akun Google Business Messages. Untuk mendaftar ke akun, lihat Mendaftar dengan Message Bisnis.)

Peringatan: Menghapus agen akan menghapus semua informasi tentang agen tersebut dari Business Messages secara permanen.

Untuk menghapus agen, jalankan perintah berikut. Ganti BRAND_ID dan AGENT_ID dengan nilai unik dari name agen.

cURL

# This code deletes an agent.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete

# Replace the __BRAND_ID__ and __AGENT_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X DELETE "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__/agents/__AGENT_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
delete-agent.sh

Node.js

/**
 * This code snippet deletes an agent.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const AGENT_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const agentName = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: agentName,
    };

    bcApi.brands.agents.delete(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Agent removed
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();
delete-agent.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String agentName = "brands/BRAND_ID/agents/AGENT_ID";

      BusinessCommunications.Brands.Agents.Delete request
         = builder.build().brands().agents().delete(agentName);

      System.out.println(request.execute());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Kode ini didasarkan pada library klien Java Business Communications.

Python

"""This code deletes an agent.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands.agents/delete

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    Agent,
    BusinesscommunicationsBrandsAgentsDeleteRequest,
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
AGENT_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

agent_name = 'brands/' + BRAND_ID + '/agents/' + AGENT_ID

agent = agents_service.Delete(BusinesscommunicationsBrandsAgentsDeleteRequest(
        name=agent_name
    ))

print(agent)
delete-agent.py

Untuk opsi format dan nilai, lihat brands.agents.delete.

Menghapus merek

Saat menghapus merek, Anda akan melakukan permintaan DELETE dengan Business Communications API. Permintaan penghapusan akan gagal jika Anda memiliki satu atau beberapa agen atau lokasi yang terkait dengan merek, meskipun agen tersebut termasuk dalam produk yang berbeda.

Peringatan: Menghapus merek akan menghapus semua informasi tentang merek tersebut secara permanen. Parameter ?force=true juga menghapus semua agen terkait (di semua produk) dan lokasi.

Untuk menghapus merek, jalankan perintah berikut. Ganti BRAND_ID dengan nilai unik dari name merek.

cURL

# This code deletes a brand.
# Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete

# Replace the __BRAND_ID__
# Make sure a service account key file exists at ./service_account_key.json

curl -X DELETE "https://businesscommunications.googleapis.com/v1/brands/__BRAND_ID__" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json ./service_account_key.json businesscommunications)"
delete-brand.sh

Node.js

/**
 * This code snippet deletes a brand.
 * Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businesscommunications Node.js
 * Business Communications client library.
 */

/**
 * Edit the values below:
 */
const BRAND_ID = 'EDIT_HERE';
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';

const businesscommunications = require('businesscommunications');
const {google} = require('googleapis');

// Initialize the Business Communications API
const bcApi = new businesscommunications.businesscommunications_v1.Businesscommunications({});

// Set the scope that we need for the Business Communications API
const scopes = [
  'https://www.googleapis.com/auth/businesscommunications',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

async function main() {
  const authClient = await initCredentials();

  const brandName = 'brands/' + BRAND_ID;

  if (authClient) {
    // Setup the parameters for the API call
    const apiParams = {
      auth: authClient,
      name: brandName,
    };

    bcApi.brands.delete(apiParams, {}, (err, response) => {
      if (err !== undefined && err !== null) {
        console.dir(err);
      } else {
        // Brand removed
        console.log(response.data);
      }
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // Configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // Authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

main();
delete-brand.js

Java

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.jackson2.JacksonFactory;
import com.google.api.services.businesscommunications.v1.BusinessCommunications;
import com.google.api.services.businesscommunications.v1.model.*;
import java.io.FileInputStream;
import java.util.Arrays;

class Main {
  /**
   * Initializes credentials used by the Business Communications API.
   */
  private static BusinessCommunications.Builder getBusinessCommunicationsBuilder() {
    BusinessCommunications.Builder builder = null;
    try {
      GoogleCredential credential = GoogleCredential
            .fromStream(new FileInputStream("PATH_TO_SERVICE_ACCOUNT_KEY"));

      credential = credential.createScoped(Arrays.asList(
          "https://www.googleapis.com/auth/businesscommunications"));

      credential.refreshToken();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      JacksonFactory jsonFactory = JacksonFactory.getDefaultInstance();

      // Create instance of the Business Communications API
      builder = new BusinessCommunications
          .Builder(httpTransport, jsonFactory, null)
          .setApplicationName(credential.getServiceAccountProjectId());

      // Set the API credentials and endpoint
      builder.setHttpRequestInitializer(credential);
    } catch (Exception e) {
      e.printStackTrace();
    }

    return builder;
  }

  public static void main(String args[]) {
    try {
      // Create client library reference
      BusinessCommunications.Builder builder = getBusinessCommunicationsBuilder();

      String brandName = "brands/BRAND_ID";

      BusinessCommunications.Brands.Delete request = builder.build().brands().delete(brandName);

      System.out.println(request.execute());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Kode ini didasarkan pada library klien Java Business Communications.

Python

"""This code deletes a brand.

Read more: https://developers.google.com/business-communications/business-messages/reference/business-communications/rest/v1/brands/delete

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

from oauth2client.service_account import ServiceAccountCredentials
from businesscommunications.businesscommunications_v1_client import BusinesscommunicationsV1
from businesscommunications.businesscommunications_v1_messages import (
    BusinesscommunicationsBrandsAgentsDeleteRequest
)

# Edit the values below:
BRAND_ID = 'EDIT_HERE'
SCOPES = ['https://www.googleapis.com/auth/businesscommunications']
SERVICE_ACCOUNT_FILE = './service_account_key.json'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    SERVICE_ACCOUNT_FILE, scopes=SCOPES)

client = BusinesscommunicationsV1(credentials=credentials)

agents_service = BusinesscommunicationsV1.BrandsAgentsService(client)

brand_name = 'brands/' + BRAND_ID

agent = agents_service.Delete(BusinesscommunicationsBrandsAgentsDeleteRequest(
        name=brand_name
    ))

print(agent)
delete-brand.py

Untuk opsi format dan nilai, lihat brands.delete.

Langkah berikutnya

Setelah memiliki agen, Anda dapat melakukan langkah-langkah berikut:

• Menambahkan lokasi ke agen Anda
• Mendesain pengalaman percakapan
• Mengembangkan alur pesan