RecaptchaEnterpriseServiceV1Beta1Client

RecaptchaEnterpriseServiceV1Beta1Client

Service to determine the likelihood an event is legitimate.

Constructor

new RecaptchaEnterpriseServiceV1Beta1Client(optionsopt)

Construct an instance of RecaptchaEnterpriseServiceV1Beta1Client.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
promise function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Source:

(static) port

The port for this API service.

Source:

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

annotateAssessment(request, optionsopt, callbackopt) → {Promise}

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".
annotation number

The annotation that will be assigned to the Event.

The number should be among the values of Annotation
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AnnotateAssessmentResponse.
Source:
Example
const recaptchaenterprise = require('@google-cloud/recaptchaenterprise');

const client = new recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1Client({
  // optional auth parameters.
});

const formattedName = client.assessmentPath('[PROJECT]', '[ASSESSMENT]');
const annotation = 'ANNOTATION_UNSPECIFIED';
const request = {
  name: formattedName,
  annotation: annotation,
};
client.annotateAssessment(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

assessmentPath(project, assessment) → {String}

Return a fully-qualified assessment resource name string.

Parameters:
Name Type Description
project String
assessment String
Source:

createAssessment(request, optionsopt, callbackopt) → {Promise}

Creates an Assessment of the likelihood an event is legitimate.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the project in which the assessment will be created, in the format "projects/{project_number}".
assessment Object

The asessment details.

This object should have the same structure as Assessment
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Assessment.
Source:
Example
const recaptchaenterprise = require('@google-cloud/recaptchaenterprise');

const client = new recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1Client({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
const assessment = {};
const request = {
  parent: formattedParent,
  assessment: assessment,
};
client.createAssessment(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

matchAssessmentFromAssessmentName(assessmentName) → {String}

Parse the assessmentName from a assessment resource.

Parameters:
Name Type Description
assessmentName String

A fully-qualified path representing a assessment resources.
Source:

matchProjectFromAssessmentName(assessmentName) → {String}

Parse the assessmentName from a assessment resource.

Parameters:
Name Type Description
assessmentName String

A fully-qualified path representing a assessment resources.
Source:

matchProjectFromProjectName(projectName) → {String}

Parse the projectName from a project resource.

Parameters:
Name Type Description
projectName String

A fully-qualified path representing a project resources.
Source:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source: