إنشاء وكلاء لإدارة العلامات التجارية

بعد التسجيل كشريك، يمكنك تفعيل المحادثات للعلامات التجارية التي تديرها من خلال إنشاء وكلاء لها في ميزة "الرسائل التجارية".

الوكيل هو كيان حواري يتفاعل معه المستخدمون. يمكنك إنشاء وكيل واحد لكل علامة تجارية تديرها. يمكنك إنشاء الوكلاء وإدارتهم باستخدام Business Communications API، ويمكنك التحكّم في الرسائل الموجّهة للوكلاء من خلال Business Messages API.

يشمل الوكيل وظائف أعمال العلامة التجارية، مثل الدعم على الإنترنت، والمواقع الجغرافية (إن وجدت). تحتوي كل رسالة على السياق الذي بدأ منه المستخدم المحادثة. يمكن للبنية الأساسية لتوجيه الرسائل اكتشاف ما إذا كان المستخدم شاهد موقعًا محددًا لنشاط تجاري أو بحث عن دعم عام، ويمكنها توجيه الرسائل إلى الوجهة الصحيحة.

علاقة الوكيل والعلامة التجارية

على سبيل المثال، إذا كنت تدير العلامة التجارية لبنك Growing Tree Bank والتي لها موقع إلكتروني وموقعَين جغرافيَين، يمكنك إنشاء وكيل واحد باسم "Growing Tree Bank". يمكن للمستخدمين لقاء الوكيل من خلال عمليات بحث عامة أو مستندة إلى الموقع الجغرافي، والسياق الذي عثر فيه المستخدم على الوكيل، ويتم تمريره مع كل رسالة إلى الرد التلقائي على الويب. يمكنك استخدام هذا السياق لتوجيه الرسالة إما إلى الموظفين في موقع ما أو إلى فريق دعم موقع الويب، الذي ينشئ ردًا ويواصل المحادثة مع المستخدم.

التوقّعات

قبل إنشاء وكيل، عليك فهم توقعات موظّفي الدعم بشأن تطبيق "الرسائل التجارية".

إنشاء وكيل

لإنشاء وكيل، عليك جمع معلومات عن العلامة التجارية وإرسالها وطريقة ظهوره للمستخدمين.

إذا كنت تدير عدّة علامات تجارية، كرِّر الخطوات لإنشاء وكيل لكل علامة تجارية.

المتطلبات الأساسية

قبل إنشاء وكلاء للعلامات التجارية التي تديرها، عليك جمع بعض المعلومات:

البيئة التطويرية

معلومات حول بيئة التطوير.

تفاصيل العلامة التجارية

معلومات عن العلامة التجارية التي يمثّلها الوكيل.

  • اسم العلامة التجارية
  • الموقع الإلكتروني للعلامة التجارية
  • خيارات التواصل على الموقع الإلكتروني (على النحو المحدّد في OPTION)
  • رقم الهاتف الموجّه للمستهلك
  • تم تفعيل أرقام الهواتف لتحويل المكالمة

مظهر الوكيل والسياسات

معلومات عن طريقة ظهور الوكيل للمستخدمين وآلية عمله.

  • اسم الوكيل، كما تريده أن يظهر في المحادثات مع المستخدمين
  • سياسة الخصوصية، كعنوان URL متاح للجميع يبدأ بـ "https://"

  • (يُنصح به) شعار الوكيل (1024x1024 بكسل)، كعنوان URL متاح للجميع

    في المحادثة، تُعرَض الشعارات على شكل دوائر قطرها 1024 بكسل. احرص على عرض شعارك بشكل دائرة.

  • (اختياري) معرّف الوكيل المخصّص الذي يحدّد العلامة التجارية في الرسائل التي يتلقّاها الردّ التلقائي على الويب

تفاعل الوكيل

