Class v1.CloudChannelReportsServiceClient (3.6.0)

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Properties

apiEndpoint

get apiEndpoint(): string;

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

cloudChannelReportsServiceStub

cloudChannelReportsServiceStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

billingAccountPath(account, billingAccount)

billingAccountPath(account: string, billingAccount: string): string;

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

channelPartnerLinkPath(account, channelPartnerLink)

channelPartnerLinkPath(account: string, channelPartnerLink: string): string;

channelPartnerRepricingConfigPath(account, channelPartner, channelPartnerRepricingConfig)

channelPartnerRepricingConfigPath(account: string, channelPartner: string, channelPartnerRepricingConfig: string): string;

checkRunReportJobProgress(name)

checkRunReportJobProgress(name: string): Promise<LROperation<protos.google.cloud.channel.v1.RunReportJobResponse, protos.google.cloud.channel.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The report's resource name. Specifies the account and report used
   *  to generate report data. The report_id identifier is a UID (for example,
   *  `613bf59q`).
   *  Name uses the format:
   *  accounts/{account_id}/reports/{report_id}
   */
  // const name = 'abc123'
  /**
   *  Optional. The range of usage or invoice dates to include in the result.
   */
  // const dateRange = {}
  /**
   *  Optional. A structured string that defines conditions on dimension columns
   *  to restrict the report output.
   *  Filters support logical operators (AND, OR, NOT) and conditional operators
   *  (=, !=, <,>, <=, and="">=) using `column_id` as keys.
   *  For example:
   *  `(customer:"accounts/C123abc/customers/S456def" OR
   *  customer:"accounts/C123abc/customers/S789ghi") AND
   *  invoice_start_date.year >= 2022`
   */
  // const filter = 'abc123'
  /**
   *  Optional. The BCP-47 language code, such as "en-US".  If specified, the
   *  response is localized to the corresponding language code if the
   *  original data sources support it.
   *  Default is "en-US".
   */
  // const languageCode = 'abc123'

  // Imports the Channel library
  const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1;

  // Instantiates a client
  const channelClient = new CloudChannelReportsServiceClient();

  async function callRunReportJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await channelClient.runReportJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunReportJob();

close()

close(): Promise<void>;

customerPath(account, customer)

customerPath(account: string, customer: string): string;

customerRepricingConfigPath(account, customer, customerRepricingConfig)

customerRepricingConfigPath(account: string, customer: string, customerRepricingConfig: string): string;

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

entitlementPath(account, customer, entitlement)

entitlementPath(account: string, customer: string, entitlement: string): string;

fetchReportResults(request, options)

fetchReportResults(request?: protos.google.cloud.channel.v1.IFetchReportResultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.channel.v1.IRow[],
        protos.google.cloud.channel.v1.IFetchReportResultsRequest | null,
        protos.google.cloud.channel.v1.IFetchReportResultsResponse
    ]>;

fetchReportResults(request, options, callback)

fetchReportResults(request: protos.google.cloud.channel.v1.IFetchReportResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IFetchReportResultsRequest, protos.google.cloud.channel.v1.IFetchReportResultsResponse | null | undefined, protos.google.cloud.channel.v1.IRow>): void;

fetchReportResults(request, callback)

fetchReportResults(request: protos.google.cloud.channel.v1.IFetchReportResultsRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IFetchReportResultsRequest, protos.google.cloud.channel.v1.IFetchReportResultsResponse | null | undefined, protos.google.cloud.channel.v1.IRow>): void;

fetchReportResultsAsync(request, options)

fetchReportResultsAsync(request?: protos.google.cloud.channel.v1.IFetchReportResultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IRow>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The report job created by
   *  CloudChannelReportsService.RunReportJob google.cloud.channel.v1.CloudChannelReportsService.RunReportJob.
   *  Report_job uses the format:
   *  accounts/{account_id}/reportJobs/{report_job_id}
   */
  // const reportJob = 'abc123'
  /**
   *  Optional. Requested page size of the report. The server may return fewer
   *  results than requested. If you don't specify a page size, the server uses a
   *  sensible default (may change over time).
   *  The maximum value is 30,000; the server will change larger values to
   *  30,000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token that specifies a page of results beyond the first page.
   *  Obtained through
   *  FetchReportResultsResponse.next_page_token google.cloud.channel.v1.FetchReportResultsResponse.next_page_token 
   *  of the previous
   *  CloudChannelReportsService.FetchReportResults google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. List of keys specifying which report partitions to return.
   *  If empty, returns all partitions.
   */
  // const partitionKeys = ['abc','def']

  // Imports the Channel library
  const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1;

  // Instantiates a client
  const channelClient = new CloudChannelReportsServiceClient();

  async function callFetchReportResults() {
    // Construct request
    const request = {
      reportJob,
    };

    // Run request
    const iterable = channelClient.fetchReportResultsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callFetchReportResults();

fetchReportResultsStream(request, options)

fetchReportResultsStream(request?: protos.google.cloud.channel.v1.IFetchReportResultsRequest, options?: CallOptions): Transform;

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listReports(request, options)

listReports(request?: protos.google.cloud.channel.v1.IListReportsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.channel.v1.IReport[],
        protos.google.cloud.channel.v1.IListReportsRequest | null,
        protos.google.cloud.channel.v1.IListReportsResponse
    ]>;

listReports(request, options, callback)

listReports(request: protos.google.cloud.channel.v1.IListReportsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.channel.v1.IListReportsRequest, protos.google.cloud.channel.v1.IListReportsResponse | null | undefined, protos.google.cloud.channel.v1.IReport>): void;

listReports(request, callback)

listReports(request: protos.google.cloud.channel.v1.IListReportsRequest, callback: PaginationCallback<protos.google.cloud.channel.v1.IListReportsRequest, protos.google.cloud.channel.v1.IListReportsResponse | null | undefined, protos.google.cloud.channel.v1.IReport>): void;

listReportsAsync(request, options)

listReportsAsync(request?: protos.google.cloud.channel.v1.IListReportsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.channel.v1.IReport>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the partner account to list available
   *  reports for. Parent uses the format: accounts/{account_id}
   */
  // const parent = 'abc123'
  /**
   *  Optional. Requested page size of the report. The server might return fewer
   *  results than requested. If unspecified, returns 20 reports. The maximum
   *  value is 100.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token that specifies a page of results beyond the first page.
   *  Obtained through
   *  ListReportsResponse.next_page_token google.cloud.channel.v1.ListReportsResponse.next_page_token 
   *  of the previous
   *  CloudChannelReportsService.ListReports google.cloud.channel.v1.CloudChannelReportsService.ListReports 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The BCP-47 language code, such as "en-US".  If specified, the
   *  response is localized to the corresponding language code if the
   *  original data sources support it.
   *  Default is "en-US".
   */
  // const languageCode = 'abc123'

  // Imports the Channel library
  const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1;

  // Instantiates a client
  const channelClient = new CloudChannelReportsServiceClient();

  async function callListReports() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = channelClient.listReportsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListReports();

listReportsStream(request, options)

listReportsStream(request?: protos.google.cloud.channel.v1.IListReportsRequest, options?: CallOptions): Transform;

matchAccountFromBillingAccountName(billingAccountName)

matchAccountFromBillingAccountName(billingAccountName: string): string | number;

matchAccountFromChannelPartnerLinkName(channelPartnerLinkName)

matchAccountFromChannelPartnerLinkName(channelPartnerLinkName: string): string | number;

matchAccountFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName)

matchAccountFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName: string): string | number;

matchAccountFromCustomerName(customerName)

matchAccountFromCustomerName(customerName: string): string | number;

matchAccountFromCustomerRepricingConfigName(customerRepricingConfigName)

matchAccountFromCustomerRepricingConfigName(customerRepricingConfigName: string): string | number;

matchAccountFromEntitlementName(entitlementName)

matchAccountFromEntitlementName(entitlementName: string): string | number;

matchAccountFromOfferName(offerName)

matchAccountFromOfferName(offerName: string): string | number;

matchAccountFromReportJobName(reportJobName)

matchAccountFromReportJobName(reportJobName: string): string | number;

matchAccountFromReportName(reportName)

matchAccountFromReportName(reportName: string): string | number;

matchAccountFromSkuGroupName(skuGroupName)

matchAccountFromSkuGroupName(skuGroupName: string): string | number;

matchBillingAccountFromBillingAccountName(billingAccountName)

matchBillingAccountFromBillingAccountName(billingAccountName: string): string | number;

matchChannelPartnerFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName)

matchChannelPartnerFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName: string): string | number;

matchChannelPartnerLinkFromChannelPartnerLinkName(channelPartnerLinkName)

matchChannelPartnerLinkFromChannelPartnerLinkName(channelPartnerLinkName: string): string | number;

matchChannelPartnerRepricingConfigFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName)

matchChannelPartnerRepricingConfigFromChannelPartnerRepricingConfigName(channelPartnerRepricingConfigName: string): string | number;

matchCustomerFromCustomerName(customerName)

matchCustomerFromCustomerName(customerName: string): string | number;

matchCustomerFromCustomerRepricingConfigName(customerRepricingConfigName)

matchCustomerFromCustomerRepricingConfigName(customerRepricingConfigName: string): string | number;

matchCustomerFromEntitlementName(entitlementName)

matchCustomerFromEntitlementName(entitlementName: string): string | number;

matchCustomerRepricingConfigFromCustomerRepricingConfigName(customerRepricingConfigName)

matchCustomerRepricingConfigFromCustomerRepricingConfigName(customerRepricingConfigName: string): string | number;

matchEntitlementFromEntitlementName(entitlementName)

matchEntitlementFromEntitlementName(entitlementName: string): string | number;

matchOfferFromOfferName(offerName)

matchOfferFromOfferName(offerName: string): string | number;

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

matchProductFromSkuName(skuName)

matchProductFromSkuName(skuName: string): string | number;

matchReportFromReportName(reportName)

matchReportFromReportName(reportName: string): string | number;

matchReportJobFromReportJobName(reportJobName)

matchReportJobFromReportJobName(reportJobName: string): string | number;

matchSkuFromSkuName(skuName)

matchSkuFromSkuName(skuName: string): string | number;

matchSkuGroupFromSkuGroupName(skuGroupName)

matchSkuGroupFromSkuGroupName(skuGroupName: string): string | number;

offerPath(account, offer)

offerPath(account: string, offer: string): string;

productPath(product)

productPath(product: string): string;

reportJobPath(account, reportJob)

reportJobPath(account: string, reportJob: string): string;

reportPath(account, report)

reportPath(account: string, report: string): string;

runReportJob(request, options)

runReportJob(request?: protos.google.cloud.channel.v1.IRunReportJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.channel.v1.IRunReportJobResponse, protos.google.cloud.channel.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The report's resource name. Specifies the account and report used
   *  to generate report data. The report_id identifier is a UID (for example,
   *  `613bf59q`).
   *  Name uses the format:
   *  accounts/{account_id}/reports/{report_id}
   */
  // const name = 'abc123'
  /**
   *  Optional. The range of usage or invoice dates to include in the result.
   */
  // const dateRange = {}
  /**
   *  Optional. A structured string that defines conditions on dimension columns
   *  to restrict the report output.
   *  Filters support logical operators (AND, OR, NOT) and conditional operators
   *  (=, !=, <,>, <=, and="">=) using `column_id` as keys.
   *  For example:
   *  `(customer:"accounts/C123abc/customers/S456def" OR
   *  customer:"accounts/C123abc/customers/S789ghi") AND
   *  invoice_start_date.year >= 2022`
   */
  // const filter = 'abc123'
  /**
   *  Optional. The BCP-47 language code, such as "en-US".  If specified, the
   *  response is localized to the corresponding language code if the
   *  original data sources support it.
   *  Default is "en-US".
   */
  // const languageCode = 'abc123'

  // Imports the Channel library
  const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1;

  // Instantiates a client
  const channelClient = new CloudChannelReportsServiceClient();

  async function callRunReportJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await channelClient.runReportJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunReportJob();

runReportJob(request, options, callback)

runReportJob(request: protos.google.cloud.channel.v1.IRunReportJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.channel.v1.IRunReportJobResponse, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

runReportJob(request, callback)

runReportJob(request: protos.google.cloud.channel.v1.IRunReportJobRequest, callback: Callback<LROperation<protos.google.cloud.channel.v1.IRunReportJobResponse, protos.google.cloud.channel.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

skuGroupPath(account, skuGroup)

skuGroupPath(account: string, skuGroup: string): string;

skuPath(product, sku)

skuPath(product: string, sku: string): string;