File: api_key_request_util.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (65 lines) | stat: -rw-r--r-- 1,994 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef GOOGLE_APIS_COMMON_API_KEY_REQUEST_UTIL_H_
#define GOOGLE_APIS_COMMON_API_KEY_REQUEST_UTIL_H_

#include <optional>
#include <string_view>

class GURL;

namespace net {
class HttpRequestHeaders;
}

namespace network {
struct ResourceRequest;
}

namespace version_info {
enum class Channel;
}

namespace google_apis {

// Adds the default API key to the request.
//
// This uses the default API key as returned by `GetAPIKey(channel)`. Use this
// method if your request does not have separate per-service or overridable key.
void AddDefaultAPIKeyToRequest(network::ResourceRequest& request,
                               version_info::Channel channel);

// Adds a specific API key to the request.
//
// Use this method if your request has separate per-service or overridable key.
void AddAPIKeyToRequest(network::ResourceRequest& request,
                        std::string_view api_key);
void AddAPIKeyToRequest(net::HttpRequestHeaders& request_headers,
                        std::string_view api_key);

// The below are internal definitions that should not be called from outside
// google_apis/common.
namespace internal {

// The API key can be present as either a URL parameter or as an HTTP header.
// This class uses the header form when setting the key, but getters support
// both forms.
//
// See https://cloud.google.com/apis/docs/system-parameters
inline constexpr char kApiKeyQueryParameterName[] = "key";
inline constexpr char kApiKeyHeaderName[] = "X-Goog-Api-Key";

// Returns the API key from a URL query parameter.
std::optional<std::string> GetAPIKey(const GURL& url);

// Returns the API key from the request headers.
std::optional<std::string> GetAPIKey(
    const net::HttpRequestHeaders& request_headers);

}  // namespace internal

}  // namespace google_apis

#endif  // GOOGLE_APIS_COMMON_API_KEY_REQUEST_UTIL_H_