googleads-rs 23.2.0

A gRPC client library for Google Ads API, generated automatically from the API definition files.
Documentation
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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
// Integration tests for GoogleAdsRow streaming and field mask functionality
//
// This module tests the integration between gRPC streaming responses,
// field masks, and the GoogleAdsRow::get() method.

#![allow(clippy::field_reassign_with_default)]
#![allow(clippy::useless_vec)]

use googleads_rs::google::ads::googleads::v23::common::{Metrics, Segments};
use googleads_rs::google::ads::googleads::v23::enums::{
    ad_group_status_enum::AdGroupStatus, campaign_status_enum::CampaignStatus,
};
use googleads_rs::google::ads::googleads::v23::resources::{AdGroup, Campaign, Customer};
use googleads_rs::google::ads::googleads::v23::services::{
    GoogleAdsRow, SearchGoogleAdsStreamResponse,
};
use prost_types::FieldMask;

// ============================================================================
// Field Mask Integration Tests
// ============================================================================

#[test]
fn test_field_mask_with_campaign_fields() {
    // Create a field mask requesting specific campaign fields
    let field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign.name".to_string(),
            "campaign.status".to_string(),
        ],
    };

    // Create a row with campaign data
    let mut campaign = Campaign::default();
    campaign.id = Some(12345);
    campaign.name = Some("Test Campaign".to_string());
    campaign.status = CampaignStatus::Enabled as i32;

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        ..Default::default()
    };

    // Verify all field mask paths return correct values
    for path in &field_mask.paths {
        let value = row.get(path);
        assert!(!value.is_empty(), "Field {} should return a value", path);
        assert_ne!(
            value, "not implemented by googleads-rs",
            "Field {} should be implemented",
            path
        );
    }

    // Verify specific values
    assert_eq!(row.get("campaign.id"), "12345");
    assert_eq!(row.get("campaign.name"), "Test Campaign");
    assert_eq!(row.get("campaign.status"), "ENABLED");
}

#[test]
fn test_field_mask_with_metrics_and_segments() {
    // Create a field mask requesting metrics and segments
    let field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "metrics.impressions".to_string(),
            "metrics.clicks".to_string(),
            "metrics.ctr".to_string(),
            "segments.date".to_string(),
        ],
    };

    // Create a row with campaign, metrics, and segments
    let mut campaign = Campaign::default();
    campaign.id = Some(99999);

    let mut metrics = Metrics::default();
    metrics.impressions = Some(10000);
    metrics.clicks = Some(500);
    metrics.ctr = Some(0.05);

    let mut segments = Segments::default();
    segments.date = Some("2024-10-10".to_string());

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        metrics: Some(metrics),
        segments: Some(segments),
        ..Default::default()
    };

    // Verify all paths in field mask work
    for path in &field_mask.paths {
        let value = row.get(path);
        assert!(!value.is_empty(), "Field {} should return a value", path);
    }

    assert_eq!(row.get("campaign.id"), "99999");
    assert_eq!(row.get("metrics.impressions"), "10000");
    assert_eq!(row.get("metrics.clicks"), "500");
    assert_eq!(row.get("metrics.ctr"), "0.05");
    assert_eq!(row.get("segments.date"), "2024-10-10");
}

#[test]
fn test_field_mask_with_nested_fields() {
    // Test field mask with nested message fields
    let _field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign.network_settings.target_search_network".to_string(),
            "campaign.network_settings.target_content_network".to_string(),
        ],
    };

    // Create campaign with network settings
    let mut campaign = Campaign::default();
    campaign.id = Some(55555);
    campaign.network_settings = Some(
        googleads_rs::google::ads::googleads::v23::resources::campaign::NetworkSettings {
            target_search_network: Some(true),
            target_content_network: Some(false),
            target_partner_search_network: Some(false),
            target_google_search: Some(true),
            ..Default::default()
        },
    );

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        ..Default::default()
    };

    // Verify nested paths work
    assert_eq!(row.get("campaign.id"), "55555");
    assert_eq!(
        row.get("campaign.network_settings.target_search_network"),
        "true"
    );
    assert_eq!(
        row.get("campaign.network_settings.target_content_network"),
        "false"
    );
}

#[test]
fn test_field_mask_all_paths_accessible() {
    // Test that all paths in field mask are accessible
    let field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign.name".to_string(),
            "ad_group.id".to_string(),
            "ad_group.name".to_string(),
            "customer.id".to_string(),
        ],
    };

    let mut campaign = Campaign::default();
    campaign.id = Some(111);
    campaign.name = Some("Campaign 1".to_string());

    let mut ad_group = AdGroup::default();
    ad_group.id = Some(222);
    ad_group.name = Some("Ad Group 1".to_string());

    let mut customer = Customer::default();
    customer.id = Some(333);

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        ad_group: Some(ad_group),
        customer: Some(customer),
        ..Default::default()
    };

    // Count how many paths return valid values
    let mut valid_count = 0;
    for path in &field_mask.paths {
        let value = row.get(path);
        if !value.is_empty() && value != "not implemented by googleads-rs" {
            valid_count += 1;
        }
    }

    // All 5 paths should return valid values
    assert_eq!(valid_count, 5, "All field mask paths should return values");
}

// ============================================================================
// Streaming Response Tests
// ============================================================================

#[test]
fn test_streaming_response_single_batch() {
    // Simulate a single batch streaming response
    let mut campaign = Campaign::default();
    campaign.id = Some(11111);
    campaign.name = Some("Campaign A".to_string());
    campaign.status = CampaignStatus::Enabled as i32;

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        ..Default::default()
    };

    let response = SearchGoogleAdsStreamResponse {
        results: vec![row],
        field_mask: Some(FieldMask {
            paths: vec![
                "campaign.id".to_string(),
                "campaign.name".to_string(),
                "campaign.status".to_string(),
            ],
        }),
        summary_row: None,
        request_id: "test-request-123".to_string(),
        query_resource_consumption: 0,
        ..Default::default()
    };

    // Process the response
    assert_eq!(response.results.len(), 1);
    assert!(response.field_mask.is_some());

    let row = &response.results[0];
    assert_eq!(row.get("campaign.id"), "11111");
    assert_eq!(row.get("campaign.name"), "Campaign A");
    assert_eq!(row.get("campaign.status"), "ENABLED");
}

#[test]
fn test_streaming_response_multiple_rows() {
    // Simulate a streaming response with multiple rows
    let mut rows = Vec::new();

    for i in 1..=5 {
        let mut campaign = Campaign::default();
        campaign.id = Some(i * 1000);
        campaign.name = Some(format!("Campaign {}", i));
        campaign.status = if i % 2 == 0 {
            CampaignStatus::Paused as i32
        } else {
            CampaignStatus::Enabled as i32
        };

        rows.push(GoogleAdsRow {
            campaign: Some(campaign),
            ..Default::default()
        });
    }

    let response = SearchGoogleAdsStreamResponse {
        results: rows,
        field_mask: Some(FieldMask {
            paths: vec![
                "campaign.id".to_string(),
                "campaign.name".to_string(),
                "campaign.status".to_string(),
            ],
        }),
        summary_row: None,
        request_id: "test-request-456".to_string(),
        query_resource_consumption: 0,
        ..Default::default()
    };

    // Verify we got 5 rows
    assert_eq!(response.results.len(), 5);

    // Verify each row
    for (idx, row) in response.results.iter().enumerate() {
        let i = idx + 1;
        assert_eq!(row.get("campaign.id"), format!("{}", i * 1000));
        assert_eq!(row.get("campaign.name"), format!("Campaign {}", i));

        let expected_status = if i % 2 == 0 { "PAUSED" } else { "ENABLED" };
        assert_eq!(row.get("campaign.status"), expected_status);
    }
}

#[test]
fn test_streaming_response_with_metrics() {
    // Test streaming response that includes metrics
    let mut campaign = Campaign::default();
    campaign.id = Some(77777);
    campaign.name = Some("Performance Campaign".to_string());

    let mut metrics = Metrics::default();
    metrics.impressions = Some(50000);
    metrics.clicks = Some(2500);
    metrics.ctr = Some(0.05);
    metrics.cost_micros = Some(125000000); // $125 in micros

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        metrics: Some(metrics),
        ..Default::default()
    };

    let response = SearchGoogleAdsStreamResponse {
        results: vec![row],
        field_mask: Some(FieldMask {
            paths: vec![
                "campaign.id".to_string(),
                "campaign.name".to_string(),
                "metrics.impressions".to_string(),
                "metrics.clicks".to_string(),
                "metrics.ctr".to_string(),
                "metrics.cost_micros".to_string(),
            ],
        }),
        summary_row: None,
        request_id: "test-request-789".to_string(),
        query_resource_consumption: 0,
        metric_attributes: vec![],
    };

    let row = &response.results[0];
    assert_eq!(row.get("campaign.id"), "77777");
    assert_eq!(row.get("campaign.name"), "Performance Campaign");
    assert_eq!(row.get("metrics.impressions"), "50000");
    assert_eq!(row.get("metrics.clicks"), "2500");
    assert_eq!(row.get("metrics.ctr"), "0.05");
    assert_eq!(row.get("metrics.cost_micros"), "125000000");
}

#[test]
fn test_streaming_response_empty_results() {
    // Test handling of empty response
    let response = SearchGoogleAdsStreamResponse {
        results: vec![],
        field_mask: Some(FieldMask {
            paths: vec!["campaign.id".to_string()],
        }),
        summary_row: None,
        request_id: "test-request-empty".to_string(),
        query_resource_consumption: 0,
        metric_attributes: vec![],
    };

    assert_eq!(response.results.len(), 0);
    assert!(response.field_mask.is_some());
}

// ============================================================================
// Field Mask Validation Tests
// ============================================================================

#[test]
fn test_invalid_field_path_returns_not_implemented() {
    let _field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign.invalid_field".to_string(),
            "unknown.resource.field".to_string(),
        ],
    };

    let mut campaign = Campaign::default();
    campaign.id = Some(12345);

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        ..Default::default()
    };

    // Valid path should work
    assert_eq!(row.get("campaign.id"), "12345");

    // Invalid paths should return "not implemented"
    assert_eq!(
        row.get("campaign.invalid_field"),
        "not implemented by googleads-rs"
    );
    assert_eq!(
        row.get("unknown.resource.field"),
        "not implemented by googleads-rs"
    );
}

#[test]
fn test_field_mask_with_optional_resources() {
    // Test field mask with paths to optional resources
    // Note: Some resources use optional_attr_str! and return "" when not present,
    // while others use attr_str! and will panic if accessed when not present.
    // This test focuses on optional_attr_str! fields.
    let _field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign_budget.amount_micros".to_string(), // Uses optional_attr_str!
        ],
    };

    let mut campaign = Campaign::default();
    campaign.id = Some(99999);

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        // campaign_budget not set
        ..Default::default()
    };

    // Campaign field should work
    assert_eq!(row.get("campaign.id"), "99999");

    // Optional resource using optional_attr_str! should return empty string when not present
    assert_eq!(row.get("campaign_budget.amount_micros"), "");
}

// ============================================================================
// Realistic Integration Scenarios
// ============================================================================

#[test]
fn test_realistic_campaign_report_query() {
    // Simulate a realistic campaign performance report query
    let field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign.name".to_string(),
            "campaign.status".to_string(),
            "metrics.impressions".to_string(),
            "metrics.clicks".to_string(),
            "metrics.ctr".to_string(),
            "metrics.cost_micros".to_string(),
            "metrics.conversions".to_string(),
            "segments.date".to_string(),
        ],
    };

    // Create multiple rows simulating a date range report
    let mut rows = Vec::new();
    let dates = vec!["2024-10-08", "2024-10-09", "2024-10-10"];

    for (idx, date) in dates.iter().enumerate() {
        let mut campaign = Campaign::default();
        campaign.id = Some(555555);
        campaign.name = Some("Q4 Campaign".to_string());
        campaign.status = CampaignStatus::Enabled as i32;

        let mut metrics = Metrics::default();
        metrics.impressions = Some(5000 + (idx as i64 * 500));
        metrics.clicks = Some(250 + (idx as i64 * 25));
        metrics.ctr = Some(0.05);
        metrics.cost_micros = Some(50000000);
        metrics.conversions = Some(10.0 + (idx as f64 * 2.0));

        let mut segments = Segments::default();
        segments.date = Some(date.to_string());

        rows.push(GoogleAdsRow {
            campaign: Some(campaign),
            metrics: Some(metrics),
            segments: Some(segments),
            ..Default::default()
        });
    }

    let response = SearchGoogleAdsStreamResponse {
        results: rows,
        field_mask: Some(field_mask),
        summary_row: None,
        request_id: "campaign-report-123".to_string(),
        query_resource_consumption: 0,
        metric_attributes: vec![],
    };

    // Verify response structure
    assert_eq!(response.results.len(), 3);

    // Verify each day's data
    for (idx, row) in response.results.iter().enumerate() {
        assert_eq!(row.get("campaign.id"), "555555");
        assert_eq!(row.get("campaign.name"), "Q4 Campaign");
        assert_eq!(row.get("campaign.status"), "ENABLED");
        assert_eq!(row.get("segments.date"), dates[idx]);

        // Verify metrics progression
        let expected_impressions = 5000 + (idx as i64 * 500);
        let expected_clicks = 250 + (idx as i64 * 25);
        let expected_conversions = 10.0 + (idx as f64 * 2.0);

        assert_eq!(
            row.get("metrics.impressions"),
            format!("{}", expected_impressions)
        );
        assert_eq!(row.get("metrics.clicks"), format!("{}", expected_clicks));
        assert_eq!(
            row.get("metrics.conversions"),
            format!("{}", expected_conversions)
        );
    }
}

#[test]
fn test_realistic_ad_group_query() {
    // Simulate an ad group query with parent campaign data
    let field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign.name".to_string(),
            "ad_group.id".to_string(),
            "ad_group.name".to_string(),
            "ad_group.status".to_string(),
            "ad_group.cpc_bid_micros".to_string(),
        ],
    };

    let mut campaign = Campaign::default();
    campaign.id = Some(123456);
    campaign.name = Some("Parent Campaign".to_string());

    let mut ad_group = AdGroup::default();
    ad_group.id = Some(789012);
    ad_group.name = Some("Brand Keywords".to_string());
    ad_group.status = AdGroupStatus::Enabled as i32;
    ad_group.cpc_bid_micros = Some(5000000); // $5 CPC bid

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        ad_group: Some(ad_group),
        ..Default::default()
    };

    let response = SearchGoogleAdsStreamResponse {
        results: vec![row],
        field_mask: Some(field_mask),
        summary_row: None,
        request_id: "ad-group-query-456".to_string(),
        query_resource_consumption: 0,
        metric_attributes: vec![],
    };

    let row = &response.results[0];
    assert_eq!(row.get("campaign.id"), "123456");
    assert_eq!(row.get("campaign.name"), "Parent Campaign");
    assert_eq!(row.get("ad_group.id"), "789012");
    assert_eq!(row.get("ad_group.name"), "Brand Keywords");
    assert_eq!(row.get("ad_group.status"), "ENABLED");
    assert_eq!(row.get("ad_group.cpc_bid_micros"), "5000000");
}

#[test]
fn test_field_mask_iteration_pattern() {
    // Test the typical usage pattern: iterate field mask paths and call get()
    let field_mask = FieldMask {
        paths: vec![
            "campaign.id".to_string(),
            "campaign.name".to_string(),
            "campaign.status".to_string(),
        ],
    };

    let mut campaign = Campaign::default();
    campaign.id = Some(111111);
    campaign.name = Some("Test Campaign".to_string());
    campaign.status = CampaignStatus::Enabled as i32;

    let row = GoogleAdsRow {
        campaign: Some(campaign),
        ..Default::default()
    };

    // Simulate typical usage: iterate and collect values
    let mut output = Vec::new();
    for path in &field_mask.paths {
        let value = row.get(path);
        output.push(format!("{}: {}", path, value));
    }

    assert_eq!(output.len(), 3);
    assert_eq!(output[0], "campaign.id: 111111");
    assert_eq!(output[1], "campaign.name: Test Campaign");
    assert_eq!(output[2], "campaign.status: ENABLED");
}