معلومات عن كيفية تفاعل وكيلك مع المستخدمين.

  • تشير هذه السمة إلى اللغة التي يعمل بها وكيلك عادةً، ويتم تحديدها باستخدام رمز لغة مؤلف من حرفَين بتنسيق ISO 639-1.

  • رسالة ترحيب بموظّف الدعم

    ما الذي يقوله الوكيل للترحيب بالمستخدمين؟

  • إجراءات بدء المحادثة مع موظّفي الدعم

    قائمة اقتراحات في شكل شرائح محادثات (على النحو المحدّد في SuggestedReply) لكي يتفاعل المستخدم مع الوكيل

    • النص المعروض للمستخدم في الشريحة
    • بيانات الإبلاغ عن الإحالات الناجحة، السلسلة التي تم إرسالها مرة أخرى إلى الرد التلقائي على الويب في حمولة الرسالة إذا نقر المستخدم على الشريحة

  • مُدد الدردشة المباشرة والتلقائية

    • وقت البدء اليومي، ككائن TimeOfDay

      على سبيل المثال، 8:15 صباحًا

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

    • وقت الانتهاء اليومي، ككائن TimeOfDay

      على سبيل المثال، 7:30 مساءً هي

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

    • يوم البدء، اليوم الأول من الأسبوع الذي يكون فيه موظّف الدعم متاحًا للدردشة (على النحو المحدّد في DayOfWeek)

    • يوم الانتهاء، آخر يوم من الأسبوع يمكن فيه التواصل مع موظّف الدعم (على النحو المحدّد في DayOfWeek)

    • المنطقة الزمنية التي يعمل فيها الوكيل (كما هو محدد في قاعدة بيانات المناطق الزمنية الصادرة عن IANA، على سبيل المثال "America/Los_Angeles")

نقاط دخول موظّفي الدعم

معلومات عن المكان الذي يمكن للمستخدمين فيه بدء محادثات مع الوكيل.

  • نقاط دخول الوكلاء المسموح بها، والتي يمكن للمستخدمين من خلالها بدء المحادثات مع موظّفي الدعم (NON_LOCAL و/أو LOCATION)

معلومات عن نقاط الدخول NON_LOCAL (لا تنطبق على نقطة دخول "إعلانات Google").

  • المناطق المسموح لها (مثل رموز CLDR للمناطق)، بحظر الوصول الإقليمي إلى نقاط دخول NON_LOCAL.

    وبصرف النظر عن المنطقة، يمكن أن يكون للوكيل رقم هاتف واحد فقط. وإذا كنت بحاجة إلى رقم هاتف مختلف حسب المنطقة، فيجب إنشاء وكيل مختلف لكل منطقة.

    لتفعيل نقاط إدخال NON_LOCAL في جميع المناطق المتاحة، استخدِم 001 كرمز للمنطقة العالمية.

تثبيت oauth2l واختباره

تستخدم جميع طلبات curl في وثائق هذا الموقع الإلكتروني oauth2l للمصادقة. إذا أردت استخدام سطر الأوامر للاتصال بواجهات برمجة تطبيقات "اتصالات الأعمال" و"الرسائل التجارية"، عليك تثبيت oauth2l.

لتثبيت oauth2l مع بايثون 3،

  1. نزِّل oauth2l.

  2. غيِّر الدليل إلى "./oauth2l/python".

  3. ثبِّت oauth2l باستخدام الأمر التالي.

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

  4. تحقَّق من أنّ oauth2l يمكنه إنشاء رمز تفويض مميز.

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

  5. تحقَّق من أنّ المخرجات تنشئ رمز تفويض مميزًا للنموذج:

    Authorization: Bearer AUTHORIZATION_BEARER_TOKEN

هناك طرق أخرى لتثبيت oauth2l لأنظمة التشغيل المختلفة. بصرف النظر عن طريقة التثبيت التي تستخدمها، تأكّد من أنّه بإمكانك إنشاء رمز مميز للتفويض استنادًا إلى بيانات اعتماد JSON لحساب الخدمة قبل المتابعة.

إنشاء الوكيل

بعد الانتهاء من جمع المعلومات، يحين وقت إنشاء وكيلك.

  1. أنشِئ العلامة التجارية التي يمثّلها الوكيل. إذا كانت العلامة التجارية متوفّرة مسبقًا، احصل على name الخاص بالعلامة التجارية وانتقِل إلى الخطوة التالية.

    شغِّل الأمر التالي في وحدة طرفية:

    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();
    }
  }
}
    يستند هذا الرمز إلى مكتبة عملاء 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

    يمكنك تخزين قيمة name التي تعرضها واجهة برمجة التطبيقات. ستحتاج إليها لإجراء تحديثات أو إنشاء وكلاء.

    لتعديل العلامات التجارية أو البحث عنها، اطّلِع على brands.

  2. أنشِئ الوكيل. استبدِل BRAND_ID بجزء قيمة name للعلامة التجارية الذي يلي "brands/". على سبيل المثال، إذا كان name هو "brands/12345"، يكون رقم تعريف العلامة التجارية هو "12345".

    شغِّل الأمر التالي في وحدة طرفية:

    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": "+10000000000"
      },
      "callDeflectionPhoneNumbers": [
        {
          "number": "+10000000000"
        },
        {
          "number": "+10000000000"
        }
      ]
    },
    "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: '+10000000000' },
            { number: '+10000000001' },
          ],
          // 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: '+10000000000' },
          // 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();
    }
  }
}
    يستند هذا الرمز إلى مكتبة عملاء 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='+10000000000'),
              Phone(number='+10000000001')],
            # 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='+10000000000'),
            # 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

    للتعرّف على خيارات التنسيق والقيمة، يُرجى الاطّلاع على القسم brands.agents.

  3. إذا كانت العلامة التجارية تمتلك مواقع جغرافية تريد ربطها بوكيلك، يمكنك مراجعة إضافة مواقع جغرافية.

