Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: updated by action, Sat Oct 19 07:22:58 UTC 2024 #37

Merged
merged 4 commits into from
Oct 19, 2024
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: "1.20"
go-version: "1.22"

- name: Build
run: go mod tidy && go build -v ./...
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/.idea
.DS_Store
/test
84 changes: 42 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,58 +21,65 @@ Although this project isn't official, we deem it as low-risk due to its maturity

| google-ads-pb | Google Ads API | Sunset date |
| ----------------- | ---------------- | ---------------------------- |
| v1.17.1 | v17.1 | May 2025 |
| v1.17.0 | v17 | May 2025 |
| v1.16.1 | v16.1 | January 2025 |
| v1.7.0 | v16 | January 2025 |
| v1.18.0 | v18 | September 2025 |
| v1.17.1 | v17.1 | May 2025 |
| v1.17.0 | v17 | May 2025 |
| v1.16.1 | v16.1 | January 2025 |
| v1.7.0 | v16 | January 2025 |
| <del>v1.6.0</del> | <del>v15</del> | Deprecated |
| <del>v1.5.1</del> | <del>v14.1</del> | Deprecated |
| <del>v1.5.0</del> | <del>v14</del> | Deprecated |
| <del>v1.4.1</del> | <del>v13.1</del> | Deprecated |
| <del>v1.4.0</del> | <del>v13</del> | Deprecated |
| <del>v1.3.1</del> | <del>v12</del> | Deprecated |
| <del>v1.2.1</del> | <del>v11.1</del> | Deprecated |
| <del>v1.2.0</del> | <del>v11</del> | Deprecated |
| <del>v1.1.1</del> | <del>v10</del> | Deprecated |

## Requirements

- Go 1.20.
- Go 1.22.
- Familiarize yourself with the [OAuth2 guide](https://developers.google.com/google-ads/api/docs/oauth/overview).
- If needed, obtain a [developer token](https://developers.google.com/google-ads/api/docs/first-call/dev-token).

## Installation

```bash
$ go get github.com/shenzhencenter/google-ads-pb
go get github.com/shenzhencenter/google-ads-pb
```

## Getting started

1. Set your environment variables.

```bash
$ export ACCESS_TOKEN=<your access token>
$ export DEVELOPER_TOKEN=<your developer token>
$ export CUSTOMER_ID=<your customer id>
export ACCESS_TOKEN=<your access token>
export DEVELOPER_TOKEN=<your developer token>
export CUSTOMER_ID=<your customer id>
```

2. Establish a GRPC connection.
If you're using gRPC, you should attach the access token, developer token, and customer ID to the context.

```go
ctx := context.Background()

headers := metadata.Pairs(
"authorization", "Bearer "+os.Getenv("ACCESS_TOKEN"),
"developer-token", os.Getenv("DEVELOPER_TOKEN"),
"login-customer-id", os.Getenv("CUSTOMER_ID"),
"authorization", "Bearer "+os.Getenv("ACCESS_TOKEN"),
"developer-token", os.Getenv("DEVELOPER_TOKEN"),
"login-customer-id", os.Getenv("CUSTOMER_ID"),
)
ctx = metadata.NewOutgoingContext(ctx, headers)
```

If you're using HTTP, you should attach the access token, developer token, and customer ID to the header.

```go
header := make(http.Header)
header.Set("content-type", "application/json")
header.Set("authorization", os.Getenv("ACCESS_TOKEN"))
header.Set("developer-token", os.Getenv("DEVELOPER_TOKEN"))
```

2. Establish a GRPC connection.

```go
cred := grpc.WithTransportCredentials(credentials.NewClientTLSFromCert(nil, ""))
conn, err := grpc.Dial("googleads.googleapis.com:443", cred)
conn, err := grpc.NewClient("googleads.googleapis.com:443", cred)
if err != nil {
panic(err)
panic(err)
}
defer conn.Close()
```
Expand All @@ -82,54 +89,47 @@ defer conn.Close()
```go
customerServiceClient := services.NewCustomerServiceClient(conn)
accessibleCustomers, err := customerServiceClient.ListAccessibleCustomers(
ctx,
&services.ListAccessibleCustomersRequest{},
ctx, // be sure to use the context with the access token, developer token, and customer ID
&services.ListAccessibleCustomersRequest{},
)
if err != nil {
panic(err)
panic(err)
}

for _, customer := range accessibleCustomers.ResourceNames {
fmt.Println("ResourceName: " + customer)
fmt.Println("ResourceName: " + customer)
}
```

You can also make HTTP calls using [protojson](https://google.golang.org/protobuf/encoding/protojson), though it isn't recommended.

```go
const endpoint = "https://googleads.googleapis.com/v18/customers:listAccessibleCustomers"
req := services.ListAccessibleCustomersRequest{}
requestBody, err := protojson.Marshal(&req)
if err != nil {
panic(err)
}
request, err := http.NewRequest("GET", "https://googleads.googleapis.com/v17/customers:listAccessibleCustomers", bytes.NewBuffer(requestBody))
if err != nil {
panic(err)
}
requestBody, _ := protojson.Marshal(&req)
request, _ := http.NewRequest("GET", endpoint, bytes.NewBuffer(requestBody))
header := make(http.Header)
header.Set("content-type", "application/json")
header.Set("authorization", os.Getenv("ACCESS_TOKEN"))
header.Set("developer-token", os.Getenv("DEVELOPER_TOKEN"))
request.Header = header
client := &http.Client{}
response, err := client.Do(request)
if err != nil {
panic(err)
}
response, _ := http.DefaultClient.Do(request)
defer response.Body.Close()
var responseBody []byte
if responseBody, err = io.ReadAll(response.Body); err != nil {
panic(err)
panic(err)
}
listAccessibleCustomersResponse := new(services.ListAccessibleCustomersResponse)
if err := protojson.Unmarshal(responseBody, listAccessibleCustomersResponse); err != nil {
panic(err)
panic(err)
}
for _, customer := range listAccessibleCustomersResponse.ResourceNames {
fmt.Println("ResourceName: " + customer)
fmt.Println("ResourceName: " + customer)
}
```

> **Note**: The above examples are just a starting point. You should adjust them based on your needs.

## Examples

See [clients/internal/snippets](https://github.com/shenzhencenter/google-ads-pb/tree/main/clients/internal/snippets).
Expand Down
23 changes: 23 additions & 0 deletions clients/account_budget_proposal_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/account_link_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/ad_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/ad_group_ad_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/ad_group_ad_label_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/ad_group_asset_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/ad_group_asset_set_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/ad_group_bid_modifier_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions clients/ad_group_client_example_go123_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading