gatsby-source-google-sheets icon indicating copy to clipboard operation
gatsby-source-google-sheets copied to clipboard

Documentation updates

Open drewatk opened this issue 6 years ago • 9 comments

We need to update documentation to make this a bit better on beginners

  • How to query for data, and what fields are available: #21 #13
  • Limitations of the google sheets api: #20 #17

drewatk avatar Nov 09 '18 18:11 drewatk

Also add new "type guessing" logic from #19

drewatk avatar Apr 09 '19 02:04 drewatk

@drewatk Does anyone taking this issue yet? May I be any help?

krerkkiat avatar Sep 03 '19 14:09 krerkkiat

I still haven't figured out how to query data with GraphQL. I did setup everything with credentials and it builds, but how do I write the API queries?

Waschnick avatar Sep 04 '19 16:09 Waschnick

@Waschnick If you still looking into how to query, please have a look at changes in #29 (or a rendered README.md here).

krerkkiat avatar Sep 26 '19 21:09 krerkkiat

YES! That helps a lot, thanks! https://github.com/krerkkiat/gatsby-source-google-sheets/tree/revise-documentation

stewest avatar Jan 09 '20 17:01 stewest

Can someone please document what the graphQL query is supposed to look like to use this plugin?

doublejosh avatar Oct 19 '22 02:10 doublejosh

Hi @doublejosh

Did you see https://github.com/brandonmp/gatsby-source-google-sheets/pull/29/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R50

It will depend on the shape of your data sheet, i.e. the column names.

stewest avatar Oct 19 '22 06:10 stewest

@stewest The confusing part is the table/type name, not the columns. In the example it's allGoogleSheetPublicationsRow

I was only able to discover mine by hitting the local GraphQL endpoint http://localhost:8000/___graphql

It seems to generate a name from the title of the sheet and the tab name, and makes choices about capitalization.

In my case... allGoogleSpreadsheetWwWebsiteContentVideos

spreadsheetName: "WWWebsiteContent",
typePrefix: "GoogleSpreadsheet",

doublejosh avatar Nov 15 '22 18:11 doublejosh

Hi @doublejosh yes, indeed, odd name. I think it needs to make it unique, as one could have multiple sources. Getting the name from GraphQL is the way. Good luck with your project!

stewest avatar Nov 16 '22 06:11 stewest