google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
41 lines (40 loc) • 1.89 kB
TypeScript
import { GrpcTransport } from '@protobuf-ts/grpc-transport';
/**
* creates an authenticated google-ads-api grcp transport, ready for use in making api calls
*
* ref:
* - https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid
*/
export declare const getAuthenticatedGoogleAdsApiGrpcTransport: ({ clientId, clientSecret, refreshToken, developerToken, loginCustomerId, linkedCustomerId, }: {
clientId: string;
clientSecret: string;
refreshToken: string;
/**
* per google
* > A developer token is a 22-character string that uniquely identifies a Google Ads API developer.
* > An example developer token string is ABcdeFGH93KL-NOPQ_STUv.
*
* ref
* - https://developers.google.com/google-ads/api/docs/concepts/call-structure#developer-token
*/
developerToken: string;
/**
* per google
* > This is the customer ID of the authorized customer to use in the request, without hyphens (-).
* > If your access to the customer account is through a manager account, this header is required and must be set to the customer ID of the manager account.
*
* > Setting the login-customer-id is equivalent to choosing an account in the Google Ads UI after signing in or clicking on your profile image at the top right. If you do not include this header, it defaults to the operating customer.
*
* ref
* - https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid
*/
loginCustomerId?: string | undefined;
/**
* per google
* > This header is only used by third-party app analytics providers when uploading conversions to a linked Google Ads account.
*
* ref
* - https://developers.google.com/google-ads/api/docs/concepts/call-structure#linked-customer-id
*/
linkedCustomerId?: string | undefined;
}) => GrpcTransport;