Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

docs(samples): read the project id from google.auth #160

Merged
merged 4 commits into from
Feb 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions samples/interactive-tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,17 +72,6 @@ To run a code sample from the Cloud Shell, you need to be authenticated using th
export GOOGLE_APPLICATION_CREDENTIALS=~/key.json
```

### Set the GOOGLE_CLOUD_PROJECT environment variable

You will run the code samples in your own Google Cloud project. To use the **project_id** in every request to the Retail API, you should first specify them as environment variables.

1. Find the project ID in the Project Info card displayed on **Home/Dashboard**.

1. Set the **project_id** with the following command:
```bash
export GOOGLE_CLOUD_PROJECT=<YOUR_PROJECT_ID>
```

### Install Google Cloud Retail libraries

To run Python code samples for the Retail API tutorial, you need to set up your virtual environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
## Required environment variables

To successfully import the catalog data for tests, the following environment variables should be set:
- GOOGLE_CLOUD_PROJECT
- BUCKET_NAME
- EVENTS_BUCKET_NAME
These values are stored in the Secret Manager and will be submitted as
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@

# [START retail_add_fulfillment_places]
import datetime
import os
import random
import string
import time

import google.auth
from google.cloud.retail import AddFulfillmentPlacesRequest, ProductServiceClient

from setup_product.setup_cleanup import create_product, delete_product, get_product

project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
product_id = "".join(random.sample(string.ascii_lowercase, 8))
product_name = (
"projects/"
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/product/create_product.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@
# [START retail_create_product]
# Create product in a catalog using Retail API
#
import os
import random
import string

import google.auth
from google.cloud.retail import CreateProductRequest, Product, ProductServiceClient
from google.cloud.retail import PriceInfo
from google.cloud.retail_v2.types import product

from setup_product.setup_cleanup import delete_product

project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
default_branch_name = (
"projects/"
+ project_id
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/product/crud_product.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
# [START retail_crud_product]
# Create product in a catalog using Retail API
#
import os
import random
import string

import google.auth
from google.cloud.retail import (
CreateProductRequest,
DeleteProductRequest,
Expand All @@ -31,7 +31,7 @@
from google.cloud.retail import PriceInfo
from google.cloud.retail_v2.types import product

project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
default_branch_name = (
"projects/"
+ project_id
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/product/delete_product.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
# [START retail_delete_product]
# Delete product from a catalog using Retail API
#
import os
import random
import string

import google.auth
from google.cloud.retail import DeleteProductRequest, ProductServiceClient

from setup_product.setup_cleanup import create_product

project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
default_branch_name = (
"projects/"
+ project_id
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/product/get_product.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
# [START retail_get_product]
# Get product from a catalog using Retail API
#
import os
import random
import string

import google.auth
from google.cloud.retail import GetProductRequest, ProductServiceClient

from setup_product.setup_cleanup import create_product, delete_product

project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
product_id = "".join(random.sample(string.ascii_lowercase, 8))


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@
# limitations under the License.

import argparse
import os

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
import google.auth

project_id = google.auth.default()[1]


def main(project_id, dataset_id, table_id):
Expand Down
5 changes: 2 additions & 3 deletions samples/interactive-tutorials/product/import_products_gcs.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
def main(bucket_name):
# [START retail_import_products_from_gcs]

import os
import time

import google.auth
from google.cloud.retail import (
GcsSource,
ImportErrorsConfig,
Expand All @@ -30,8 +30,7 @@ def main(bucket_name):
ProductServiceClient,
)

# Read the project id from the environment variable
project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]

# TODO: Developer set the bucket_name
# bucket_name = os.environ["BUCKET_NAME"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
# [START retail_import_products_from_inline_source]
# Import products into a catalog from inline source using Retail API
#
import os
import random
import string
import time

import google.auth
from google.cloud.retail import (
ColorInfo,
FulfillmentInfo,
Expand All @@ -32,8 +32,7 @@
)
from google.protobuf.field_mask_pb2 import FieldMask

# Read the project ID from the environment variable
project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]

default_catalog = f"projects/{project_id}/locations/global/catalogs/default_catalog/branches/default_branch"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@

# [START retail_remove_fulfillment_places]
import datetime
import os
import random
import string
import time

import google.auth
from google.cloud.retail import ProductServiceClient, RemoveFulfillmentPlacesRequest

from setup_product.setup_cleanup import create_product, delete_product, get_product

project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
product_id = "".join(random.sample(string.ascii_lowercase, 8))
product_name = (
"projects/"
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/product/set_inventory.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@

# [START retail_set_inventory]
import datetime
import os
import random
import string
import time

import google.auth
from google.cloud.retail import (
FulfillmentInfo,
PriceInfo,
Expand All @@ -30,7 +30,7 @@

from setup_product.setup_cleanup import create_product, delete_product, get_product

project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
product_id = "".join(random.sample(string.ascii_lowercase, 8))
product_name = (
"projects/"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@
# limitations under the License.

import datetime
import os

import google.auth

from setup_cleanup import create_bucket, upload_blob

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]
timestamp_ = datetime.datetime.now().timestamp().__round__()
bucket_name = "{}_products_{}".format(project_id, timestamp_)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@
# limitations under the License.

import json
import os
import re

from google.api_core.exceptions import NotFound
import google.auth

from google.cloud import bigquery
from google.cloud import storage
from google.cloud.retail import CreateProductRequest, DeleteProductRequest, \
FulfillmentInfo, GetProductRequest, PriceInfo, Product, ProductServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]
default_catalog = f"projects/{project_id}/locations/global/catalogs/default_catalog"
default_branch_name = f"projects/{project_id}/locations/global/catalogs/default_catalog/branches/default_branch"

Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/product/update_product.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
# [START retail_update_product]
# Update product in a catalog using Retail API
#
import os
import random
import string

import google.auth
from google.cloud.retail import (
PriceInfo,
Product,
Expand All @@ -34,7 +34,7 @@
# from google.protobuf.field_mask_pb2 import FieldMask


project_id = os.getenv("GOOGLE_CLOUD_PROJECT")
project_id = google.auth.default()[1]
default_branch_name = (
"projects/"
+ project_id
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/search/search_simple_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
# [START retail_search_for_products_with_query_parameter]
# Call Retail API to search for a products in a catalog using only search query.
#
import os

import google.auth
from google.cloud.retail import SearchRequest, SearchServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]


# get search service request:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
# Call Retail API to search for a products in a catalog, rerank the
# results boosting or burying the products that match defined condition.
#
import os

import google.auth
from google.cloud.retail import SearchRequest, SearchServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]


# get search service request:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@

# [START retail_search_product_with_facet_spec]
#
import os

import google.auth
from google.cloud.retail import SearchRequest, SearchServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]


# get search service request:
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/search/search_with_filtering.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
# [START retail_search_for_products_with_filter]
# Call Retail API to search for a products in a catalog, filter the results by different product fields.
#
import os

import google.auth
from google.cloud.retail import SearchRequest, SearchServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]


# get search service request:
Expand Down
4 changes: 2 additions & 2 deletions samples/interactive-tutorials/search/search_with_ordering.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
# [START retail_search_for_products_with_ordering]
# Call Retail API to search for a products in a catalog, order the results by different product fields.
#
import os

import google.auth
from google.cloud.retail import SearchRequest, SearchServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]


# get search service request:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
# limit the number of the products per page and go to the next page using "next_page_token"
# or jump to chosen page using "offset".
#
import os

import google.auth
from google.cloud.retail import SearchRequest, SearchServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]


# get search service request:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@
# Call Retail API to search for a products in a catalog,
# enabling the query expansion feature to let the Google Retail Search build an automatic query expansion.
#
import os

import google.auth
from google.cloud.retail import SearchRequest, SearchServiceClient

project_id = os.environ["GOOGLE_CLOUD_PROJECT"]

project_id = google.auth.default()[1]


# get search service request:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import subprocess
import time

import google.auth
from google.cloud import storage
from google.cloud.retail import GcsSource, ImportErrorsConfig, \
ImportProductsRequest, ProductInputConfig
Expand All @@ -26,7 +27,7 @@

products_bucket_name = os.environ['BUCKET_NAME']
events_bucket_name = os.environ['EVENTS_BUCKET_NAME']
project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
project_id = google.auth.default()[1]

product_resource_file = "../resources/products.json"
events_source_file = "../resources/user_events.json"
Expand Down
Loading