{
  "basePath": "",
  "schemas": {
    "Contract": {
      "description": "Youtube Affiliate Program contract. Contains information about the commission rates applied to creators in the program.",
      "id": "Contract",
      "type": "object",
      "properties": {
        "name": {
          "description": "Identifier. The name of the `Contract` resource. Format: `accounts/{account}/contracts/{contract}`",
          "type": "string"
        },
        "defaultCommission": {
          "description": "Required. The default commission rate for the contract.",
          "$ref": "CommissionRate"
        }
      }
    },
    "CommissionRate": {
      "properties": {
        "ratedCommissionBasisPoints": {
          "type": "integer",
          "description": "Rated commission in basis points. For example: - 0.01% = 1 basis point. - 1% = 100 basis points. - 100% = 10000 basis points.",
          "format": "int32"
        }
      },
      "type": "object",
      "description": "Commission that will be paid for conversions that match a given commission group.",
      "id": "CommissionRate"
    },
    "CommissionGroup": {
      "description": "YouTube Affiliate Program commission group. A commission group defines a commission rate and the set of products it applies to.",
      "id": "CommissionGroup",
      "properties": {
        "productSelector": {
          "$ref": "ProductSelector",
          "description": "Required. Selects the products that this commission group applies to."
        },
        "commissionRate": {
          "description": "Required. Commission that will be paid for conversions that match this commission group.",
          "$ref": "CommissionRate"
        },
        "name": {
          "description": "Identifier. The name of the `CommissionGroup` resource. Format: `accounts/{account}/contracts/{contract}/commissionGroups/{commission_group}`",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ListCommissionGroupsResponse": {
      "description": "Response message for the `ListCommissionGroups` method.",
      "type": "object",
      "properties": {
        "commissionGroups": {
          "items": {
            "$ref": "CommissionGroup"
          },
          "type": "array",
          "description": "The commission groups for the specified contract."
        },
        "nextPageToken": {
          "type": "string",
          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages."
        }
      },
      "id": "ListCommissionGroupsResponse"
    },
    "ProductStatusChangeMessage": {
      "properties": {
        "resourceId": {
          "type": "string",
          "description": "The product id."
        },
        "resource": {
          "description": "The product name. Format: `accounts/{account}/products/{product}`",
          "type": "string"
        },
        "expirationTime": {
          "type": "string",
          "description": "Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.",
          "format": "google-datetime"
        },
        "changes": {
          "items": {
            "$ref": "ProductChange"
          },
          "type": "array",
          "description": "A message to describe the change that happened to the product"
        },
        "managingAccount": {
          "type": "string",
          "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`"
        },
        "attribute": {
          "description": "The attribute in the resource that changed, in this case it will be always `Status`.",
          "enum": [
            "ATTRIBUTE_UNSPECIFIED",
            "STATUS"
          ],
          "enumDescriptions": [
            "Unspecified attribute",
            "Status of the changed entity"
          ],
          "type": "string"
        },
        "eventTime": {
          "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.",
          "format": "google-datetime",
          "type": "string"
        },
        "account": {
          "description": "The target account that owns the entity that changed. Format : `accounts/{merchant_id}`",
          "type": "string"
        },
        "resourceType": {
          "type": "string",
          "enum": [
            "RESOURCE_UNSPECIFIED",
            "PRODUCT",
            "ACCOUNT_SERVICE"
          ],
          "description": "The resource that changed, in this case it will always be `Product`.",
          "enumDescriptions": [
            "Unspecified resource",
            "Resource type : product",
            "Account service"
          ]
        }
      },
      "type": "object",
      "id": "ProductStatusChangeMessage",
      "description": "The message that the merchant will receive to notify about product status change event"
    },
    "ListContractsResponse": {
      "description": "Response message for the `ListContracts` method.",
      "id": "ListContractsResponse",
      "properties": {
        "contracts": {
          "type": "array",
          "description": "The contracts for the specified account.",
          "items": {
            "$ref": "Contract"
          }
        },
        "nextPageToken": {
          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "CategorySelector": {
      "properties": {
        "categories": {
          "type": "array",
          "description": "Required. The list of categories targeted by this selector. A maximum of 100 is allowed.",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "Category selector.",
      "type": "object",
      "id": "CategorySelector"
    },
    "Empty": {
      "properties": {},
      "id": "Empty",
      "type": "object",
      "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }"
    },
    "ProductSelector": {
      "properties": {
        "categorySelector": {
          "description": "Optional. Selects products by category.",
          "$ref": "CategorySelector"
        }
      },
      "description": "Selects which products a commission group applies to. At least one of the selectors must be set. Multiple selectors may be set, though note combining a SkuSelector together with another selector type is not very meaningful as the SkuSelector can already be used to select the exact set of products.",
      "type": "object",
      "id": "ProductSelector"
    },
    "ProductChange": {
      "properties": {
        "regionCode": {
          "type": "string",
          "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format."
        },
        "newValue": {
          "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)",
          "type": "string"
        },
        "reportingContext": {
          "type": "string",
          "enumDescriptions": [
            "Not specified.",
            "[Shopping ads](https://support.google.com/merchants/answer/6149970).",
            "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).",
            "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).",
            "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).",
            "[Video ads](https://support.google.com/google-ads/answer/6340491).",
            "[Display ads](https://support.google.com/merchants/answer/6069387).",
            "[Local inventory ads](https://support.google.com/merchants/answer/3271956).",
            "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).",
            "[Free product listings](https://support.google.com/merchants/answer/9199328).",
            "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).",
            "[Free local product listings](https://support.google.com/merchants/answer/9825611).",
            "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).",
            "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).",
            "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).",
            "[Cloud retail](https://cloud.google.com/solutions/retail).",
            "[Local cloud retail](https://cloud.google.com/solutions/retail).",
            "[Product Reviews](https://support.google.com/merchants/answer/14620732).",
            "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).",
            "YouTube Checkout .",
            "Real Estate Rental Ads. ."
          ],
          "enum": [
            "REPORTING_CONTEXT_ENUM_UNSPECIFIED",
            "SHOPPING_ADS",
            "DISCOVERY_ADS",
            "DEMAND_GEN_ADS",
            "DEMAND_GEN_ADS_DISCOVER_SURFACE",
            "VIDEO_ADS",
            "DISPLAY_ADS",
            "LOCAL_INVENTORY_ADS",
            "VEHICLE_INVENTORY_ADS",
            "FREE_LISTINGS",
            "FREE_LISTINGS_UCP_CHECKOUT",
            "FREE_LOCAL_LISTINGS",
            "FREE_LOCAL_VEHICLE_LISTINGS",
            "YOUTUBE_AFFILIATE",
            "YOUTUBE_SHOPPING",
            "CLOUD_RETAIL",
            "LOCAL_CLOUD_RETAIL",
            "PRODUCT_REVIEWS",
            "MERCHANT_REVIEWS",
            "YOUTUBE_CHECKOUT",
            "RENTAL_ADS"
          ],
          "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)",
          "enumDeprecated": [
            false,
            false,
            true,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false
          ]
        },
        "oldValue": {
          "type": "string",
          "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)"
        }
      },
      "type": "object",
      "id": "ProductChange",
      "description": "The change that happened to the product including old value, new value, country code as the region code and reporting context."
    }
  },
  "ownerName": "Google",
  "resources": {
    "accounts": {
      "resources": {
        "contracts": {
          "resources": {
            "commissionGroups": {
              "methods": {
                "create": {
                  "id": "merchantapi.accounts.contracts.commissionGroups.create",
                  "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts/{contractsId}/commissionGroups",
                  "description": "Creates a new commission group.",
                  "scopes": [
                    "https://www.googleapis.com/auth/content"
                  ],
                  "path": "youtube/v1alpha/{+parent}/commissionGroups",
                  "parameterOrder": [
                    "parent"
                  ],
                  "parameters": {
                    "parent": {
                      "pattern": "^accounts/[^/]+/contracts/[^/]+$",
                      "description": "Required. The parent contract where this commission group will be created. Format: `accounts/{account}/contracts/{contract}`",
                      "type": "string",
                      "location": "path",
                      "required": true
                    }
                  },
                  "request": {
                    "$ref": "CommissionGroup"
                  },
                  "response": {
                    "$ref": "CommissionGroup"
                  },
                  "httpMethod": "POST"
                },
                "delete": {
                  "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts/{contractsId}/commissionGroups/{commissionGroupsId}",
                  "parameters": {
                    "name": {
                      "required": true,
                      "pattern": "^accounts/[^/]+/contracts/[^/]+/commissionGroups/[^/]+$",
                      "type": "string",
                      "description": "Required. The name of the commission group to delete. Format: `accounts/{account}/contracts/{contract}/commissionGroups/{commission_group}`",
                      "location": "path"
                    }
                  },
                  "httpMethod": "DELETE",
                  "id": "merchantapi.accounts.contracts.commissionGroups.delete",
                  "scopes": [
                    "https://www.googleapis.com/auth/content"
                  ],
                  "parameterOrder": [
                    "name"
                  ],
                  "response": {
                    "$ref": "Empty"
                  },
                  "path": "youtube/v1alpha/{+name}",
                  "description": "Deletes a given commission group."
                },
                "get": {
                  "id": "merchantapi.accounts.contracts.commissionGroups.get",
                  "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts/{contractsId}/commissionGroups/{commissionGroupsId}",
                  "httpMethod": "GET",
                  "parameters": {
                    "name": {
                      "pattern": "^accounts/[^/]+/contracts/[^/]+/commissionGroups/[^/]+$",
                      "description": "Required. The name of the commission group to retrieve. Format: `accounts/{account}/contracts/{contract}/commissionGroups/{commission_group}`",
                      "location": "path",
                      "type": "string",
                      "required": true
                    }
                  },
                  "parameterOrder": [
                    "name"
                  ],
                  "response": {
                    "$ref": "CommissionGroup"
                  },
                  "path": "youtube/v1alpha/{+name}",
                  "description": "Retrieves the specified commission group.",
                  "scopes": [
                    "https://www.googleapis.com/auth/content"
                  ]
                },
                "list": {
                  "scopes": [
                    "https://www.googleapis.com/auth/content"
                  ],
                  "response": {
                    "$ref": "ListCommissionGroupsResponse"
                  },
                  "id": "merchantapi.accounts.contracts.commissionGroups.list",
                  "parameters": {
                    "pageSize": {
                      "format": "int32",
                      "type": "integer",
                      "description": "Optional. The maximum number of commission groups to return. The service may return fewer than this value. If unspecified, at most 100 commission groups will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
                      "location": "query"
                    },
                    "parent": {
                      "location": "path",
                      "type": "string",
                      "required": true,
                      "pattern": "^accounts/[^/]+/contracts/[^/]+$",
                      "description": "Required. The contract to list commission groups for. Format: `accounts/{account}/contracts/{contract}`"
                    },
                    "pageToken": {
                      "type": "string",
                      "location": "query",
                      "description": "Optional. A page token, received from a previous `ListCommissionGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCommissionGroups` must match the call that provided the page token."
                    }
                  },
                  "path": "youtube/v1alpha/{+parent}/commissionGroups",
                  "httpMethod": "GET",
                  "parameterOrder": [
                    "parent"
                  ],
                  "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts/{contractsId}/commissionGroups",
                  "description": "Lists the commission groups for a given contract."
                },
                "patch": {
                  "path": "youtube/v1alpha/{+name}",
                  "request": {
                    "$ref": "CommissionGroup"
                  },
                  "response": {
                    "$ref": "CommissionGroup"
                  },
                  "description": "Updates a given commission group.",
                  "parameters": {
                    "updateMask": {
                      "type": "string",
                      "location": "query",
                      "format": "google-fieldmask",
                      "description": "Required. The list of fields to update. Fields specified in the update mask without a value specified in the body will be deleted from the commission group. If update mask is set to `*`, all fields will be updated."
                    },
                    "name": {
                      "pattern": "^accounts/[^/]+/contracts/[^/]+/commissionGroups/[^/]+$",
                      "location": "path",
                      "type": "string",
                      "required": true,
                      "description": "Identifier. The name of the `CommissionGroup` resource. Format: `accounts/{account}/contracts/{contract}/commissionGroups/{commission_group}`"
                    }
                  },
                  "id": "merchantapi.accounts.contracts.commissionGroups.patch",
                  "httpMethod": "PATCH",
                  "scopes": [
                    "https://www.googleapis.com/auth/content"
                  ],
                  "parameterOrder": [
                    "name"
                  ],
                  "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts/{contractsId}/commissionGroups/{commissionGroupsId}"
                }
              }
            }
          },
          "methods": {
            "get": {
              "parameters": {
                "name": {
                  "location": "path",
                  "required": true,
                  "description": "Required. The name of the contract to retrieve. Format: `accounts/{account}/contracts/{contract}`",
                  "pattern": "^accounts/[^/]+/contracts/[^/]+$",
                  "type": "string"
                }
              },
              "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts/{contractsId}",
              "httpMethod": "GET",
              "parameterOrder": [
                "name"
              ],
              "description": "Retrieves the specified contract.",
              "path": "youtube/v1alpha/{+name}",
              "scopes": [
                "https://www.googleapis.com/auth/content"
              ],
              "id": "merchantapi.accounts.contracts.get",
              "response": {
                "$ref": "Contract"
              }
            },
            "create": {
              "parameters": {
                "parent": {
                  "pattern": "^accounts/[^/]+$",
                  "description": "Required. The parent account where this contract will be created. Format: `accounts/{account}`",
                  "type": "string",
                  "location": "path",
                  "required": true
                }
              },
              "httpMethod": "POST",
              "parameterOrder": [
                "parent"
              ],
              "description": "Creates a new contract.",
              "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts",
              "path": "youtube/v1alpha/{+parent}/contracts",
              "id": "merchantapi.accounts.contracts.create",
              "scopes": [
                "https://www.googleapis.com/auth/content"
              ],
              "request": {
                "$ref": "Contract"
              },
              "response": {
                "$ref": "Contract"
              }
            },
            "list": {
              "description": "Lists the contracts for a given account.",
              "response": {
                "$ref": "ListContractsResponse"
              },
              "scopes": [
                "https://www.googleapis.com/auth/content"
              ],
              "path": "youtube/v1alpha/{+parent}/contracts",
              "id": "merchantapi.accounts.contracts.list",
              "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts",
              "parameters": {
                "pageSize": {
                  "location": "query",
                  "type": "integer",
                  "description": "Optional. The maximum number of contracts to return. The service may return fewer than this value. If unspecified, at most 100 contracts will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
                  "format": "int32"
                },
                "parent": {
                  "pattern": "^accounts/[^/]+$",
                  "description": "Required. The account to list contracts for. Format: `accounts/{account}`",
                  "location": "path",
                  "required": true,
                  "type": "string"
                },
                "pageToken": {
                  "location": "query",
                  "description": "Optional. A page token, received from a previous `ListContracts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListContracts` must match the call that provided the page token.",
                  "type": "string"
                }
              },
              "httpMethod": "GET",
              "parameterOrder": [
                "parent"
              ]
            },
            "patch": {
              "flatPath": "youtube/v1alpha/accounts/{accountsId}/contracts/{contractsId}",
              "description": "Updates a given contract.",
              "scopes": [
                "https://www.googleapis.com/auth/content"
              ],
              "parameterOrder": [
                "name"
              ],
              "httpMethod": "PATCH",
              "response": {
                "$ref": "Contract"
              },
              "parameters": {
                "name": {
                  "pattern": "^accounts/[^/]+/contracts/[^/]+$",
                  "location": "path",
                  "type": "string",
                  "description": "Identifier. The name of the `Contract` resource. Format: `accounts/{account}/contracts/{contract}`",
                  "required": true
                },
                "updateMask": {
                  "type": "string",
                  "location": "query",
                  "format": "google-fieldmask",
                  "description": "Required. The list of fields to update. Fields specified in the update mask without a value specified in the body will be deleted from the contract. If update mask is set to `*`, all fields will be updated."
                }
              },
              "request": {
                "$ref": "Contract"
              },
              "id": "merchantapi.accounts.contracts.patch",
              "path": "youtube/v1alpha/{+name}"
            }
          }
        }
      }
    }
  },
  "servicePath": "",
  "ownerDomain": "google.com",
  "version_module": true,
  "protocol": "rest",
  "name": "merchantapi",
  "id": "merchantapi:youtube_v1alpha",
  "version": "youtube_v1alpha",
  "canonicalName": "Merchant",
  "title": "Merchant API",
  "discoveryVersion": "v1",
  "batchPath": "batch",
  "revision": "20261106",
  "rootUrl": "https://merchantapi.googleapis.com/",
  "kind": "discovery#restDescription",
  "auth": {
    "oauth2": {
      "scopes": {
        "https://www.googleapis.com/auth/content": {
          "description": "Manage your product listings and accounts for Google Shopping"
        }
      }
    }
  },
  "icons": {
    "x16": "http://www.google.com/images/icons/product/search-16.gif",
    "x32": "http://www.google.com/images/icons/product/search-32.gif"
  },
  "description": "Programmatically manage your Merchant Center Accounts.",
  "fullyEncodeReservedExpansion": true,
  "parameters": {
    "callback": {
      "location": "query",
      "description": "JSONP",
      "type": "string"
    },
    "access_token": {
      "type": "string",
      "description": "OAuth access token.",
      "location": "query"
    },
    "oauth_token": {
      "description": "OAuth 2.0 token for the current user.",
      "location": "query",
      "type": "string"
    },
    "upload_protocol": {
      "location": "query",
      "type": "string",
      "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
    },
    "fields": {
      "location": "query",
      "type": "string",
      "description": "Selector specifying which fields to include in a partial response."
    },
    "quotaUser": {
      "type": "string",
      "location": "query",
      "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
    },
    "prettyPrint": {
      "location": "query",
      "type": "boolean",
      "default": "true",
      "description": "Returns response with indentations and line breaks."
    },
    "alt": {
      "description": "Data format for response.",
      "location": "query",
      "default": "json",
      "enum": [
        "json",
        "media",
        "proto"
      ],
      "type": "string",
      "enumDescriptions": [
        "Responses with Content-Type of application/json",
        "Media download with context-dependent Content-Type",
        "Responses with Content-Type of application/x-protobuf"
      ]
    },
    "$.xgafv": {
      "enum": [
        "1",
        "2"
      ],
      "description": "V1 error format.",
      "type": "string",
      "enumDescriptions": [
        "v1 error format",
        "v2 error format"
      ],
      "location": "query"
    },
    "uploadType": {
      "location": "query",
      "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
      "type": "string"
    },
    "key": {
      "type": "string",
      "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
      "location": "query"
    }
  },
  "documentationLink": "https://developers.google.com/merchant/api",
  "mtlsRootUrl": "https://merchantapi.mtls.googleapis.com/",
  "baseUrl": "https://merchantapi.googleapis.com/"
}