techdivision/jobs-googleapi

There is no license information available for the latest version (v2.0.0-beta4) of this package.

Package to send updated or deleted JobPostings to the Google Indexer API

Maintainers

Details

github.com/techdivision/jobs-googleapi

Source

Issues

Installs: 19

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 17

Forks: 0

Open Issues: 0

Type:neos-plugin

v2.0.0-beta4 2021-10-07 12:55 UTC

Requires

Suggests

Unknown License b21cf361691f5f107b463176cb4dd9200a1f3251

This package is auto-updated.

Last update: 2024-04-07 17:57:17 UTC

README

This package is in beta status
It does work from a technical point of view, but there might be a lot of edge cases with the google crawler.
We are happy if you can provide feedback from real world scenarios. Send them to neos@techdivision.com.
Thank you very much!

With Jobs you can access the google indexing API - currently the only valid use of the indexing API.
Please be aware that this consumes your site's crawling budget, so use with care!

In order for this to work, we added

  • a backend module to send your new/changed jobs to the api
    (one could make this automatic, but this is kinda dangerous because each little publish would send it to the API and eat up your crawling budget)
  • a feature flag for automatic API calls on job deletion
    (which in turn is disabled by default for the same reason)

In addition, deleted jobs need to send at least a 404 header.
If you are serious about jobs, please install neos/redirecthandler-neosadapter to send a proper 410 status code after job deletion.

This package is based on flowpack/googleapiclient.
Please follow the package instructions on how to setup your api key.

Installation

TechDivision.Jobs.GoogleApi is available via packagist. Add "techdivision/jobs-googleapi" : "1.0.*@dev" to the require section of the composer.json or run composer require techdivision/jobs-googleapi:1.0.*@dev.

The backend module

Backend module

Configuration

Enable the API call on deletion:

TechDivision:
  Jobs:
    GoogleApi:
      options:
        enableApiCallOnJobDeletion: false
        ...

After configuration there are a few things you need to do, if you haven't done them already: Prerequisites for the Indexing API

####Important: After creating the project and a new service account you need to verify the site ownership! Follow these steps to verify your service account as an owner.

  1. Follow the recommended steps to verify ownership of your property.
  2. After your property has been verified, open Search Console.
  3. Click your verified property.
  4. Click Settings.
  5. Go to user settings.
  6. Click manage property owner. (You need to be a Property-Owner!) Google Search Console - User settings
  7. Add your service account mail.
    The email address has a format similar to the following:
    my-service-account@project-name.google.com.iam.gserviceaccount.com Google Search Console - Add property owner

Logfiles

There is a logfile for more detailed information: JobIndexingLog.log

Enable logGoogleClientConfiguration if want to show your configuration after updating jobPostings.

TechDivision:
  Jobs:
    GoogleApi:
      options:
        ...
        logGoogleClientConfiguration: false

Further packages

To make jobs complete, we do offer a set of packages:

Contribution

We will be happy to receive pull requests - dont hesitate!