مثال: إنشاء وكيل لمصرف Growing Tree Bank

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': '+12223334444',
            },
            'callDeflectionPhoneNumbers': [
                {
                    'number': '+12223334444',
                },
                {
                    'number': '+56667778888',
                },
            ],
        },
        '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',
                        },
                    ],
                },
            },
        },
    },
}"

تخزين معلومات مهمة

عند إنشاء وكيل، تعرض Business Communications API قيم الوكيل، بما في ذلك name وtestUrls.

ضبط ردّ تلقائي على الويب على مستوى الوكيل

ستتلقّى الرسائل المُرسَلة إلى وكيلك عند الرد التلقائي على الويب. إذا كنت تريد أن تصل الرسائل لوكيل معيّن إلى ردّ تلقائي على الويب مختلف بدلاً من ذلك، يمكنك ضبط ردّ تلقائي على الويب على مستوى الوكيل.

لضبط ردّ تلقائي على الويب على مستوى الوكيل، استخدِم وحدة تحكّم المطوّرين.

اختبار موظّف دعم

لدى كل وكيل عناوين URL تجريبية تتيح لك معرفة كيفية ظهور المحادثة مع ذلك الوكيل للمستخدمين وتمنحك فرصة التحقّق من البنية الأساسية للمراسلة.

يشمل TestUrl السمتَين url وsurface. لإجراء الاختبار على جهاز iOS، استخدِم عنوان URL الخاص بالاختبار مع القيمة السطحية SURFACE_IOS_MAPS. ويؤدي فتح عنوان URL على جهاز iOS مثبّت عليه تطبيق "خرائط Google" إلى فتح محادثة كاملة مع الوكيل.

تتضمّن أجهزة Android عنوانَي URL تجريبيَّين. تمثّل هذه السمة عناوين URL التي تبلغ قيمتها surface SURFACE_ANDROID_MAPS للمحادثات المفتوحة في "خرائط Google" وتمثِّل نقاط الدخول إلى المحادثات التي تظهر في "خرائط Google". عناوين URL التي تحتوي على قيمة surface تبلغ SURFACE_ANDROID_WEB من المحادثات المفتوحة في عرض محادثة متراكبة وتمثل جميع نقاط الدخول الأخرى.

بعد فتح مساحة للمحادثة، تتضمّن المحادثة جميع معلومات العلامة التجارية التي سيراها المستخدمون، وعندما ترسل رسالة إلى الوكيل، يتلقّى الرد التلقائي على الويب الرسالة، بما في ذلك حمولة JSON الكاملة التي يمكنك توقّعها عند التواصل مع المستخدمين.

لفتح عنوان URL التجريبي للوكيل، انقر على أحد الروابط أو استخدِم مشغّل شبكة الجوّال في ميزة "الرسائل التجارية" على جهاز جوّال.

الحصول على معلومات الوكيل

للحصول على معلومات عن وكيل، مثل agentTestUrl، يمكنك الحصول على المعلومات من Business Communications API، ما دامت لديك قيمة name للوكيل.

الحصول على معلومات عن موظّف دعم واحد

للحصول على معلومات الوكيل، شغِّل الأمر التالي. استبدِل BRAND_ID وAGENT_ID بالقيم الفريدة من name للوكيل.

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();
    }
  }
}
يستند هذا الرمز إلى مكتبة عملاء 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

إدراج جميع الوكلاء لعلامة تجارية معيّنة

إذا كنت لا تعرف name الخاص بالوكيل، يمكنك الحصول على معلومات عن جميع الوكلاء المرتبطين بعلامة تجارية من خلال حذف القيمة AGENT_ID من عنوان URL لطلب GET.

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();
    }
  }
}
يستند هذا الرمز إلى مكتبة عملاء 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

تعديل معلومات الوكيل

لتحديث وكيل، يمكنك تنفيذ طلب تصحيح باستخدام واجهة برمجة تطبيقات اتصالات الأعمال. عند إجراء طلب بيانات من واجهة برمجة التطبيقات، يتم تضمين أسماء الحقول التي يتم تعديلها كقيم لمَعلمة عنوان URL "updateMask".

على سبيل المثال، إذا حدّثت الحقلين displayName وcustomAgentId، ستكون معلمة عنوان URL "updateMask" هي "updateMask=displayName,businessMessagesAgent.customAgentId".

للتعرّف على خيارات التنسيق والقيمة، يُرجى الاطّلاع على القسم brands.agents.patch.

إذا كنت لا تعرف name للوكيل، يمكنك الاطّلاع على إدراج جميع الوكلاء لعلامة تجارية.

بعد التحقّق من الوكيل، يمكنك فقط تعديل الحقول التالية:

  • conversationalSetting

  • customAgentId

  • defaultLocale

  • primaryAgentInteraction

  • additionalAgentInteractions

  • phone

إذا كنت بحاجة إلى تعديل حقول أخرى بعد التأكّد من صحة معلومات الوكيل، يمكنك تواصَل معنا. (يجب أولاً تسجيل الدخول باستخدام حساب "الرسائل التجارية" على Google. للتسجيل للحصول على حساب، يُرجى الاطّلاع على التسجيل باستخدام ميزة "الرسائل التجارية".)

مثال: تعديل الاسم المعروض

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();
يستند هذا الرمز إلى مكتبة عملاء Node.js Business Communications.

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();
    }
  }
}
يستند هذا الرمز إلى مكتبة عملاء 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)
يستند هذا الرمز إلى مكتبة عملاء Python Business Communications.

مثال: تحديد مجموعتَي نقاط دخول "NON_LOCAL" و"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();
يستند هذا الرمز إلى مكتبة عملاء Node.js Business Communications.

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();
    }
  }
}
يستند هذا الرمز إلى مكتبة عملاء 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)
يستند هذا الرمز إلى مكتبة عملاء Python Business Communications.

مثال: تعديل رسالة الترحيب

في حال تعديل أي حقل ضمن conversationalSettings، مثل welcomeMessage، يجب تعديل جميع الحقول داخل العنصر، ويجب تحديد اللغة للإعدادات (كرمز لغة ISO 639-1 مكوّن من حرفَين).

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();
يستند هذا الرمز إلى مكتبة عملاء Node.js Business Communications.

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();
    }
  }
}
يستند هذا الرمز إلى مكتبة عملاء 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)
يستند هذا الرمز إلى مكتبة عملاء Python Business Communications.

حذف وكيل

عند حذف وكيل، تحذف ميزة "الرسائل التجارية" جميع بيانات الوكيل. الأعمال لا يحذف تطبيق "الرسائل" الرسائل المُرسَلة من وكيلك أثناء نقلها إلى جهاز المستخدم أو تخزينه عليه. ولا تشكّل الرسائل الموجَّهة إلى المستخدمين بيانات وكلاء.

يتعذّر حذف الطلبات إذا كان للوكيل موقع جغرافي مرتبط به أو إذا حاولت التحقّق من الوكيل مرة واحدة أو أكثر. لتعديل المواقع الجغرافية، راجع إضافة المواقع الجغرافية.

لا يمكنك حذف وكيل تم التحقّق من هويته وأهليته. لحذف وكيل أثبتّ ملكيته أو حاولت إثبات ملكيته، تواصَل معنا. (يجب أولاً تسجيل الدخول باستخدام حساب "الرسائل التجارية" على Google. للتسجيل للحصول على حساب، يُرجى الاطّلاع على التسجيل باستخدام ميزة "الرسائل التجارية".)

لحذف وكيل، شغِّل الأمر التالي. استبدِل BRAND_ID وAGENT_ID بالقيم الفريدة من name للوكيل.

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();
    }
  }
}
يستند هذا الرمز إلى مكتبة عملاء 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

للتعرّف على خيارات التنسيق والقيمة، يُرجى الاطّلاع على القسم brands.agents.delete.

حذف علامة تجارية

عندما تحذف علامة تجارية، يمكنك تنفيذ طلب "حذف" باستخدام Business Communications API. يتعذّر حذف طلبات الحذف إذا كان لديك وكيل واحد أو أكثر أو موقع جغرافي مرتبط بالعلامة التجارية، حتى إذا كان هؤلاء موظّفو الدعم ينتمون إلى منتج مختلف.

لحذف علامة تجارية، نفِّذ الأمر التالي. استبدِل BRAND_ID بالقيمة الفريدة من name للعلامة التجارية.

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();
    }
  }
}
يستند هذا الرمز إلى مكتبة عملاء 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

للتعرّف على خيارات التنسيق والقيمة، يُرجى الاطّلاع على القسم brands.delete.

الخطوات التالية

بعد أن أصبح لديك وكيل، يمكنك اتّخاذ الخطوات التالية: