@google-cloud/phishing-protection

Phishing Protection: Node.js Client

Phishing Protection API client for Node.js

• Phishing Protection Node.js Client API Reference
• Phishing Protection Documentation
• github.com/googleapis/nodejs-phishing-protection

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

• Select or create a Cloud Platform project.
• Enable billing for your project.
• Enable the Phishing Protection API.
• Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/phishing-protection

Using the client library

  const {
    PhishingProtectionServiceV1Beta1Client,
  } = require('@google-cloud/phishing-protection');
  const client = new PhishingProtectionServiceV1Beta1Client();

  // the numeric project ID.
  const formattedParent = client.projectPath(projectId);
  const request = {
    parent: formattedParent,
    uri: uri, // the URI to report to Phishing API.
  };

  await client.reportPhishing(request);

  console.info(`reported ${uri} to Phishing Protection API`);

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample	Source Code	Try it
Quickstart	source code

The Phishing Protection Node.js Client API Reference documentation also contains samples.

Versioning

This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE