forked from airbytehq/terraform-provider-airbyte
/
source_facebookmarketing_data_source.go
executable file
·278 lines (257 loc) · 12 KB
/
source_facebookmarketing_data_source.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
// Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
package provider
import (
"github.com/ryan-pip/terraform-provider-airbyte/internal/sdk"
"github.com/ryan-pip/terraform-provider-airbyte/internal/sdk/pkg/models/operations"
"context"
"fmt"
"github.com/ryan-pip/terraform-provider-airbyte/internal/validators"
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)
// Ensure provider defined types fully satisfy framework interfaces.
var _ datasource.DataSource = &SourceFacebookMarketingDataSource{}
var _ datasource.DataSourceWithConfigure = &SourceFacebookMarketingDataSource{}
func NewSourceFacebookMarketingDataSource() datasource.DataSource {
return &SourceFacebookMarketingDataSource{}
}
// SourceFacebookMarketingDataSource is the data source implementation.
type SourceFacebookMarketingDataSource struct {
client *sdk.SDK
}
// SourceFacebookMarketingDataSourceModel describes the data model.
type SourceFacebookMarketingDataSourceModel struct {
Configuration SourceFacebookMarketing `tfsdk:"configuration"`
Name types.String `tfsdk:"name"`
SecretID types.String `tfsdk:"secret_id"`
SourceID types.String `tfsdk:"source_id"`
WorkspaceID types.String `tfsdk:"workspace_id"`
}
// Metadata returns the data source type name.
func (r *SourceFacebookMarketingDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_source_facebook_marketing"
}
// Schema defines the schema for the data source.
func (r *SourceFacebookMarketingDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "SourceFacebookMarketing DataSource",
Attributes: map[string]schema.Attribute{
"configuration": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"access_token": schema.StringAttribute{
Computed: true,
Description: `The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions <b>ads_management, ads_read, read_insights, business_management</b>. Then click on "Get token". See the <a href="https://docs.airbyte.com/integrations/sources/facebook-marketing">docs</a> for more information.`,
},
"account_id": schema.StringAttribute{
Computed: true,
Description: `The Facebook Ad account ID to use when pulling data from the Facebook Marketing API. Open your Meta Ads Manager. The Ad account ID number is in the account dropdown menu or in your browser's address bar. See the <a href="https://www.facebook.com/business/help/1492627900875762">docs</a> for more information.`,
},
"action_breakdowns_allow_empty": schema.BoolAttribute{
Computed: true,
Description: `Allows action_breakdowns to be an empty list`,
},
"client_id": schema.StringAttribute{
Computed: true,
Description: `The Client Id for your OAuth app`,
},
"client_secret": schema.StringAttribute{
Computed: true,
Description: `The Client Secret for your OAuth app`,
},
"custom_insights": schema.ListNestedAttribute{
Computed: true,
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"action_breakdowns": schema.ListAttribute{
Computed: true,
ElementType: types.StringType,
Description: `A list of chosen action_breakdowns for action_breakdowns`,
},
"action_report_time": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"conversion",
"impression",
"mixed",
),
},
MarkdownDescription: `must be one of ["conversion", "impression", "mixed"]` + "\n" +
`Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with action_report_time=impression, you see a conversion on Jan 1st. When you query the API with action_report_time=conversion, you see a conversion on Jan 2nd.`,
},
"breakdowns": schema.ListAttribute{
Computed: true,
ElementType: types.StringType,
Description: `A list of chosen breakdowns for breakdowns`,
},
"end_date": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
validators.IsRFC3339(),
},
Description: `The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.`,
},
"fields": schema.ListAttribute{
Computed: true,
ElementType: types.StringType,
Description: `A list of chosen fields for fields parameter`,
},
"insights_lookback_window": schema.Int64Attribute{
Computed: true,
Description: `The attribution window`,
},
"level": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"ad",
"adset",
"campaign",
"account",
),
},
MarkdownDescription: `must be one of ["ad", "adset", "campaign", "account"]` + "\n" +
`Chosen level for API`,
},
"name": schema.StringAttribute{
Computed: true,
Description: `The name value of insight`,
},
"start_date": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
validators.IsRFC3339(),
},
Description: `The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.`,
},
"time_increment": schema.Int64Attribute{
Computed: true,
Description: `Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only).`,
},
},
},
Description: `A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action_breakdowns. Click on "add" to fill this field.`,
},
"end_date": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
validators.IsRFC3339(),
},
Description: `The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.`,
},
"fetch_thumbnail_images": schema.BoolAttribute{
Computed: true,
Description: `Set to active if you want to fetch the thumbnail_url and store the result in thumbnail_data_url for each Ad Creative.`,
},
"include_deleted": schema.BoolAttribute{
Computed: true,
Description: `Set to active if you want to include data from deleted Campaigns, Ads, and AdSets.`,
},
"insights_lookback_window": schema.Int64Attribute{
Computed: true,
Description: `The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here.`,
},
"max_batch_size": schema.Int64Attribute{
Computed: true,
Description: `Maximum batch size used when sending batch requests to Facebook API. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.`,
},
"page_size": schema.Int64Attribute{
Computed: true,
Description: `Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.`,
},
"source_type": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"facebook-marketing",
),
},
Description: `must be one of ["facebook-marketing"]`,
},
"start_date": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
validators.IsRFC3339(),
},
Description: `The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.`,
},
},
},
"name": schema.StringAttribute{
Computed: true,
},
"secret_id": schema.StringAttribute{
Optional: true,
Description: `Optional secretID obtained through the public API OAuth redirect flow.`,
},
"source_id": schema.StringAttribute{
Required: true,
},
"workspace_id": schema.StringAttribute{
Computed: true,
},
},
}
}
func (r *SourceFacebookMarketingDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
// Prevent panic if the provider has not been configured.
if req.ProviderData == nil {
return
}
client, ok := req.ProviderData.(*sdk.SDK)
if !ok {
resp.Diagnostics.AddError(
"Unexpected DataSource Configure Type",
fmt.Sprintf("Expected *sdk.SDK, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)
return
}
r.client = client
}
func (r *SourceFacebookMarketingDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
var data *SourceFacebookMarketingDataSourceModel
var item types.Object
resp.Diagnostics.Append(req.Config.Get(ctx, &item)...)
if resp.Diagnostics.HasError() {
return
}
resp.Diagnostics.Append(item.As(ctx, &data, basetypes.ObjectAsOptions{
UnhandledNullAsEmpty: true,
UnhandledUnknownAsEmpty: true,
})...)
if resp.Diagnostics.HasError() {
return
}
sourceID := data.SourceID.ValueString()
request := operations.GetSourceFacebookMarketingRequest{
SourceID: sourceID,
}
res, err := r.client.Sources.GetSourceFacebookMarketing(ctx, request)
if err != nil {
resp.Diagnostics.AddError("failure to invoke API", err.Error())
if res != nil && res.RawResponse != nil {
resp.Diagnostics.AddError("unexpected http request/response", debugResponse(res.RawResponse))
}
return
}
if res == nil {
resp.Diagnostics.AddError("unexpected response from API", fmt.Sprintf("%v", res))
return
}
if res.StatusCode != 200 {
resp.Diagnostics.AddError(fmt.Sprintf("unexpected response from API. Got an unexpected response code %v", res.StatusCode), debugResponse(res.RawResponse))
return
}
if res.SourceResponse == nil {
resp.Diagnostics.AddError("unexpected response from API. No response body", debugResponse(res.RawResponse))
return
}
data.RefreshFromGetResponse(res.SourceResponse)
// Save updated data into Terraform state
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}